Campaign methods

createScript(Script scriptTemplate, string newName, string elementNames[], byte[][] elementContents, Org org)

Creates a new script named 'newName' in the supplied organization based on the scriptTemplate and new data (contents) to replace elementNames.

Input

• scriptTemplate : internalId or externalId
• org : internalId or (externalId, parent, type)
• newName : name of Script to be created
• elementNames : names of elements to be replaced
• elementContents: new data used to replace existing contents of elementNames

Response

Script (D)

Availability

Engage 7.3.3

Errors returned

• ARG_INVALID_DATA – Script specified is not a template or elementNames size != elementContents size
• ARG_NULL – Argument supplied is null
• ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• SYSTEM_LIMIT_EXCEEDED – maximum number of active scripts exceeded

Notes

• The number of entries and the order of elementNames corresponds and matches elementContents.
• The maximum number of items that may be supplied using this method is 10.
• The maximum number of active scripts is 100.

createScriptUsingContent(string name, string contentNames[], byte[][] contentData, Org org)

Creates a new script named 'name' in the supplied organization based on the XML interaction and data.

Input

• name : name of Script to be created
• contentNames : names of elements to be added
• contentData: data associated with names
• org : internalId or (externalId, parent, type)

Response

Script (D)

Availability

Engage 7.5.5

Errors returned

• ARG_INVALID_CHAR – Invalid Data, argument '%s' contains invalid characters
• ARG_INVALID_DATA – Invalid Data '%s
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• SYSTEM_LIMIT_EXCEEDED – maximum number of active scripts exceeded

Notes

• The number of entries and the order of contentNames corresponds and matches contentData.
• The supported extensions for contentNames are ".js", ".xml", ".xsl" and ".wav".
• The maximum number of items that may be supplied using this method is 500.
• The maximum size of the contents must not exceed 5Mb in aggregate.
• The maximum number of active scripts is 100.
• For voice scripts the first element in contentNames is assumed to be the source of the XML
• Org must be either an Account or an Enterprise. If an enterprise is supplied then the script will be created in the master account.

deleteScript(Script script)

Deletes an existing script

Input

script: internalId or externalId and owner

Response

NONE

Availability

Engage 7.5.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listScripts(Org org)

Retrieves information about the set of scripts in this organization.

Input

org : internalId or (externalId, parent, type)

Response

Script[] (K)

Availability

Engage 7.5.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• Supported for both Accounts and Enterprises. If enterprise supplied then Scripts from the master account will be returned.
• The maximum number of items returned using this method is 1,000.

createCampaign(Campaign campaign, Org org)

Creates a new campaign associated with the identified entity.

Input

• campaign: externalId
• org: internalId or (externalId, parent, type)

Response

Campaign (D)

Availability

Engage 7.6.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Argument supplied is null
• ATTRIBUTE_INVALID_CHAR – Contact list name contains invalid characters
• ATTRIBUTE_NULL – Attribute supplied is null
• ATTRIBUTE_TRUNCATED – Description for campaign is too long
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• SYSTEM_LIMIT_EXCEEDED – maximum number of active campaigns exceeded

Notes

The maximum number of campaigns simultaneously available is 100.

showCampaign(Campaign campaign)

Retrieves information about the supplied Campaign.

Input

campaign: internalId or externalId and Org

Response

Campaign (D)

Availability

Engage 7.6.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listCampaigns(Org org, date fromDate, date toDate)

Retrieves information about the set of campaigns in this Account created between fromDate and toDate.

Input

org : internalId or (externalId, parent, type)

Response

Campaign[] (D)

Availability

Engage 7.6.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• If fromDate and toDate are null then all items are returned.
• If toDate is null then no end date is assumed – i.e. all future campaigns will be returned.
• If fromDate is null then no start date is assumed – i.e. all past campaigns will be returned.
• Returned Campaigns may include campaigns that have expired.
• The maximum number of items returned using this method is 1,000.
• The supplied Org must be either a valid Account or Enterprise.

