Dialing Strategies are the rules that define the inclusion of numbers for an account, sequence of dialing, whether to move to the next number in the sequence, and requeue inclusion.

Currently the Configuration API supports List, Create, Update, and Delete methods for Dialing Strategies objects.

In order to use the methods listed that perform operations on Dialing Strategies resources, the user of the API must belong to either the Sysadmin, Superuser, Manager, or IT User role. If the user belongs to the Manager role, they must also have the "Dialing Strategies" optional power configured.

Create Dialing Strategy

Description: Creates a new Dialing Strategy.

User Roles: Sysadmin, Superuser, or Manager

Method: POST /configuration/dialingStrategies

Body:

KeyTypeMandatory?Description

displayName

StringYesName of the Dialing Strategy to be created.
serviceIdsArrayNo

An array of one or more Service IDs that will be assigned to the Dialing Strategy.

Although a Dialing Strategy is assigned to a Service this does not make it the Services' default Dialing Strategy, it only allows the Service to use the Dialing Strategy.

callCenterIdsArrayNo

An array of one or more CallCenter IDs that will be assigned to the Dialing Strategy.

dialingSequenceItemArrayYes

An array of one or more phone positions to assign to the Dialing Strategy. Phone positions should be listed in the order you want them dialed from top to bottom.

outcomeItemArrayNo

An array of zero or more results that will be assigned to the Dialing Strategy.

KeyTypeMandatory?Description
lvResultIdInteger (ID)YesInternal ID of the result
dialAnotherNumberBooleanYesIf set to true the next number in the dialing sequence will be dialed if this result is obtained on the first dial.
maxNumberOfRetriesIntegerYesThe number of re-dial attempts allowed
retryDelayIntegerYesThe interval in minutes between dialing another number if dialAnotherNumber is set to true
requeueBooleanYesIf set to true calls with this result will be requeued when the Dialing Strategy is assigned to a requeue campaign

Response Code: 201 Created

Body:

Key or AttributeTypeMandatory?Description
idInteger (ID)YesThe ID of the newly created Dialing Strategy.

Create a new Dialing Strategy

#Request (JSON)
POST /configuration/dialingStrategies HTTP/1.1
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
"serviceIds": [272646],
"callCenterIds":[120019],
"dialingSequenceItem": [1],
"outcomeItem": [
{
"lvResultId": 476,
"dialAnotherNumber": true,
"maxNumberOfRetries": 2,
"retryDelay": 5,
"requeue": true
}
],
"displayName": "QA1_API_Team11765178618752"
}
 
#Response
201 Created
Content-Type: application/json
 
{"id": 231796}
CODE

Delete All Dialing Strategy Outcomes

Description: Removes all outcomes from a Dialing Strategy.

User Roles: Sysadmin, Superuser, or Manager

Method: DELETE /configuration/dialingStrategies/{id}/outcomes

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idstrategyIdInteger (ID)YesThe ID of the Dialing Strategy to be updated.

Body:

None

Response Code: 204 No Content

Body:

None

Remove all outcomes from an existing Dialing Strategy

#Request (JSON)
DELETE /configuration/dialingStrategies/30953/outcomes
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
204 No Content
CODE

Delete Dialing Strategy

Description: Deletes a Dialing Strategy.

User Roles: Sysadmin, Superuser, or Manager

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idstrategyIdInteger (ID)TrueID of the Dialing Strategy you want to delete

Body:

None

Response Code: 204 No Content

Body:

None

Delete an existing Dialing Strategy

#Request
DELETE /configuration/dialingStrategies/30740
Host: localhost.com
Content-Type: application/json
Accept: application/json  

#Response
204 No Content
CODE

List Dialing Strategies

Description: Lists Dialing Strategies configured for a Client and what Services those Strategies are associated to.

User Roles: Sysadmin, Superuser, or Manager

Method: GET /configuration/dialingStrategies

Parameters:
None

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
idNumberNoID of the Dialing Strategy
nameStringYesName of the Dialing Strategy
outcomeItemListNo
AttributeTypeMandatory?Description
idNumberYesOutcome ID
dialAnotherNumberBooleanNoIndicates whether to dial another number
retryDelayNumberYesRetry delay
requeueBooleanNoIndicates if you can requeue the call
maxNumberOfRetriesNumberYesMax number of retires
displayNameStringNoDisplay Name
result Yes
AttributeTypeMandatory?Description
nameStringYesName of the result
idNumberYesResult ID
resultCodeStringYesResult Code
resultTypeStringNoResult Type
catagoryNameStringNoCatagory Name
notMadeBooleanNoIndicates if the call is made.
requeueBooleanNoIndicates if you can requeue the call.


dialingSequenceItemListNoA list of one or more phone positions to assign to the Dialing Strategy. Phone positions should be listed in the order you want them dialed from top to bottom.
serviceListNo

A list of one or more Service IDs that is assigned to the Dialing Strategy.

AttributeTypeMandatory?Description
idNumberNoService ID

callCentersListNo

A list of one or more Call Center IDs that is assigned to the Dialing Strategy.

AttributeTypeMandatory?Description
idNumberNoCall Center ID

List of Dialing Strategies configured for a Client

#Request (JSON)
GET /configuration/dialingStrategies
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response (JSON)
200 OK
Content-Type: application/json
 
[
  {
    "id": 230507,
    "name": "Apps_DSI_Test_2"
  },
  {
    "id": 226277,
    "name": "CCi_Test"
  },
  {
    "id": 226278,
    "name": "Campaign_Template_Auto"
  },
  .
  .
  .
  {
    "id": 226306,
    "name": "wireless-All"
  }
]
CODE

Update Dialing Strategy

Description: Updates the name and/or dialing sequence of a Dialing Strategy.

User Roles: Sysadmin, Superuser, or Manager

Method: POST /configuration/dialingStrategies/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
idstrategyIdInteger (ID)Yes

ID of the Dialing Strategy to be updated.

Body(JSON):

KeyTypeMandatory?Description
idNumberNoID of the Dialing Strategy
displayNameStringYesNew name of the Dialing Strategy.
outcomeItemListNo
AttributeTypeMandatory?Description
outcomeIdNumberYesOutcome ID
dialAnotherNumberBooleanNoIndicates whether to dial another number
retryDelayNumberYesRetry delay
requeueBooleanNoIndicates if you can requeue the call
maxNumberOfRetriesNumberYesMax number of retires
lvResultIdNumberYesResult ID

dialingSequenceItemListYesA list of one or more phone positions to assign to the Dialing Strategy. Phone positions should be listed in the order you want them dialed from top to bottom.
serviceIdsListNo

A list of one or more Service IDs that is assigned to the Dialing Strategy.

callCenterIdsListNo

A list of one or more Call Center IDs that is assigned to the Dialing Strategy.


Response Code: 204 No Content

Body:

None

Update a Dialing Strategy name and/or dialing sequence

#Request (JSON)
POST /configuration/dialingStrategies/231796
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
"dialingSequenceItem": [2],
"displayName": "QATest111765178618752",
"serviceIds": [272646],
"callCenterIds":[120019],
"outcomeItem": [
{
"lvResultId": 476,
"dialAnotherNumber": true,
"maxNumberOfRetries": 2,
"retryDelay": 5,
"requeue": true
}
]
}

#Response
204 No Content
CODE

Top of Page