|
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:actionsPossibleThe possible actions. |
String |
outbound.campaign:campaignIdThe campaign identifier. |
String |
outbound.campaign:descriptionThe description of this campaign. |
com.genesyslab.ail.ws.outbound.CampaignEventType |
outbound.campaign:eventTypeThe current event type of this campaign. |
com.genesyslab.ail.ws.outbound.CampaignMode |
outbound.campaign:modeThe current mode of this campaign. |
String |
outbound.campaign:nameThe name of this campaign. |
com.genesyslab.ail.ws.outbound.CampaignStatus |
outbound.campaign:statusThe current state of this campaign. |
String |
outbound.chain:activeRecordIdThe active record of the chain. |
com.genesyslab.ail.ws.outbound.CampaignMode |
outbound.chain:campaignModeThe campaign mode related to this outbound chain. Note: Received only upon subscription to outbound event. |
com.genesyslab.ail.ws.outbound.OutboundEventType |
outbound.chain:eventTypeThe type of the event. Note: Received only upon subscription to outbound interaction event. |
String[] |
outbound.chain:interactionIdsThe interaction identifiers related to this chain. |
boolean |
outbound.chain:isScheduledtrue if this interaction was created when executing a callback. |
String |
outbound.chain:outboundChainIdThe interaction identifier. Note: Received only upon subscription to outbound interaction event. |
com.genesyslab.ail.ws.outbound.OutboundChainReason |
outbound.chain:reasonThe reason. Note: Received only upon subscription to outbound event. |
String[] |
outbound.chain:recordIdsThe 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:treatmentTypeThe treatment data currently associated with this interaction. |
com.genesyslab.ail.ws.outbound.OutboundRecordAction[] |
outbound.record:actionsPossibleThe possible actions. |
String |
outbound.record:callingListNameThe name of the current calling list. |
com.genesyslab.ail.ws.outbound.OutboundCallResult |
outbound.record:callResultThe outbound record CallResult constant that corresponds to the result of this call. |
String |
outbound.record:campaignIdThe campaign that handles this record. |
String |
outbound.record:contactMediaTypeThe contact media type. |
com.genesyslab.ail.ws.KeyValue[] |
outbound.record:customFieldsThe custom fields for this record. |
int |
outbound.record:dailyFromThe beginning of the time frame when this record can be called, in seconds from midnight. |
int |
outbound.record:dailyTillThe end of the time frame when this record can be called, in seconds from midnight. |
String |
outbound.record:outboundChainIdThe OutboundChain this record belongs to or null. Sent only with ExtendedOutboundService. |
String |
outbound.record:phoneThe phone number for this record. |
com.genesyslab.ail.ws.outbound.OutboundRecordPhoneType |
outbound.record:phoneTypeThe phone type for this record. |
String |
outbound.record:recordHandleAn integer used as an ID (handle) for this record. |
String |
outbound.record:recordIdThe record identifier. |
com.genesyslab.ail.ws.outbound.OutboundRecordStatus |
outbound.record:statusThe current status of this record within its interaction. |
String |
outbound.record:timezoneThe time zone ID or null if not available. |
int |
outbound.record:timeZoneOffsetThe timezone offset from GMT, in hours. Deprecated in write mode, use timezone instead. |
| Method Summary | |
void |
addNewRecordToCampaignAdds 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 |
addNewRecordToChainAdds a new record at the end of the chained records currently handled by this interaction. |
void |
cancelChainCancels 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 |
cancelRecordDetermines 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 |
cancelRecordByPhoneNumberCancels 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 |
closeChainCloses this outbound chain. |
String |
createInteractionCreates an interaction to process the given outbound chain. |
String |
createInteractionOpenMediaCreates a new open media interaction to process the outbound chain. |
void |
doNotCallChainPrevents 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 |
doNotCallRecordPrevents this record (and only this one) from being dialed by any campaign, because of (for instance) the contacts request. |
void |
doNotCallRecordByPhoneNumberMarks 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[] |
getCampaignsDTORetrieves all the requested attributes on all the specified campaigns. |
com.genesyslab.ail.ws.outbound.OutboundChainDTO |
getOutboundChainDTOReturns the requested attributes of an outbound chain according to its outbound chain ID. |
com.genesyslab.ail.ws.outbound.OutboundChainDTO |
getOutboundChainFromInteractionDTOReturns the requested attributes of the outbound chain associated with the given interaction ID. |
com.genesyslab.ail.ws.outbound.OutboundChainDTO[] |
getOutboundChainFromPlaceDTOReturns the requested attributes of an outbound chain. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO |
getPreviewRecordDTORequests 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[] |
getRecordsDTOReturns the requested attributes of the specified records. |
boolean |
isASMCallReturns true if the interaction is in ASM call mode. |
boolean |
isLogoutAcknowledgedReturns true if requestLogout() was acknowledged by the Outbound Server. |
void |
markChainProcessedMarks 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 |
rejectChainRejects 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[] |
requestChainedRecordsDTORequests 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 |
requestLogoutRequests to log out the agent from this campaign. A LOGOUT_ACKNOWLEDGE CampaignEvent is sent if the logout is taken into account. |
void |
rescheduleRecordReschedules a call for later. Deprecated uses rescheduleRecordUTC instead. |
void |
rescheduleRecordUTCReschedules a call for later. |
com.genesyslab.ail.ws.AttributeError[] |
setOutboundChainDTOSets the attributes of an outbound chain. |
com.genesyslab.ail.ws.outbound.OutboundRecordError |
setRecordDTOSets the attributes of a record. |
void |
startPreviewModeSets this agent as ready to work in preview campaign mode. |
void |
stopPreviewModeSets this agent as this agent as not ready to work in a preview campaign mode. |
void |
updateRecordUpdates the record in the OCS, using its fields current values. |
| Event Summary | |
CampaignOutboundEventOutbound campaign event. |
|
OutboundChainEventOutbound 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.
StringStringStringStringStringcom.genesyslab.ail.ws.KeyValue[]voidStringStringStringStringcom.genesyslab.ail.ws.KeyValue[]voidStringStringvoidStringStringStringvoidStringStringbooleanvoidStringStringvoidStringStringcom.genesyslab.ail.ws.place.MediaTypeStringStringStringStringStringStringStringStringStringStringcom.genesyslab.ail.ws.KeyValue[]StringStringStringStringvoidStringStringStringStringvoidStringStringStringbooleanvoidStringString[]String[]com.genesyslab.ail.ws.outbound.CampaignDTO[]StringStringString[]com.genesyslab.ail.ws.outbound.OutboundChainDTOStringStringString[]com.genesyslab.ail.ws.outbound.OutboundChainDTOStringString[]com.genesyslab.ail.ws.outbound.OutboundChainDTO[]StringStringString[]com.genesyslab.ail.ws.outbound.OutboundRecordDTOStringStringString[]String[]com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]StringStringbooleanStringStringbooleanStringStringvoidStringStringvoidStringStringString[]com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]StringStringintStringStringStringlongcom.genesyslab.ail.ws.outbound.CallbackTypevoidStringStringStringlongcom.genesyslab.ail.ws.outbound.CallbackTypevoidStringStringcom.genesyslab.ail.ws.KeyValue[]com.genesyslab.ail.ws.AttributeError[]StringStringcom.genesyslab.ail.ws.outbound.OutboundRecordDTOcom.genesyslab.ail.ws.outbound.OutboundRecordErrorStringStringvoidStringStringvoidStringStringStringvoid| Event Detail |
|
Interaction SDK (Web Services) |
||||||||
| PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
| SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT | ||||||||