listCampaignsUsingCampaign(Org org, Campaign sample)

Retrieves information about the set of campaigns in this Account that match the supplied sample.

Input

• org : internalId or (externalId, parent, type)
• sample : optional list of Campaign attributes to narrow the returned set.

Response

Campaign[] (D)

Availability

Engage 10.1

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• The maximum number of items returned using this method is 1,000.
• The supplied Org must be either a valid Account or Enterprise.
• Only the attributes on the core entity are matched if a sample is supplied.

createOutreachStrategy(OutreachStrategy outreachStrategy, Org org)

Adds new Outreach Strategy to supplied organization.

Input

outreachStrategy: all required attributes org : internalId or (externalId, parent, type)

Response

OutreachStrategy (D)

Availability

Engage 10.0

Errors returned

• ARG_INVALID_CHAR – Invalid Data, argument '%s' contains invalid characters
• ARG_INVALID_DATA – Invalid Data '%s
• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

Required fields:

• externalId

deleteOutreachStrategy(OutreachStrategy outreachStrategy)

Deletes supplied Outreach Strategy.

Input

outreachStrategy : internalId

Response

NONE

Availability

Engage 10.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

showOutreachStrategy(OutreachStrategy outreachStrategy)

Retrieves information about the supplied Outreach Strategy.

Input

outreachStrategy : externalId + owner

Response

OutreachStrategy (D): Complete Outreach Strategy object.

Availability

Engage 10.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listOutreachStrategy(Org org, OutreachStrategy sample)

Lists all Outreach Strategies in the supplied organization that match the supplied sample Outreach Strategy.

Input

• org : internalId or (externalId, parent, type)
• sample : optional list of Outreach Strategy attributes to narrow the returned set.

Response

OutreachStrategy[] (D)

Availability

Engage 10.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• If sample is null – all Outreach Strategies within Org will be returned.
• If sample is non-null all attributes must match.
• The maximum number of items returned using this method is 100.

changeOutreachStrategy(OutreachStrategy outreachStrategy)

Updates fields/attributes of the supplied Outreach Strategy

Input

outreachStrategy : internalId + any fields to be changed

Response

outreachStrategy (D): Updated object.

Availability

Future

Errors returned

• ARG_INVALID_CHAR – Invalid Data, argument '%s' contains invalid characters
• ARG_INVALID_DATA – Invalid Data '%s
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

changeCampaign(Campaign campaign)

Updates fields/attributes of the supplied Campaign.

Input

campaign : internalId (or externalId and owner) + any fields to be changed

Response

campaign (D): Updated object.

Availability

Engage 7.6.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ATTRIBUTE_INVALID_CHAR – Campaign name contains invalid characters
• ATTRIBUTE_INVALID_FORMAT – Attribute is not formatted correctly
• ATTRIBUTE_NULL – Attribute supplied is null
• ATTRIBUTE_TRUNCATED – Description or externalId is too long
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

createSubCampaign(SubCampaign subCampaign, List list, Script script, Org org)

Creates a SubCampaign using a supplied Script as opposed to the default from the Strategy.

Input

• subCampaign : must minimally specify the name of the Campaign, additional attributes on this object override defaults from the specified Campaign
• list : internalId
• script : internalId
• org : internalId or (externalId, parent, type)

Response

SubCampaign (D)

Availability

Engage 7.5.10

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• SYSTEM_LIMIT_EXCEEDED – maximum number of active SubCampaigns exceeded

Notes

• The maximum number of active SubCampaigns is 50.
• The supplied Org must be a valid Account.

listSubCampaigns(Campaign campaign, boolean includeDeleted, dateTime fromTime, dateTime toTime)

Retrieves information about the set of SubCampaigns associated with this Campaign.

Input

campaign: externalId or internalId

Response

SubCampaign[] (D)

Availability

