Interaction SDK
(Web Services)

com.genesyslab.ail.ws.outbound

Class Summary
CampaignDTO This class describes the DTO data for a campaign.
OutboundChainDTO Describes the DTO data for an outbound chain.
OutboundRecordDTO This class describes the DTO data for a record.
OutboundRecordError This class defines an outbound record error.

Enum Summary
OutboundChainReason Lists the possible reasons for an outbound event on a chain.
CallbackType This enum lists the possible types for an outbound callback.
CampaignAction The constants in this enum represent all actions that can possibly be applied to an outbound record.
CampaignEventType The constants in this enum represent all events that can be triggered for an outbound campaign.
CampaignMode The constants in this enum represent all possible modes of an outbound campaign.
CampaignStatus The constants in this enum represent all statuses that an outbound campaign can have.
OutboundCallResult The constants in this enum represent all results that an outbound call can have.
OutboundEventType The constants in this enum represent all event types that can change an outbound status.
OutboundInteractionAction The constants in this enum represent all possible actions that can be taken on an outbound interaction.
OutboundRecordAction The constants in this enum represent all actions that can possibly be applied to an outbound record.
OutboundRecordPhoneType The constants in this enum represent the phone type.
OutboundRecordStatus The constants in this enum represent all statuses that an outbound record can have.
OutboundStatus The constants in this enum represent all statuses that an outbound call can have.
TreatmentType The constants in this enum represent all treatments that can be applied to an outbound call.

Class Detail

CampaignDTO

This class describes the DTO data for a campaign.

Fields:

  campaignId  String
   The campaign identifier.

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

OutboundChainDTO

Describes the DTO data for an outbound chain.

Fields:

  outboundChainId  String
   The outbound chain identifier.

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

OutboundRecordDTO

This class describes the DTO data for a record.

Fields:

  recordId  String
   The record identifier.

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

OutboundRecordError

This class defines an outbound record error.

Fields:

  recordError  String
   The callback record error code.

  recordId  String
   The record identifier.

  attributeErrors  com.genesyslab.ail.ws.AttributeError[]
   The attributes errors codes.

Enum Detail

OutboundChainReason

Lists the possible reasons for an outbound event on a chain.

Members:

  CREATED
   Reason created.

  DELETED
   Reason deleted.

  UPDATED
   Reason updated.

CallbackType

This enum lists the possible types for an outbound callback.

Members:

  CAMPAIGN
   OCS will be able to distribute the callback to anybody logged into the campaign.

  PERSONAL
   OCS will have to address the same agent as the one who requested the callback.

CampaignAction

The constants in this enum represent all actions that can possibly be applied to an outbound record.

Members:

  ADD_RECORD
   Action of adding a record.

  GET_PREVIEW_RECORD
   Action of getting a preview record.

  START_PREVIEW_MODE
   Action of starting preview mode.

  STOP_PREVIEW_MODE
   Action of stopping preview mode.

  REQUEST_PREVIEW_RECORD
   Action of request preview record.

  REQUEST_LOGOUT
   Action of request logout.

CampaignEventType

The constants in this enum represent all events that can be triggered for an outbound campaign.

Members:

  UNKNOWN
   Unknown campaign event type.

  CAMPAIGN_ADDED
   A campaign was added in the outbound service.

  CAMPAIGN_REMOVED
   The mode of a campaign has changed.

  CAMPAIGN_MODE_CHANGED
   A campaign was removed from the outbound service.

  CAMPAIGN_STATE_CHANGED
   The status of a campaign has changed.

  LOGOUT_ACKNOWLEDGE
   The logout request has been accepted.

CampaignMode

The constants in this enum represent all possible modes of an outbound campaign.

Members:

  UNKNOWN
   Unknown mode of campaign.

  ENGAGED_PREDICTIVE
   Engaged predictive mode of campaign.

  ENGAGED_PROGRESSIVE
   Engaged progressive mode of campaign.

  PREDICTIVE
   Predictive mode of campaign.

  PREVIEW
   Preview mode of campaign.

  PROGRESSIVE
   Progressive mode of campaign.

CampaignStatus

The constants in this enum represent all statuses that an outbound campaign can have.

Members:

  UNKNOWN
   Unknown status.

  ACTIVE
   Active Campaign.

  INACTIVE
   Inactive campaign.

  RUNNING
   Running campaign.

OutboundCallResult

The constants in this enum represent all results that an outbound call can have.

