|
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.OutboundInteractionAction[] |
interaction.voice.outbound:actionsPossibleThe possible actions. |
String |
interaction.voice.outbound:activeRecordIdThe record that is marked as the active one within the list. |
com.genesyslab.ail.ws.outbound.OutboundEventType |
interaction.voice.outbound:eventTypeThe type of the event. Note: Received only upon subscription to outbound interaction event. |
String |
interaction.voice.outbound:interactionIdThe interaction identifier. Note: Received only upon subscription to outbound interaction event. |
boolean |
interaction.voice.outbound:isScheduledtrue if this interaction was created when executing a callback. |
com.genesyslab.ail.ws.outbound.OutboundStatus |
interaction.voice.outbound:outboundStatusThe record handling status, which shows whether this interaction is still able to handle outbound related data (update, cancel, mark procesed...). |
String[] |
interaction.voice.outbound:recordIdsThe list of outbound record identifiers attached to this interaction. 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 |
interaction.voice.outbound:treatmentTypeThe treatment data currently associated with this interaction. |
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. |
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. This new record will be the beginning of a new chain. |
void |
addNewRecordToChainAdds a new record at the end of the chained records currently handled by this interaction. |
void |
cancelCancels this outbound 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 will no longer be handled by the current campaign. This action ends record processing in this interaction. |
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 a contacts data outside of campaign processing (during an inbound call, for example), and decides that there is no need to call this customer again. |
void |
doNotCallPrevents the current record (and all its chained records) from being dialed by any campaign, because of (for instance) the contacts request. This action ends record processing in this interaction. |
void |
doNotCallRecordPrevents this record (and only this one) from being dialed by any campaign, because of (for instance) the contacts request. |
void |
doNotCallRecordByPhoneNumberWhen an agent updates data of a contact out of campaign processing (during an inbound call, for example) and is asked by this customer not to be called again. If an agent of the campaign group is currently handling a record of this contact, that agent receives a cancel contact event. |
com.genesyslab.ail.ws.outbound.CampaignDTO[] |
getCampaignsDTORetrieves all the requested attributes on all the specified campaigns. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO |
getPreviewRecordDTORequests the sending of a new outbound interaction and gets the associated outbound record data, if a record is available in this campaign. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[] |
getRecordsDTORetrieves all the requested attributes on all the specified records. |
void |
markProcessedMarks this interaction as processed in OCS. Data of active records will also be updated in the OCS database. This action ends record processing in this interaction. |
void |
rejectRejects this outbound record. The current record (preview or callback) will not be dialed by this agent. It should then be resent to another agent by the system. This action ends record processing in this interaction. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[] |
requestChainedRecordsDTORetrieves alternative data to connect to a customer. Can be used when the primary number could not be correctly used. |
void |
rescheduleRecordReschedules a call for later. |
com.genesyslab.ail.ws.outbound.OutboundRecordError |
setRecordDTOSets attributes on a record. |
void |
startPreviewModeSets this agent as ready to work in preview campaign mode. |
void |
stopPreviewModethis 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. |
|
OutboundInteractionEventOutbound interaction event. Deprecated, instead use OutboundEvent. |
|
| Attribute Detail |
| Attributes of domain interaction.voice.outbound |
Type: com.genesyslab.ail.ws.outbound.OutboundInteractionAction[]
Type: String
Type: com.genesyslab.ail.ws.outbound.OutboundEventType
Type: String
Type: boolean
Type: com.genesyslab.ail.ws.outbound.OutboundStatus
Type: String[]
Type: com.genesyslab.ail.ws.outbound.TreatmentType
| 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.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 |
StringStringStringStringStringcom.genesyslab.ail.ws.KeyValue[]voidStringStringStringcom.genesyslab.ail.ws.KeyValue[]voidStringvoidStringStringvoidStringStringbooleanvoidStringStringvoidStringStringStringvoidStringStringStringbooleanvoidStringString[]String[]com.genesyslab.ail.ws.outbound.CampaignDTO[]StringStringString[]com.genesyslab.ail.ws.outbound.OutboundRecordDTOStringString[]String[]com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]StringvoidStringvoidStringString[]com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]StringStringlongcom.genesyslab.ail.ws.outbound.CallbackTypevoidStringcom.genesyslab.ail.ws.outbound.OutboundRecordDTOcom.genesyslab.ail.ws.outbound.OutboundRecordErrorStringStringvoidStringStringvoidStringStringvoid| Event Detail |
|
Interaction SDK (Web Services) |
||||||||
| PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
| SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT | ||||||||