Future

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• If fromTime and toTime are null then all items are returned.
• If toTime is null then now is assumed.
• If fromTime is null then earliest item is returned.
• The maximum number of items returned using this method is 1,000.

showSubCampaignStateUsingContactAttempt(ContactAttempt contactAttempt)

Retrieves SubCampaignState associated with the supplied ContactAttempt.

Input

contactAttempt: value to be searched (secondaryDevice & possibly messageText)

Response

SubCampaignState (D)

Availability

Engage 7.8.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

• Only those secondaryDevice currently supporting inbound SubCampaigns will be searched.
• Unlike most show services, this service is not by unique key and the supplied secondaryDevice may not be present or may not be authorized. In this case a system SubCampaignState will be returned.

changeSubCampaign(SubCampaign subCampaign)

Updates fields/attributes of the supplied SubCampaign

Input

subCampaign : internalId (or externalId and uniquely identified Campaign) + any fields to be changed

Response

subCampaign (D): Updated object.

Availability

Engage 7.7.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ATTRIBUTE_INVALID_CHAR – ExternalId contains invalid characters
• ATTRIBUTE_INVALID_DATA – Invalid Data '%s
• ATTRIBUTE_NULL – Attribute supplied is null
• ATTRIBUTE_TRUNCATED – List Definition name is too long
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

• Currently supported attributes on running SubCampaign are: intensity, externalId.
• Currently supported attributes on the embedded running passes are: pacingPriority, pacing, contactsPerMinute, maxContactsPerMinute, leaveMessage.
• This API supports a retry of a completed SubCampaign. In order to retry a completed SubCampaign it is necessary to add a new Pass (or passes).

showSubCampaignState(SubCampaign subCampaign)

Retrieves state information about the identified SubCampaign.

Input

SubCampaign : internalId or externalId and uniquely identified Campaign

Response

SubCampaignState (D)

Availability

Engage 7.3.3

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listSubCampaignStates(Org org, SubCampaignState sample, dateTime fromTime, dateTime toTime)

Retrieves state information about the set of SubCampaigns associated with this org.

Input

• org : internalId or (externalId, parent, type)
• sample : optional list of SubCampaignState attributes to narrow the returned set.

Response

SubCampaignState[] (D)

Availability

Engage 7.5.5

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• If sample is null – all SubCampaignStates within Org and timeframe will be returned.
• If fromDate is null and the sample is null or sample.State is null, 'Done' or 'All' then yesterday is assumed. In all other cases the earliest item is returned.
• If toDate is null and the sample is null or sample.State is null, 'Done' or 'All' then tomorrow is assumed. In all other cases the latest item is returned.
• The supplied Org must be either a valid Account or Enterprise.

The maximum number of items returned using this method is 100. Results returned are ordered in an ascending fashion based on fromDate, then Campaign name, then SubCampaign name.

• The attributes supported on the sample are:
  • State which must be one of the synthetic states (Active, All, Completed or Done). The Active state includes Loading, Running, Paused, Pending and Stopping. The Completed state includes Awaiting, Cancelled, Completing and Done. The Done state includes Awaiting, Cancelled and Done.
  • Type on the embedded SubCampaign
    • InternalId or externalId on the SubCampaign. The externalId will do a case-insensitive wildcard match – i.e. 'plugh' will match '*plugh*'.
  • Campaign on the embedded SubCampaign
    • Only fields supported are the internalId or the externalId. The externalId will do a case-insensitive wildcard match – i.e. 'plugh' will match '*plugh*'.
  • AgentGroup[0] on the embedded SubCampaign
    • Only fields supported are the internalId or the externalId. The externalId will do a case-insensitive wildcard match – i.e. 'plugh' will match '*plugh*'.
  • Pass[0].channel on the embedded SubCampaign

changeSubCampaignState(SubCampaignState subCampaignState)

Updates fields/attributes of the supplied SubCampaignState.

Input

subCampaignState : subCampaign (internalId or externalId and uniquely identified Campaign)

