Interaction SDK
(Web Services)

Service: ExtendedOutboundService


Provides the extended outbound service.
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 contact’s 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 contact’s 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

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.chain

Outbound attributes definition


activeRecordId

Type: String
The active record of the chain.
Properties: read read-default write event


campaignMode

Type: com.genesyslab.ail.ws.outbound.CampaignMode
The campaign mode related to this outbound chain. Note: Received only upon subscription to outbound event.
Properties: 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


interactionIds

Type: String[]
The interaction identifiers related to this chain.
Properties: read event


isScheduled

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


outboundChainId

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


reason

Type: com.genesyslab.ail.ws.outbound.OutboundChainReason
The reason. Note: Received only upon subscription to outbound event.
Properties: event-default event


recordIds

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

  placeId  String
   Agent's place identifier (mandatory).

  campaignId  String
   The campaign identifier (mandatory).

  outboundChainId  String
   The outbound chain identifier of an existing record on agent desktop (mandatory).

  recordIdSource  String
   The record source (recordhandle) from which the new record is to be cloned (mandatory).

  phoneNumber  String
   The phone number to be assigned to the new record (mandatory).

  recordData  com.genesyslab.ail.ws.KeyValue[]
   The DTO data to be added to the new record (refer to outbound.record attributes which have a write property) (optional).

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadPlaceId

  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:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


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

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


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:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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.BadPlaceId

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

  placeId  String
   The place identifier.

  phoneNumber  String
   the phone number of the contact whose records must be cancelled.

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


closeChain

Closes this outbound chain.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.BadPlaceId

  error.outbound.NotOutboundChain


createInteraction

Creates an interaction to process the given outbound chain.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  mediaType  com.genesyslab.ail.ws.place.MediaType
   The media type.

  queueId  String
   The queue identifier.

Returns:

  Type:  String

   The interaction identifier

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.BadPlaceId

  error.outbound.NotOutboundChain


createInteractionOpenMedia

Creates a new open media interaction to process the outbound chain.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  mediaType  String
   A media type defined in the 'Business Attributes/Media Type' section of the Configuration Layer. Do not use email or chat values.

  interactionType  String
   An interaction type defined in the 'Business Attributes/Interaction Type' section of the Configuration Layer.

  interactionSubtype  String
   An interaction subtype defined in the 'Business Attributes/Interaction Subtype' values.

  customerInteractionId  String
   The customer interaction ID when the interaction is received from a customer server, not a Genesys server.

  queue  String
   The queue to be submit the interaction to.

  subject  String
   The interaction subject.

  userData  com.genesyslab.ail.ws.KeyValue[]
   The customer data or useful additional data. Can be null.

Returns:

  Type:  String

   The interaction identifier

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.outbound.BadPlaceId

  error.outbound.NotOutboundChain


doNotCallChain

Prevents the current record (and all its chained records) from being dialed by any campaign, because of (for instance) the contact’s request. Note: This method does not modify the interaction (if any) associated with the records of this chain.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


doNotCallRecord

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

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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.BadPlaceId

  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

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

  placeId  String
   The place identifier.

  phoneNumber  String
   the phone number of the contact who requests not to be called again.

  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.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


getCampaignsDTO

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

  placeId  String
   The place identifier.

  campaignIds  String[]
   The campaign identifiers, or null to retrieve the attributes of all the active campaigns of this place.

  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.BadPlaceId

  error.outbound.NotAnAgent


getOutboundChainDTO

Returns the requested attributes of an outbound chain according to its outbound chain ID.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  attributes  String[]
   The attributes to be retrieved (outbound.chain:*).

Returns:

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

   The requested attributes for outbound information.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId

  error.outbound.BadPlaceId

  error.outbound.NotOutboundChain


getOutboundChainFromInteractionDTO

Returns the requested attributes of the outbound chain associated with the given interaction ID.
Parameters:

  placeId  String
   The place identifier.

  interactionId  String
   The interaction identifier.

  attributes  String[]
   The attributes to be retrieved (outbound.chain:*).

