Interaction SDK
(Web Services)

Service: OutboundService


Provides the outbound service. Deprecated, use ExtendedOutboundService instead.
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 contact’s 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 contact’s 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 contact’s 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

Outbound interaction voice attributes definition


actionsPossible

Type: com.genesyslab.ail.ws.outbound.OutboundInteractionAction[]
The possible actions.
Properties: read event


activeRecordId

Type: String
The record that is marked as the active one within the list.
Properties: read read-default write event


eventType

Type: com.genesyslab.ail.ws.outbound.OutboundEventType
The type of the event. Note: Received only upon subscription to outbound interaction event.
Properties: event-default event


interactionId

Type: String
The interaction identifier. Note: Received only upon subscription to outbound interaction event.
Properties: event-default event


isScheduled

Type: boolean
true if this interaction was created when executing a callback.
Properties: read read-default event


outboundStatus

Type: com.genesyslab.ail.ws.outbound.OutboundStatus
The record handling status, which shows whether this interaction is still able to handle outbound related data (update, cancel, mark procesed...).
Properties: read read-default event


recordIds

Type: String[]
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.
Properties: read read-default event


treatmentType

Type: com.genesyslab.ail.ws.outbound.TreatmentType
The treatment data currently associated with this interaction.
Properties: read read-default write event


Attributes of domain outbound.campaign

Outbound campaign attributes definition


actionsPossible

Type: com.genesyslab.ail.ws.outbound.CampaignAction[]
The possible actions.
Properties: read event


campaignId

Type: String
The campaign identifier.
Properties: read read-default event-default event


description

Type: String
The description of this campaign.
Properties: read read-default event


eventType

Type: com.genesyslab.ail.ws.outbound.CampaignEventType
The current event type of this campaign.
Properties: read read-default event-default event


mode

Type: com.genesyslab.ail.ws.outbound.CampaignMode
The current mode of this campaign.
Properties: read read-default event


name

Type: String
The name of this campaign.
Properties: read read-default event


status

Type: com.genesyslab.ail.ws.outbound.CampaignStatus
The current state of this campaign.
Properties: read read-default event


Attributes of domain outbound.record

Outbound record attributes definition. NB : Outbound Record attributes are only sent with OutboundInteractionEvent of OutboundService.


actionsPossible

Type: com.genesyslab.ail.ws.outbound.OutboundRecordAction[]
The possible actions.
Properties: read event


callingListName

Type: String
The name of the current calling list.
Properties: read read-default event


callResult

Type: com.genesyslab.ail.ws.outbound.OutboundCallResult
The outbound record CallResult constant that corresponds to the result of this call.
Properties: read read-default write event


campaignId

Type: String
The campaign that handles this record.
Properties: read read-default event


contactMediaType

Type: String
The contact media type.
Properties: read event


customFields

Type: com.genesyslab.ail.ws.KeyValue[]
The custom fields for this record.
Properties: read read-default write event


dailyFrom

Type: int
The beginning of the time frame when this record can be called, in seconds from midnight.
Properties: read write event


dailyTill

Type: int
The end of the time frame when this record can be called, in seconds from midnight.
Properties: read write event


outboundChainId

Type: String
The OutboundChain this record belongs to or null. Sent only with ExtendedOutboundService.
Properties: read event


phone

Type: String
The phone number for this record.
Properties: read read-default write event


phoneType

Type: com.genesyslab.ail.ws.outbound.OutboundRecordPhoneType
The phone type for this record.
Properties: read write event


recordHandle

Type: String
An integer used as an ID (handle) for this record.
Properties: read read-default event


recordId

Type: String
The record identifier.
Properties: event-default event


status

Type: com.genesyslab.ail.ws.outbound.OutboundRecordStatus
The current status of this record within its interaction.
Properties: read read-default event


timezone

Type: String
The time zone ID or null if not available.
Properties: read write event


timeZoneOffset

Type: int
The timezone offset from GMT, in hours. Deprecated in write mode, use timezone instead.
Properties: read read-default write event


Method Detail

addNewRecordToCampaign

Adds a new record to this campaign. This new record will be the beginning of a new chain.
Parameters:

  agentId  String
   The agent identifier.

  campaignId  String
   The campaign identifier.

  interactionId  String
   The interaction identifier.

  recordIdSource  String
   The record source from which the new record is cloned.

  phoneNumber  String
   The phone number of the new record.

  recordData  com.genesyslab.ail.ws.KeyValue[]
   The record DTO data to add, see outbound.record attributes which have a write property.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent

  error.outbound.CampaignNotFound

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


addNewRecordToChain

Adds a new record at the end of the chained records currently handled by this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

  recordIdSource  String
   The record identifier.

  phoneNumber  String
   The phone number of the new record.

  recordData  com.genesyslab.ail.ws.KeyValue[]
   The record DTO data to add, see outbound.record attributes that have the write property.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


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.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


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.
Parameters:

  interactionId  String
   The interaction identifier.

  recordId  String
   The record identifier. If recordId is null, all records associated with the interaction are cancelled.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


cancelRecordByPhoneNumber

Cancels an outbound record. Used when an agent updates a contact’s data outside of campaign processing (during an inbound call, for example), and decides that there is no need to call this customer again.
Parameters:

  agentId  String
   The agent identifier.

  phoneNumber  String
   The phone number of the contact who requests to be cancelled.

  allChain  boolean
   true if all the chained records concerning the contact associated to this number should be cancelled, false otherwise.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


doNotCall