Response

SubCampaignState (D): Updated object.

Availability

Engage 7.5.5

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

• The only state changes supported are Done (or equivalently Stopping), Paused and Running, these are used to stop, pause or resume (or start) an existing SubCampaign.
• To change attributes of the associated SubCampaign use changeSubCampaign().

createContactAttempts(Campaign campaign, Pass pass, Contact[] contacts, Script script, Org org)

Creates attempts to a set of contacts.

Warning

Deprecated as of 10.0

Input

• campaign: Associated Campaign if externalId & internalId are null then a system defined default will be used.
• pass: Populated Pass object to control callerID presented, direct connect phone number, retry *behavior, Answering machine hangup behavior, etc.
• contacts: populated contacts
• script : internalId
• org : internalId or (externalId, parent, type)

Response

ContactAttempt[] (K)

Availability

Engage 8.1.0 – deprecated as of 10.0, see createContactBatch()

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

This method uses the device indicated by the Pass from the contact.

createContactBatch(ContactBatch contactBatch, Contact[] contacts, OutreachStrategy override)

Initiates outreach to a set of contacts.

Input

• contactBatch : ContactBatch associated with this set of contacts.
• contacts : The set of contacts to attempt
• override : An OutreachStrategy to override the default on the ContactBatch

Response

ContactBatch (D):

Availability

Engage 10.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

• All Suppression Lists will be honored.
• Date & Region Compliance are honored.
• The campaign on the ContactBatch is optional, if it is null then it defaults to the default Campaign for the account.
• If provided the externalId on the ContactBatch must be unique within the scope of a Campaign, if the name is found then an error will be returned.
• The outreachStrategy on the ContactBatch is optional, if it is null then it defaults to the accounts default OnDemand strategy.
• The script on the ContactBatch is optional, if it is null the default on the OutreachStrategy is used.
• The agent on the ContactBatch is optional, if it is non-null then the message requested will be assigned to this Agent.
• The agentGroup on the ContactBatch is optional, if it is null it defaults to the Campaigns default AgentGroup. Note: For 10.0 any outreach that requires an agent must have a non-null agentGroup on the ContactBatch.
• The owner on the ContactBatch must be non-null and must be an Account.
• Override OutreachStrategy is not currently supported and must be null.
• Once a ContactBatch is defined the OutreachStrategy, Script and AgentGroup are fixed and subsequent uses of the ContactBatch must provide the same OutreachStrategy, Script and AgentGroup
• If the requestedStartTime on the ContactBatch is null or in the past it will be set to the current time, if set it cannot be more than 10 days in the future.
• The maxDuration on the ContactBatch must be set and cannot be more than 12 hours in the future.
• This method does not currently support the timeZoneSource on the associated Pass.
• The maximum size of the contact array is 100.

createContactBatchAsync(ContactBatch contactBatch, Contact[] contacts, OutreachStrategy override)

Initiates outreach to a set of contacts. Asynchronous version of createContactBatch. Requests, if valid, are queued immediately. Requests are then retrieved periodically and processed in batches.

Input

• contactBatch : ContactBatch associated with this set of contacts.
• contacts : The set of contacts to attempt
• override : An OutreachStrategy to override the default on the ContactBatch

Response

ContactBatch (D):

Availability

Engage 12.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
• INTERNAL_ERROR - Internal error while processing the request
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