Returns:

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

   The requested attributes for outbound information.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId

  error.outbound.BadPlaceId


getOutboundChainFromPlaceDTO

Returns the requested attributes of an outbound chain.
Parameters:

  placeId  String
   The place identifier.

  attributes  String[]
   The attributes to be retrieved (outbound.chain:*).

Returns:

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

   The requested attributes for outbound information.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId

  error.outbound.BadPlaceId


getPreviewRecordDTO

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

  placeId  String
   The place identifier.

  campaignId  String
   The campaign identifier.

  attributes  String[]
   no description

Returns:

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

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

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadPlaceId

  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

Returns the requested attributes of the specified records.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  recordIds  String[]
   The record identifiers.

  attributes  String[]
   The attributes to be retrieved (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

  error.outbound.BadPlaceId


isASMCall

Returns true if the interaction is in ASM call mode.
Parameters:

  placeId  String
   The place identifier.

  interactionId  String
   The place identifier.

Returns:

  Type:  boolean

   Is ASM mode

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadInteractionId


isLogoutAcknowledged

Returns true if requestLogout() was acknowledged by the Outbound Server.
Parameters:

  placeId  String
   The place identifier.

  campaignId  String
   The campaign identifier.

Returns:

  Type:  boolean

   Returns true if requestLogout() was acknowledged by the Outbound Server.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadPlaceId

  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


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

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


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

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.BadInteractionId

  error.outbound.BadInteractionType

  error.common.DatabaseService

  error.common.ParameterInvalid

  error.outbound.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


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

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  attributes  String[]
   The attributes to be retrieved (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.BadPlaceId

  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

  error.common.voice.TelephonyTimeout

  error.common.voice.TelephonyService

  error.common.voice.NoDnAvailable

  error.common.voice.TelephonyError:TYPE:x1:TSERVER_CODE:x2:TSERVER_MESSAGE:x3

  error.common.InvalidStatus:ID_OBJECT:x1:EXPECTED_STATUS:x2:STATUS:x3


requestLogout

Requests to log out the agent from this campaign. A LOGOUT_ACKNOWLEDGE CampaignEvent is sent if the logout is taken into account.
Parameters:

  placeId  String
   The place identifier.

  campaignId  String
   The campaign identifier.

Returns:

  Type:  int

   estimated time (in seconds) before the agent is removed from this campaign.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadPlaceId

  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


rescheduleRecord

Reschedules a call for later. Deprecated uses rescheduleRecordUTC instead.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  recordId  String
   The record identifier.

  timeToReschedule  long
   The GIS time in seconds is set to the required date of the callback.

  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.BadPlaceId

  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


rescheduleRecordUTC

Reschedules a call for later.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  recordId  String
   The record identifier.

  timeToReschedule  long
   The GMT time in seconds is set to the required date of the callback. It is UTC seconds from the epoch.

  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.BadPlaceId

  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


setOutboundChainDTO

Sets the attributes of an outbound chain.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain identifier.

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO data to be set (outbound.chain:*).

Returns:

  Type:  com.genesyslab.ail.ws.AttributeError[]

   The errors if any.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed
  

  error.common.BadAttributeType
  

  error.outbound.BadInteractionId

  error.outbound.BadPlaceId

  error.outbound.NotOutboundChain


setRecordDTO

Sets the attributes of a record.
Parameters:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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

  error.outbound.BadPlaceId


startPreviewMode

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

  placeId  String
   The place identifier.

  campaignId  String
   The campaign identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadPlaceId

  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

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

  placeId  String
   The place identifier.

  campaignId  String
   The campaign identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.outbound.OutboundServiceNotInitialized

  error.outbound.BadPlaceId

  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:

  placeId  String
   The place identifier.

  outboundChainId  String
   The outbound chain 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.BadPlaceId

  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: PLACE   Value: placeId  -  Subscribes on this place.


OutboundChainEvent

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

Filters:

Triggers:

  Key: PLACE   Value: PlaceId  -  Subscribes on this place.


Interaction SDK
(Web Services)