Prevents the current record (and all its chained records) from being dialed by any campaign, because of (for instance) the contact’s request. This action ends record processing in this interaction.
Parameters:

  interactionId  String
   The interaction identifier.

  logMessage  String
   Message to be written in the "Do Not Call" dedicated log.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


doNotCallRecord

Prevents this record (and only this one) from being dialed by any campaign, because of (for instance) the contact’s request.
Parameters:

  interactionId  String
   The interaction identifier.

  recordId  String
   The record identifier.

  reason  String
   Message to be written in "Do Not Call" dedicated log.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


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.
Parameters:

  agentId  String
   The agent identifier.

  phoneNumber  String
   The phone number of the contact who requests to be cancelled.

  reason  String
   The message to be written in the "Do Not Call" dedicated log

  allChain  boolean
   true if all the chained records concerning the contact associated with this number should be cancelled, false otherwise.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


getCampaignsDTO

Retrieves all the requested attributes on all the specified campaigns.
Parameters:

  agentId  String
   The agent identifier.

  campaignIds  String[]
   The campaign identifiers. If null, retrieves the attributes on all the campaigns.

  attributes  String[]
   The attributes to retrieve (outbound.campaign:*).

Returns:

  Type:  com.genesyslab.ail.ws.outbound.CampaignDTO[]

   The attributes for each campaign.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent


getPreviewRecordDTO

Requests the sending of a new outbound interaction and gets the associated outbound record data, if a record is available in this campaign.
Parameters:

  agentId  String
   The agent identifier.

  campaignId  String
   The campaign identifier.

  attributes  String[]
   no description

Returns:

  Type:  com.genesyslab.ail.ws.outbound.OutboundRecordDTO

   The requested attributes of the preview record (outbound.record:*).

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent

  error.outbound.CampaignNotFound

  error.outbound.InvalidStatus

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


getRecordsDTO

Retrieves all the requested attributes on all the specified records.
Parameters:

  interactionId  String
   The interaction identifier.

  recordIds  String[]
   The record identifiers.

  attributes  String[]
   The attributes to retrieve (outbound.record:*).

Returns:

  Type:  com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]

   The requested attributes for each record.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid


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.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


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.
Parameters:

  interactionId  String
   The interaction identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


requestChainedRecordsDTO

Retrieves alternative data to connect to a customer. Can be used when the primary number could not be correctly used.
Parameters:

  interactionId  String
   The interaction identifier.

  attributes  String[]
   The attributes to retrieve (outbound.record:*).

Returns:

  Type:  com.genesyslab.ail.ws.outbound.OutboundRecordDTO[]

   The requested attributes of the records.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


rescheduleRecord

Reschedules a call for later.
Parameters:

  interactionId  String
   The interaction identifier.

  recordId  String
   The record identifier.

  timeToReschedule  long
   The GMT time is set to the required date of the callback and time zone is set to customer's timezone.

  callbackType  com.genesyslab.ail.ws.outbound.CallbackType
   The type of the callback.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


setRecordDTO

Sets attributes on a record.
Parameters:

  interactionId  String
   The interaction identifier.

  recordDTO  com.genesyslab.ail.ws.outbound.OutboundRecordDTO
   The DTO data to set (outbound.record:*).

Returns:

  Type:  com.genesyslab.ail.ws.outbound.OutboundRecordError

  

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed
  

  error.common.BadAttributeType
  

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound


startPreviewMode

Sets this agent as ready to work in preview campaign mode.
Parameters:

  agentId  String
   The agent identifier.

  campaignId  String
   The campaign identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent

  error.outbound.CampaignNotFound

  error.outbound.InvalidStatus

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


stopPreviewMode

this agent as not ready to work in a preview campaign mode.
Parameters:

  agentId  String
   The agent identifier.

  campaignId  String
   The campaign identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadAgentId

  error.outbound.NotAnAgent

  error.outbound.CampaignNotFound

  error.outbound.InvalidStatus

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


updateRecord

Updates the record in the OCS, using its fields’ current values.
Parameters:

  interactionId  String
   The interaction identifier.

  recordId  String
   The record identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.OutboundRecordNotFound

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.service.AddRecordError

  error.outbound.service.ChainedRecordsNotFound

  error.outbound.service.DatabaseError

  error.outbound.service.InvalidRequest

  error.outbound.service.InvalidTime

  error.outbound.service.InvalidTimeFormat

  error.outbound.service.KeyMissing

  error.outbound.service.NoActiveCampaign

  error.outbound.service.NoRecordAvailable

  error.outbound.service.PreviewDialingOverError

  error.outbound.service.PreviewDialingStartError

  error.outbound.service.RecordAlreadyExists

  error.outbound.service.RecordAlreadyProcessed

  error.outbound.service.ScheduledRecordNotFound

  error.outbound.service.NotAvailable

  error.outbound.service.Unknown


Event Detail

CampaignOutboundEvent

Outbound campaign event.
Available attributes:  outbound.campaign:*

Filters:

Triggers:

  Key: AGENT   Value: agentId  -  Subscribes on this agent


OutboundInteractionEvent

Outbound interaction event. Deprecated, instead use OutboundEvent.
Available attributes:  interaction.voice.outbound:*, outbound.record:*

Filters:

Triggers:

  Key: AGENT   Value: agentId  -  Subscribes on this agent

  Key: PLACE   Value: placeId  -  Subscribes on this place

  Key: DN   Value: dnId  -  Subscribe on this Dn


Interaction SDK
(Web Services)