• All Suppression Lists will be honored.
• Date & Region Compliance are honored.
• The campaign on the ContactBatch is optional, if it is null then it defaults to the default Campaign for the account.
• If provided the externalId on the ContactBatch must be unique within the scope of a Campaign, if the name is found then an error will be returned.
• The outreachStrategy on the ContactBatch is optional, if it is null then it defaults to the accounts default OnDemand strategy.
• The script on the ContactBatch is optional, if it is null the default on the OutreachStrategy is used.
• The agent on the ContactBatch is optional, if it is non-null then the message requested will be assigned to this Agent.
• The agentGroup on the ContactBatch is optional, if it is null it defaults to the Campaigns default AgentGroup. Note: For 10.0 any outreach that requires an agent must have a non-null agentGroup on the ContactBatch.
• The owner on the ContactBatch must be non-null and must be an Account.
• Override OutreachStrategy is not currently supported and must be null.
• Once a ContactBatch is defined the OutreachStrategy, Script and AgentGroup are fixed and subsequent uses of the ContactBatch must provide the same OutreachStrategy, Script and AgentGroup
• If the requestedStartTime on the ContactBatch is null or in the past it will be set to the current time, if set it cannot be more than 10 days in the future.
• The maxDuration on the ContactBatch must be set and cannot be more than 12 hours in the future.
• This method does not currently support the timeZoneSource on the associated Pass.
• The maximum size of the contact array is 100.
• External ID must be unique within given account and campaign, otherwise request is rejected as duplicated.
• If enterprise for given account is secure, then encrypted custom payload must not exceed certain size, set by default to 96kB or defined by 'api.contact.payload.block.size'. If not secure, custom payload must not exceed defined block size.

showContactBatchState(ContactBatch contactBatch)

Retrieves state information for the supplied ContactBatch.

Input

contactBatch : externalId

Response

ContactBatchState (D)

Availability

Engage 10.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listContactBatchStates (ContactBatch sample, dateTime fromTime, dateTime toTime)

Retrieves a list of ContactBatchStates based on the ContactBatch and the time window.

Input

sample : ContactBatch associated with this set of contacts.

Response

ContactBatchState[](K)

Availability

10.5.29

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• The ContactBatch sample allows the specification of a campaign or Agent or AgentGroup to limit the search.
• The returned data is limited by the data currently available online.
• The maximum number of items returned using this method is 1000.
• The time range is used to constrain the search to a particular timeframe. The timeframe is specified using the fromTime and toTime arguments either (or both) of which may be null.

fromTime	toTime	Time range
Null	Null	now - 24 hours → now
non-null	Null	fromTime → fromTime + 24 hours
Null	non-null	toTime - 24 hours → toTime
non-null	non-null	fromTime → toTime (fromTime must be less than toTime)

changeContactBatchState(ContactBatchState contactBatchState)

Updates fields/attributes of the supplied ContactBatchState.

Input

contactBatchState : ContactBatch internalId or externalId

Response

ContactBatchState (D): Updated object.

Availability

Engage 10.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• INVALID_STATE – If an attempt is made to cancel a Done or Cancelled batch
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

The only state changes supported is Cancelled this is used to stop the ContactBatch.

createComplianceRule(ComplianceRule complianceRule, Org org)

Creates a new ComplianceRule associated with the identified entity.

Input

• complianceRule: type
• org: internalId or (externalId, parent, type)

Response

ComplianceRule (D)

Availability

Engage 10.3.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Argument supplied is null
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

• The maximum number of ComplianceRules simultaneously available is 1000.
• For Region type compliance support is only available at the Enterprise.
• For Date type compliance all dates in the element list must be in the same year.
• For Date type compliance the maximum date allowed is the end of the next calendar year.

deleteComplianceRule(ComplianceRule complianceRule)

Deletes a ComplianceRule

Input

complianceRule : internalId

Response

NONE

Availability

Engage 10.3.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

showComplianceRule(ComplianceRule complianceRule)

Retrieves information about the supplied ComplianceRule.

Input

complianceRule: internalId

Response

ComplianceRule (D)

Availability

Engage 10.3.0

Errors returned

• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ATTRIBUTE_NULL – Attribute supplied is null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

listComplianceRules(Org org)

Retrieves information about the set of ComplianceRules in this Org.

Input

org : internalId or (externalId, parent, type)

Response

ComplianceRule[] (D)

Availability

Engage 10.3.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• The maximum number of items returned using this method is 1,000.
• The supplied Org must be either a valid Account or Enterprise.
• For Date type compliance the earliest rules that will be returned are from the beginning of the prior calendar year.

