|
Interaction SDK (Web Services) |
||||||||
PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT |
Attribute Summary | |
com.genesyslab.ail.ws.outbound.CampaignAction[] |
outbound.campaign:actionsPossible The possible actions. |
String |
outbound.campaign:campaignId The campaign identifier. |
String |
outbound.campaign:description The description of this campaign. |
com.genesyslab.ail.ws.outbound.CampaignEventType |
outbound.campaign:eventType The current event type of this campaign. |
com.genesyslab.ail.ws.outbound.CampaignMode |
outbound.campaign:mode The current mode of this campaign. |
String |
outbound.campaign:name The name of this campaign. |
com.genesyslab.ail.ws.outbound.CampaignStatus |
outbound.campaign:status The current state of this campaign. |
String |
outbound.chain:activeRecordId The active record of the chain. |
com.genesyslab.ail.ws.outbound.CampaignMode |
outbound.chain:campaignMode The campaign mode related to this outbound chain. Note: Received only upon subscription to outbound event. |
com.genesyslab.ail.ws.outbound.OutboundEventType |
outbound.chain:eventType The type of the event. Note: Received only upon subscription to outbound interaction event. |
String[] |
outbound.chain:interactionIds The interaction identifiers related to this chain. |
boolean |
outbound.chain:isScheduled true if this interaction was created when executing a callback. |
String |
outbound.chain:outboundChainId The interaction identifier. Note: Received only upon subscription to outbound interaction event. |
com.genesyslab.ail.ws.outbound.OutboundChainReason |
outbound.chain:reason The reason. Note: Received only upon subscription to outbound event. |
String[] |
outbound.chain:recordIds The list of outbound record identifiers in this chain. The number of records can change during the life cycle of the interaction. The interaction has one record upon the initialization ('initial record'), and at least one record after calling requestChainedRecords. |
com.genesyslab.ail.ws.outbound.TreatmentType |
outbound.chain:treatmentType The treatment data currently associated with this interaction. |
com.genesyslab.ail.ws.outbound.OutboundRecordAction[] |
outbound.record:actionsPossible The possible actions. |
String |
outbound.record:callingListName The name of the current calling list. |
com.genesyslab.ail.ws.outbound.OutboundCallResult |
outbound.record:callResult The outbound record CallResult constant that corresponds to the result of this call. |
String |
outbound.record:campaignId The campaign that handles this record. |
String |
outbound.record:contactMediaType The contact media type. |
com.genesyslab.ail.ws.KeyValue[] |
outbound.record:customFields The custom fields for this record. |
int |
outbound.record:dailyFrom The beginning of the time frame when this record can be called, in seconds from midnight. |
int |
outbound.record:dailyTill The end of the time frame when this record can be called, in seconds from midnight. |
String |
outbound.record:outboundChainId The OutboundChain this record belongs to or null. Sent only with ExtendedOutboundService. |
String |
outbound.record:phone The phone number for this record. |
com.genesyslab.ail.ws.outbound.OutboundRecordPhoneType |
outbound.record:phoneType The phone type for this record. |
String |
outbound.record:recordHandle An integer used as an ID (handle) for this record. |
String |
outbound.record:recordId The record identifier. |
com.genesyslab.ail.ws.outbound.OutboundRecordStatus |
outbound.record:status The current status of this record within its interaction. |
String |
outbound.record:timezone The time zone ID or null if not available. |
int |
outbound.record:timeZoneOffset The timezone offset from GMT, in hours. Deprecated in write mode, use timezone instead. |
Method Summary | |
void |
addNewRecordToCampaign Adds a new record to this campaign based on an existing one. The new record will be the beginning of a new chain (it will not be linked to an existing entry) and will have the new phone number that has been assigned by the phoneNumber
parameter. In order to use this method, the Agent should have an outbound record retrieved on his or her desktop and a Campaign
should be loaded or running. If the Campaign has multiple calling lists, the record will be added to the appropriate calling
list based on the normal AIL behavior.
|
void |
addNewRecordToChain Adds a new record at the end of the chained records currently handled by this interaction. |
void |
cancelChain Cancels this chain's active record. An agent may decide, because of history or record data, that this contact (and all its chained records) does not need any call. The record is no longer handled in the current campaign. Note: This method does not modify the interaction (if any) associated with the records of this chain. |
void |
cancelRecord Determines that this record (and only this one) does not need any call, due to its history or record data. This record will no longer be handled by the current campaign. |
void |
cancelRecordByPhoneNumber Cancels an outbound record. Used when an agent updates data of a contact outside of the processing of a campaign (during an inbound call, for example) and decides that there is no need to call this customer again. |
void |
closeChain Closes this outbound chain. |
String |
createInteraction Creates an interaction to process the given outbound chain. |
String |
createInteractionOpenMedia Creates a new open media interaction to process the outbound chain. |
void |
doNotCallChain Prevents the current record (and all its chained records) from being dialed by any campaign, because of (for instance) the contacts request. Note: This method does not modify the interaction (if any) associated with the records of this chain. |
void |
doNotCallRecord Prevents this record (and only this one) from being dialed by any campaign, because of (for instance) the contacts request. |
void |
doNotCallRecordByPhoneNumber Marks the record (and chained records if all_chain is true) as Do Not Call. This method should be used when an agent updates data of a contact outside of the processing of a campaign (during an inbound call, for example) and is asked by this customer not to be called again. |
com.genesyslab.ail.ws.outbound.CampaignDTO[] |
getCampaignsDTO Retrieves all the requested attributes on all the specified campaigns. |
com.genesyslab.ail.ws.outbound.OutboundChainDTO |
getOutboundChainDTO Returns the requested attributes of an outbound chain according to its outbound chain ID. |
com.genesyslab.ail.ws.outbound.OutboundChainDTO |
getOutboundChainFromInteractionDTO Returns the requested attributes of the outbound chain associated with the given interaction ID. |
com.genesyslab.ail.ws.outbound.OutboundChainDTO[] |
getOutboundChainFromPlaceDTO Returns the requested attributes of an outbound chain. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO |
getPreviewRecordDTO Requests the sending of a new interaction and gets the associated outbound record data, if a record is available in this campaign. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[] |
getRecordsDTO Returns the requested attributes of the specified records. |
boolean |
isASMCall Returns true if the interaction is in ASM call mode. |
boolean |
isLogoutAcknowledged Returns true if requestLogout() was acknowledged by the Outbound Server. |
void |
markChainProcessed Marks this chain's active record as processed in OCS. Note: This method does not modify the interaction (if any) associated with the records of this chain. |
void |
rejectChain Rejects this chain's active record. The active record will not be dialed by this agent. The system should then resend the chain to another agent. Note: This method does not modify the interaction (if any) associated with the records of this chain. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[] |
requestChainedRecordsDTO Requests alternative data to call the contact. You can call this method when the active record number could not be dialed, or to retrieve records newly added to this chain. |
int |
requestLogout Requests to log out the agent from this campaign. A LOGOUT_ACKNOWLEDGE CampaignEvent is sent if the logout is taken into account. |
void |
rescheduleRecord Reschedules a call for later. Deprecated uses rescheduleRecordUTC instead. |
void |
rescheduleRecordUTC Reschedules a call for later. |
com.genesyslab.ail.ws.AttributeError[] |
setOutboundChainDTO Sets the attributes of an outbound chain. |
com.genesyslab.ail.ws.outbound.OutboundRecordError |
setRecordDTO Sets the attributes of a record. |
void |
startPreviewMode Sets this agent as ready to work in preview campaign mode. |
void |
stopPreviewMode Sets this agent as this agent as not ready to work in a preview campaign mode. |
void |
updateRecord Updates the record in the OCS, using its fields current values. |
Event Summary | |
CampaignOutboundEvent Outbound campaign event. |
|
OutboundChainEvent Outbound chain event. |
Attribute Detail |
Attributes of domain outbound.campaign |
Type: com.genesyslab.ail.ws.outbound.CampaignAction[]
Type: String
Type: String
Type: com.genesyslab.ail.ws.outbound.CampaignEventType
Type: com.genesyslab.ail.ws.outbound.CampaignMode
Type: String
Type: com.genesyslab.ail.ws.outbound.CampaignStatus
Attributes of domain outbound.chain |
Type: String
Type: com.genesyslab.ail.ws.outbound.CampaignMode
Type: com.genesyslab.ail.ws.outbound.OutboundEventType
Type: String[]
Type: boolean
Type: String
Type: com.genesyslab.ail.ws.outbound.OutboundChainReason
Type: String[]
Type: com.genesyslab.ail.ws.outbound.TreatmentType
Attributes of domain outbound.record |
Type: com.genesyslab.ail.ws.outbound.OutboundRecordAction[]
Type: String
Type: com.genesyslab.ail.ws.outbound.OutboundCallResult
Type: String
Type: String
Type: com.genesyslab.ail.ws.KeyValue[]
Type: int
Type: int
Type: String
Type: String
Type: com.genesyslab.ail.ws.outbound.OutboundRecordPhoneType
Type: String
Type: String
Type: com.genesyslab.ail.ws.outbound.OutboundRecordStatus
Type: String
Type: int
Method Detail |
phoneNumber
parameter. In order to use this method, the Agent should have an outbound record retrieved on his or her desktop and a Campaign
should be loaded or running. If the Campaign has multiple calling lists, the record will be added to the appropriate calling
list based on the normal AIL behavior.
String
String
String
String
String
com.genesyslab.ail.ws.KeyValue[]
void
String
String
String
String
com.genesyslab.ail.ws.KeyValue[]
void
String
String
void
String
String
String
void
String
String
boolean
void
String
String
void
String
String
com.genesyslab.ail.ws.place.MediaType
String
String
String
String
String
String
String
String
String
String
com.genesyslab.ail.ws.KeyValue[]
String
String
String
String
void
String
String
String
String
void
String
String
String
boolean
void
String
String[]
String[]
com.genesyslab.ail.ws.outbound.CampaignDTO[]
String
String
String[]
com.genesyslab.ail.ws.outbound.OutboundChainDTO
String
String
String[]
com.genesyslab.ail.ws.outbound.OutboundChainDTO
String
String[]
com.genesyslab.ail.ws.outbound.OutboundChainDTO[]
String
String
String[]
com.genesyslab.ail.ws.outbound.OutboundRecordDTO
String
String
String[]
String[]
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]
String
String
boolean
String
String
boolean
String
String
void
String
String
void
String
String
String[]
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]
String
String
int
String
String
String
long
com.genesyslab.ail.ws.outbound.CallbackType
void
String
String
String
long
com.genesyslab.ail.ws.outbound.CallbackType
void
String
String
com.genesyslab.ail.ws.KeyValue[]
com.genesyslab.ail.ws.AttributeError[]
String
String
com.genesyslab.ail.ws.outbound.OutboundRecordDTO
com.genesyslab.ail.ws.outbound.OutboundRecordError
String
String
void
String
String
void
String
String
String
void
Event Detail |
|
Interaction SDK (Web Services) |
||||||||
PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT |