|
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:actionsPossible The possible actions. |
String |
interaction.voice.outbound:activeRecordId The record that is marked as the active one within the list. |
com.genesyslab.ail.ws.outbound.OutboundEventType |
interaction.voice.outbound:eventType The type of the event. Note: Received only upon subscription to outbound interaction event. |
String |
interaction.voice.outbound:interactionId The interaction identifier. Note: Received only upon subscription to outbound interaction event. |
boolean |
interaction.voice.outbound:isScheduled true if this interaction was created when executing a callback. |
com.genesyslab.ail.ws.outbound.OutboundStatus |
interaction.voice.outbound:outboundStatus The record handling status, which shows whether this interaction is still able to handle outbound related data (update, cancel, mark procesed...). |
String[] |
interaction.voice.outbound:recordIds The 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:treatmentType The treatment data currently associated with this interaction. |
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. |
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. This new record will be the beginning of a new chain. |
void |
addNewRecordToChain Adds a new record at the end of the chained records currently handled by this interaction. |
void |
cancel Cancels 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 |
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 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 |
doNotCall Prevents 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 |
doNotCallRecord Prevents this record (and only this one) from being dialed by any campaign, because of (for instance) the contacts request. |
void |
doNotCallRecordByPhoneNumber When 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[] |
getCampaignsDTO Retrieves all the requested attributes on all the specified campaigns. |
com.genesyslab.ail.ws.outbound.OutboundRecordDTO |
getPreviewRecordDTO Requests 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[] |
getRecordsDTO Retrieves all the requested attributes on all the specified records. |
void |
markProcessed Marks 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 |
reject Rejects 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[] |
requestChainedRecordsDTO Retrieves alternative data to connect to a customer. Can be used when the primary number could not be correctly used. |
void |
rescheduleRecord Reschedules a call for later. |
com.genesyslab.ail.ws.outbound.OutboundRecordError |
setRecordDTO Sets attributes on a record. |
void |
startPreviewMode Sets this agent as ready to work in preview campaign mode. |
void |
stopPreviewMode 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. |
|
OutboundInteractionEvent Outbound 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 |
String
String
String
String
String
com.genesyslab.ail.ws.KeyValue[]
void
String
String
String
com.genesyslab.ail.ws.KeyValue[]
void
String
void
String
String
void
String
String
boolean
void
String
String
void
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.OutboundRecordDTO
String
String[]
String[]
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]
String
void
String
void
String
String[]
com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]
String
String
long
com.genesyslab.ail.ws.outbound.CallbackType
void
String
com.genesyslab.ail.ws.outbound.OutboundRecordDTO
com.genesyslab.ail.ws.outbound.OutboundRecordError
String
String
void
String
String
void
String
String
void
Event Detail |
|
Interaction SDK (Web Services) |
||||||||
PREV SERVICE NEXT SERVICE | FRAMES NO FRAMES | ||||||||
SUMMARY: ATTRIBUTE | METHOD | EVENT | DETAIL: ATTRIBUTE | METHOD | EVENT |