changeComplianceRule(ComplianceRule complianceRule)

Updates fields/attributes of the supplied ComplianceRule.

Input

complianceRule: internalId

Response

ComplianceRule[] (D): updated ComplianceRule

Availability

Engage 10.3.0

Errors returned

• ARG_INVALID – Argument is invalid – reason '%s'
• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

showContactAttempts(ContactAttempts[] contactAttempts)

Retrieves state information about the identified ContactAttempts.

Input

contactAttempts : internalId

Response

ContactAttempt[] (D)

Availability

Engage 7.7.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• ARG_TOO_LARGE – Invalid Data, argument '%s' exceeds allowed size
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

The maximum size of the contactAttempts array is 100.

listContactAttempts(Org org, ContactAttempt sample, dateTime fromTime, dateTime toTime)

Retrieves a list of contact attempts based on either a ClientID or Device.

Input

• org : internalId or (externalId, parent, type)
• sample: Either externalId of contact or externalId of device[0] on contact.

Response

ContactAttempt[](K)

Availability

Engage 7.7.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• The maximum number of items returned using this method is 500.
• The supplied Org must be either a valid Account or Enterprise.
• The returned data is limited by the data currently available online.
• The time range is only valid when using the ClientID or Device and is used to constrain the search to a particular timeframe. The timeframe is specified using the fromTime and toTime arguments either (or both) of which may be null.

fromTime	toTime	Time range
Null	null	now - 24 hours → now
non-null	null	fromTime → fromTime + 24 hours
Null	non-null	toTime - 24 hours → toTime
non-null	non-null	fromTime → toTime (fromTime must be less than toTime)

listContactAttemptsUsingUser(User user, ContactAttempt sample, dateTime fromTime, dateTime toTime)

Retrieves a list of contact attempts for given agent.

Input

• user : internalId or externalId
• sample: Either externalId of contact or externalId of device[0] on contact.

Response

ContactAttempt[](K)

Availability

Engage 12.0.0

Errors returned

• ATTRIBUTE_INVALID_DATA – =Attribute contains invalid data: '%s'.
• ATTRIBUTE_INVALID_FORMAT – Attribute '%s' has an invalid format.
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large
• ATTRIBUTE_NULL – Attribute '%s' must be non-null.
• NO_SESSION – No current session.

Notes

• The maximum number of items returned using this method is 500.
• The supplied User must be of Agent role.
• The returned data is limited by the data currently available online.

The timeframe is specified using the fromTime and toTime arguments either (or both) of which may be null.

fromTime	toTime	Time range
Null	null	now - 24 hours ? now
non-null	null	fromTime ? fromTime + 24 hours
Null	non-null	toTime - 24 hours ? toTime
non-null	non-null	fromTime ? toTime (fromTime must be less than toTime, for now fromTime , toTime cannot be more than 2)

listContactAttemptsUsingContactBatch(ContactBatch contactBatch, dateTime fromTime, dateTime toTime)

Retrieves a list of contact attempts based on the ContactBatch.

Input

contactBatch : ContactBatch associated with this set of contacts.

Response

ContactAttempt[](K)

Availability

Unscheduled

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• RESULT_TOO_LARGE – Result returned would be too large

Notes

• The maximum number of items returned using this method is 1000.
• The returned data is limited by the data currently available online.
• The time range is used to constrain the search to a particular timeframe. The timeframe is specified using the fromTime and toTime arguments either (or both) of which may be null.

fromTime	toTime	Time range
Null	Null	now - 24 hours → now
non-null	Null	fromTime → fromTime + 24 hours
Null	non-null	toTime - 24 hours → toTime
non-null	non-null	fromTime → toTime (fromTime must be less than toTime)

changeContactAttempt(ContactAttempt contactAttempt)

Updates fields/attributes of the supplied ContactAttempt.

Input