Members:

  UNKNOWN
   Call result unknown.

  ABANDONED
   Call result abandoned.

  ANSWER
   Call result call answered.

  ANSWERING_MACHINE
   Call result answering machine detected.

  BUSY
   Call result busy.

  FAX
   Call result fax detected.

  NO_ANSWER
   Call result no answer.

  OK
   Call result OK.

  PAGER_DETECTED
   Call result pager detected.

  GENERAL_ERROR
   General error.

  SYSTEM_ERROR
   System error.

  SIT_DETECTED
   SIT detected.

  ALL_TRUNKS_BUSY
   All trunks busy.

  SIT_INVALID_NUM
   SIT invalid num.

  SIT_VACANT
   SIT vacant.

  SIT_INTERCEPT
   SIT intercept.

  SIT_UNKNOWN
   SIT unknown.

  SIT_NO_CIRCUIT
   SIT no circuit.

  SIT_REORDER
   SIT reorder.

  DROPPED
   Dropped.

  DROPPED_NO_ANSWER
   Dropped no answer.

  SILENCE
   Silence.

  NUTONE
   NU tone.

  NO_DIAL_TONE
   No dial tone.

  NO_PROGRESS
   No process.

  NO_RINGBACK
   No ringback.

  NO_ESTABLISHED
   No established.

  WRONG_PARTY
   Wrong party.

  DIAL_ERROR
   Dial error.

  CALL_DROP_ERROR
   Call drop error.

  SWITCH_ERROR
   Switch error.

  NO_FREE_PORT_ERROR
   No free port error.

  TRANSFER_ERROR
   Transfer error.

  STALE
   Stale.

  AGENT_CALLBACK_ERROR
   Agent callback error.

  GROUP_CALLBACK_ERROR
   Group callback error.

  DO_NOT_CALL
   Do not call.

  CANCEL_RECORD
   Cancel record.

  WRONG_NUMBER
   Wrong Number.

OutboundEventType

The constants in this enum represent all event types that can change an outbound status.

Members:

  UNKNOWN
   Unknown event type.

  ACTIVE_RECORD_CHANGED
   The active record of the interaction has been changed.

  RECORD_HANDLING_STATUS
   The OutboundStatus of an outbound voice interaction has changed.

  RECORD_STATUS
   The status of an outbound record has changed.

OutboundInteractionAction

The constants in this enum represent all possible actions that can be taken on an outbound interaction.

Members:

  ADD_RECORD_TO_CHAIN
   Action of adding a record to chain.

  CANCEL
   Action of canceling an outbound interaction.

  DO_NOT_CALL
   Action of marking not to call a contact.

  MARK_PROCESSED
   Action of marking processed an outbound interaction.

  REJECT
   Action of rejecting an outbound interaction.

  REQUEST_CHAINED_RECORDS
   Action of requesting chained records.

OutboundRecordAction

The constants in this enum represent all actions that can possibly be applied to an outbound record.

Members:

  CANCEL
   Action of cancelling a record.

  DO_NOT_CALL
   Action of marking not to call a record.

  RESCHEDULE
   Action of rescheduling a call.

  UPDATE
   Action of updating a record.

OutboundRecordPhoneType

The constants in this enum represent the phone type.

Members:

  NO_TYPE
   No Type.

  HOME_PHONE
   Home Phone.

  DIRECT_BUSINESS_PHONE
   Direct Business Phone.

  BUSINESS_WITH_EXTENSION
   Business with Extension.

  MOBILE
   Mobile.

  VACATION_PHONE
   Vacation Phone.

  PAGER
   Pager.

  MODEM
   Modem.

  VOICE_MAIL
   Voice Mail.

  PIN_PAGER
   Pin Pager.

  EMAIL_ADDRESS
   E-Mail address.

OutboundRecordStatus

The constants in this enum represent all statuses that an outbound record can have.

Members:

  UNKNOWN
   Record status has not been set yet.

  CLONED
   Record has been closed by an external agent and can no longer be manipulated.

  CLOSED_EXTERNAL
   Record has been closed by an external agent and can no longer be manipulated.

  CLOSED_INTERNAL
   Record has been closed by the agent who was manipulating it and can no longer be manipulated.

  OPEN
   Record is ready to be manipulated.

OutboundStatus

The constants in this enum represent all statuses that an outbound call can have.

Members:

  UNKNOWN
   Not set yet.

  CLOSED_EXTERNAL
   This outbound interaction has been closed by an external agent and its outbound data can no longer be manipulated.

  CLOSED_INTERNAL
   This outbound interaction has been closed by the agent who was manipulating it and its outbound data can no longer be manipulated.

  OPEN
   Outbound data can be manipulated.

TreatmentType

The constants in this enum represent all treatments that can be applied to an outbound call.

Members:

  NONE
   No treatment type.

  CAMPAIGN
   Treatment type campaign.

  PERSONAL
   Treatment type personal.

Interaction SDK
(Web Services)