contactAttempt : internalId

Response

ContactAttempt (D): Updated object.

Availability

Engage 7.7.0

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist

Notes

The only changes supported are adding the archive tag to tags (Text only).

createSubCampaignUsingInboundDevice(SubCampaign subCampaign, Script script, Org org, Device device)

Creates a SubCampaign with InboundDevice using a supplied Script as opposed to the default from the Strategy.

Input

• subCampaign : must minimally specify the name of the Campaign, additional attributes on this object override defaults from the specified Campaign
• script : internalId
• org : internalId or (externalId, parent, type)
• device : internalId or (externalId, inboundDeviceType) or (externaldId, inboundDeviceType = 'ShortCode' and keywords(single valid keyword))

Response

SubCampaign (D)

Availability

Engage 11.8

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_EXISTS – Object '%s' already exists
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• SYSTEM_LIMIT_EXCEEDED – maximum number of active SubCampaigns exceeded
• ARG_INVALID_DATA=Argument contains invalid data: {0}.
• ATTRIBUTE_NULL=Attribute {0} must be non-null.
• ATTRIBUTE_INVALID=Attribute is invalid, reason: {0}.
• ATTRIBUTE_INVALID_DATA=Attribute contains invalid data: {0}.
• INBOUND_SUBCAMPAIGN_INVALID_LABEL=Label invalid. Please enter a valid label.
• INBOUND_TEXT_KEYWORD_CANNOT_BE_DELETED=Cannot delete ShortCode: {0}, since one of its keywords is active.
• INBOUND_DEVICE_ASSIGNED_ACTIVE_CAMPAIGN=Unable to reassign Inbound Device. The Caller ID associated with the Inbound Device is currently assigned to an active template in account {0}. Please go to Accounts Caller ID listing page and change the templates that are referencing the number.
• ONDEMAND_DEFAULT_STRATEGY_INVALID=The call pass with channel type {0} is not found at on demand strategy, please check the default on demand strategy and try again.
• INBOUND_SKILLGROUP_REQUIRED=This script requires an Agent Group.
• INBOUND_SCRIPT_REQUIRES_PORTAL_AGENT_GROUP=This script cannot be used with an this type of Agent Group. Please use a Portal Agent Group.
• INBOUND_SCRIPT_REQUIRES_STANDARD_AGENT_GROUP=This script cannot be used with an this type of Agent Group. Please use a Standard Agent Group.
• INBOUND_NOSKILLGROUP_REQUIRED=This script cannot be used with an Agent Group.
• INBOUND_TEXT_KEYWORD_ALREADY_ACTIVE=ShortCode: {0} with keyword: {1} is already active.

Notes

• The maximum number of active SubCampaigns is 50.
• The supplied Org must be a valid Account.

previewPacing(BaseEntity[] entities)

Return the Pacing Info for a set of passes assuming the supplied changes to the SkillGroup, SubCampaign or Pass

Input

• entities : supported entitytypes are AgentGroup, SubCampaign

Response

PacingInfo[] (D)

Availability

Engage 12.8

Errors returned

• ARG_INVALID_TYPE – Argument is of invalid type '%s'
• ARG_NULL – Invalid Data, argument '%s' must be non-null
• OBJECT_NOT_EXISTS – Referenced object '%s' does not exist
• ARG_INVALID_DATA=Argument contains invalid data: {0}.
• ATTRIBUTE_NULL=Attribute {0} must be non-null.
• ATTRIBUTE_INVALID=Attribute is invalid, reason: {0}.
• ATTRIBUTE_INVALID_DATA=Attribute contains invalid data: {0}.

Notes

• Supported AgentGroup attributes are allocatedCount, intensity.
• Supported SubCampaign attributes are intensity.
• To view pacing changes on SubCampaign level, passes should be provided as null.
• To view pacing changes at Pass level, pass attributes should be provided. Supported pass attributes are pacing,contactsPerMinute,pacingPriority