General Explanation
The dialer api will allow you to connect to your customers faster than ever by allowing you to perform many dialer related actions straight through your CRM system.
This way you can manage the activity of your dialer campaigns via your CRM, in only one interface.
Some of the actions you can perform are:
- Get a list of the campaigns in your Voicenter account.
- Add or Remove destinations from a campaign.
- Add or remove agents to a campaign.
- Stop or start a campaign.
- Update your IVR Dialer campaign.
When using the dialer API, firstly you will need to use the GetCampaignList method where you will get the active campaigns in your Voicenter account.
GetCampaignList
Returns all automatic dialer campaigns.
Voicenter auto dialer service allows users to manage several separate sessions called "Campaigns".
Each "Campaign" can have its own settings and can dial to different destinations simultaneously.
Most of this API methods requires a specific campaign code.
With GetCampaignList you can get all this data in one place.
URI
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignList
Acceptable Request Types
POST-JSON
GET
Possible Response Formats
POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Code | Personal identifier, provided by Voicenter. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignList?Code=XXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Code": "XXXXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" - No Errors. | Integer |
| Description | Response status description: "OK" - No errors. | String |
| Data | JSON array type. List of the requested automatic dialer campaigns, both active and non active campaigns. | Array |
| Name | The Voicenter campaign name. | String |
| StatusName | Campaign status: 1. "Enabled" - Active Campaign. 2. "Disabled" - Stopped Campaign. | String |
| TotalPendingCalls | The sum of waiting records destinations to be dial. | Integer |
| MaxPriority | Returns the highest priority value that was set for a call destination record in the campaign. | Integer |
| MinPriority | Returns the lowest priority value that was set for a call destination record in the campaign. | Integer |
| TotalAwaitingCalls | Relevant only for IVR dialer campaigns. The sum of waiting records destinations to be dial at the IVR dialer service. This field is more recommended to use then "TotalPendingCalls" for IVR dialer campaign. In case of agent dialer campaign the returned value will be "null". | Integer |
| Code | The campaign unique identifier code. Needed for the auto dialer API methods. | String |
Voicenter Response Example
{
"Data":
[
{
"Name": "Campaign1",
"StatusName": "Enabled",
"TotalPendingCalls": 23,
"MaxPriority": 1,
"MinPriority": 1,
"TotalAwaitingCalls": 23,
"Code": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
{
"Name": "Campaign2",
"StatusName": "Enabled",
"TotalPendingCalls": 19,
"MaxPriority": 52,
"MinPriority": 1,
"TotalAwaitingCalls": null,
"Code": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
]
"ErrorCode": 0,
"Description": "OK"
}
AddCall
Using this method you will be able to add a single destination to your campaign.
In case you wish to add multiple destinations to a campaign, please use the next method: AddCallsBulk.
URI
https://api.voicenter.com/ForwardDialer/Dialer/AddCall
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
| Target | Call target destination phone number. Must be sent with the international prefix (for Israel destinations not mandatory). | String | Mandatory |
| CustomerName | Call target destination name. | String | Optional |
| CallerID | The phone number that will be display to the destination. Must be phone number in your Voicenter account. | String | Optional |
| Priority | Call target with higher priority values will dial before lower ones. | Integer | Optional |
| CustomData | You may set your own fields and values that will be associated with each call target destination. This data can be used for pop up and call log. | Array | Optional |
| OriginateTime | You can set calls to be dial at future date. EPOCH time format. In case this field is not sent in the request, the call will dial as soon as possible. Must be send together with "IsDateLocal" field. | Integer | Optional |
| IsDateLocal | Whether the future call date will be in local time as set in the Voicenter Cpanel. In case "false" value was set, the call will be dialed at GMT 0. It is recommended to send "true” value. Must be send together with "OriginateTime" field. | Boolean | Optional |
| IgnoreDncStatus | In case you activated Voicenter Do-Not-Call-Me service, a service that checks whether to allow calling Israeli destinations, by adding this field to your Auto-Dialer service requests, you will be allowed to make calls to restricted destinations. | Boolean | Optional |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/AddCall?Campaign=XXXXXXXXXXXXXXXXXXXXX&Target=0501234567&CustomerName=JohnDoe&Priority=42&var_leadID=1234567
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567",
"CustomerName": "John Doe",
"CallerID": "0722776772",
"Priority": 42,
"OriginateTime": 1602750000,
"IsDateLocal": "true",
"IgnoreDncStatus": "true",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "1" – Invalid campaign code. "2" – Target missing. "-2" – Number is invalid. | Integer |
| Description | Response status description: "OK" – No errors. "Invalid campaign code" – The sent campaign identifier is invalid. "Campaign code missing" - The "Campaign" field is mandatory. "Target missing" – The "Target" field is mandatory. "Number is invalid" – The "Target" format is invalid or missing. | String |
Voicenter Response Example
[
]
AddCallsBulk
This method allows you to add multiple destinations to a campaign.
URI
https://api.voicenter.com/ForwardDialer/Dialer/AddCallsBulk
Limits
- Up to 100,000 destinations can be sent in a single request.
- When sending up to 3,000 destinations, the response message will contain a detailed output for each destination that was sent(like in the response message below). Beyond this amount, a general response answer will be sent.
Acceptable Request Types
1. POST-JSON
Possible Response Formats
1. POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, by GetCampaignList (7.1) method. | String | Mandatory |
| Target | Call target destination phone number. Must be sent with the international prefix (for Israel destinations not mandatory). | String | Mandatory |
| CustomerName | Call target destination name. | String | Optional |
| CallerID | The phone number that will be display to the destination. Must be phone number in your Voicenter account. | String | Optional |
| Priority | Call target with higher priority values will dial before lower ones. | Integer | Optional |
| CustomData | You may set your own fields and values that will be associated with each call target destination. This data can be used for pop up and call log. | Array | Optional |
| OriginateTime | You can set calls to be dial at future date. EPOCH time format. In case this field is not sent in the request, the call will dial as soon as possible. Must be sent together with the "IsDateLocal" field. | Integer | Optional |
| IsDateLocal | Whether the future call date will be in local time as set in the Voicenter Cpanel. In case "false" value was set, the call will be dialed at GMT 0. It is recommended to send "true” value. Must be sent together with the "OriginateTime" field. | Boolean | Optional |
| IgnoreDncStatus | In case you activated Voicenter Do-Not-Call-Me service, a service that checks whether to allow calling Israeli destinations, by adding this field to your Auto-Dialer service requests, you will be allowed to make calls to restricted destinations. | Boolean | Optional |
| async | We return a detailed response answer for each destination sent up to an amount of 3,000 destinations per call. Beyond the aforementioned amount, the service returns a general response and does not specify. If a true value is passed in this field, the system will not allow sending an amount exceeding 3,000 destinations. In other words, the service is required to return a detailed response. | Boolean | Optional |
Client Request Example (POST - JSON)
[
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567",
"CustomerName": "John Doe",
"CallerID": "0722776772",
"Priority": 42,
"OriginateTime": 1602750000,
"IsDateLocal": "true",
"IgnoreDncStatus": "true",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234568"
}
]
Voicenter Response Parameters
| Field name | Description | Type |
| AddResult | A list of all the sent calls destinations in the client request and their upload confirmation results. | Array |
| Target | The sent call destination in the client request. | String |
| ErrorCode | Response status: "0" – No errors. "1" – Invalid campaign code. "2" – Target missing. "-2" – Number is invalid. | Integer |
| Description | Response status description: "OK" – No errors. "Invalid campaign code" – The sent campaign identifier is invalid. "Campaign code missing" - The "Campaign" field is mandatory. "Target missing" – The "Target" field is mandatory. "Number is invalid" – The "Target" format is invalid or missing. | String |
| CustomData | The sent costume data in the client request. JSON array. | Array |
Voicenter Response Example
{
"AddResult":
[
{
"Target": "0501234567",
"ErrorCode": 0,
"Description": "OK",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
{
"Target": "0501234568",
"ErrorCode": 0,
"Description": "OK",
"CustomData":
{
}
}
]
"ErrorCode": 0,
"Description": "OK"
}
RemoveCall
You can use this method to remove a destination from a campaign.
URI
https://api.voicenter.com/ForwardDialer/Dialer/RemoveCall
Acceptable Request Types
1.POST-JSON
2. GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
| Target | Call target destination phone number you wish to remove. Must be sent with the international prefix (for Israel destinations not mandatory). | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/RemoveCall?Campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Target=0501234567
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "1" – Invalid campaign code. "2" – Target missing. | Integer |
| Description | Response status description: "OK" – No errors. "Invalid campaign code" – The sent campaign identifier is invalid. "Campaign code missing" - The "Campaign" field is mandatory. "Target missing" – The "Target" field is mandatory. | String |
Voicenter Response Example
{
"ErrorCode": 0,
"Description": "OK"
}
*Important.
In case the "Target" value that was sent in the client request does not exist in the campaign, the response
will still be "OK". It will just not remove any call destination.
In case the campaign has duplicate calls destinations, it will remove all duplicates targets.
ClearCampaignCalls
This method removes all calls destination from a campaign.
Totally clear a campaign from all its records.
URI
https://api.voicenter.com/ForwardDialer/Dialer/ClearCampaignCalls
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/ClearCampaignCalls?Campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Integer |
| ErrorCode | Response status: "0" – No errors. "4" – Invalid campaign code. | Integer |
| Description | Response status description: "OK" – No errors. "Internal error occurred." – The sent campaign identifier is invalid. | String |
Voicenter Response Example
{
"ErrorCode": 0,
"Description": "OK"
}
GetMembersList
Returns all the representatives that were listed to make calls in a campaign.
This method is only relevant for campaign type – "Agent Dialer".
URI
https://api.voicenter.com/ForwardDialer/Dialer/GetMembersList
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/GetMembersList?Campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. | Integer |
| Description | Response status description: "OK" – No errors. | String |
| Data | JSON array type. List of the members in a campaign. | Array |
| DisplayName | Voicenter extension name. | String |
| Member | Voicenter extension unique identifier. Extension SIP code. | String |
Voicenter Response Example
{
"Data":
[
{
"Member": "SIPSIP1",
"DisplayName": "Walter Melon"
}
{
"Member": "SIPSIP2",
"DisplayName": "John Doe"
}
]
"ErrorCode": 0,
"Description": "OK"
}
AddMember
This method allows you to add an agent to a campaign.
This method is only relevant for campaign type – "Agent Dialer".
URI
https://api.voicenter.com/ForwardDialer/Dialer/AddMember
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
| Member | Voicenter extension unique identifier. Extension SIP code. | String | Mandatory |
Client Request Example (GET)
1
2
https://api.voicenter.com/ForwardDialer/Dialer/AddMember?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&member=SIPSIP1
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXX",
"Member": "SIP1SIP1"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "2" – An issue with the Member value that was sent.. | Integer |
| Description | Response status description: "OK" – No errors. "Member Missing" – The "Member" field is mandatory. | String |
| Data | JSON array type. | Array |
| TotalAdded | The amount of added members to a campaign. In case, the value is "-1" – the action was not successful. The sent member was not added. | Integer |
Voicenter Response Example
{
"Data":
{
"TotalAdded": 2
}
"ErrorCode": 0,
"Description": "OK"
}
RemoveMember
This method allows you to remove an agent from a campaign.
This method is only relevant for campaign type – "Agent Dialer".
URI
https://api.voicenter.com/ForwardDialer/Dialer/RemoveMember
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
| Member | Voicenter extension unique identifier. Extension SIP code. | String | Mandatory |
Client Request Example (GET)
1
2
https://api.voicenter.com/ForwardDialer/Dialer/RemoveMember?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&member=SIPSIP1
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXX",
"Member": "SIP1SIP1"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "2" – An issue with the Member value that was sent. | Integer |
| Description | Response status description: "OK" – No errors. "Member Missing" – The "Member" field is mandatory. | String |
| Data | JSON array type. | Array |
| TotalRemoved | The amount of removed members from a campaign. In case, the value is "0" – the action was not successful. The sent member was not removed. | Integer |
Voicenter Response Example
{
"Data":
{
"TotalRemoved": 2
}
"ErrorCode": 0,
"Description": "OK"
}
StopCampaign
Pausing an active campaign from dialing to it's destinations.
URI
https://api.voicenter.com/ForwardDialer/Dialer/StopCampaign
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by Voicenter or by GetCampaignList (7.1) method. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/StopCampaign?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "1" – An issue with the Campaign value that was sent. | Integer |
| Description | Response status description: "OK" – No errors. "Invalid campaign code" – An issue with the Campaign value that was sent. | String |
Voicenter Response Example
{
"ErrorCode": 1,
"Description": "Invalid campaign code"
}
StartCampaign
If a campaign is currently paused, this action will resume it to dial to the destinations.
URI
https://api.voicenter.com/ForwardDialer/Dialer/StartCampaign
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/StartCampaign?campaign=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "1" – An issue with the Campaign value that was sent. | Integer |
| Description | Response status description: "OK" – No errors. "Invalid campaign code" – An issue with the Campaign value that was sent. | String |
Voicenter Response Example
{
"ErrorCode": 1,
"Description": "Invalid campaign code"
}
GetCampaignPendingCalls
Returns a list of all waiting to be dialed calls destinations.
URI
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignPendingCalls
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Personal identifier, provided by Voicenter. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignPendingCalls?Campaign=XXXXXXXXXXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. "2" – An issue with the Campaign value that was sent. | Integer |
| Description | Response status description: "OK" – No errors. "Internal error occured" – An issue with the Campaign value that was sent. | String |
| Data | JSON array type. Contains: 1. Campaign – General data. 2. Calls - List of the waited to be dialed calls | Array |
| Campaign | JSON array type. The campaign general data. | Array |
| Name | The Voicenter campaign name. | String |
| StatusName | Campaign status: "Enabled" – Active campaign. "Disabled" – Stopped campaign. | String |
| TotalPendingCalls | The sum of waiting records destinations to be dial. | Integer |
| MaxPriority | Returns the highest priority value that was set for a call destination record in the campaign. | Integer |
| MinPriority | Returns the lowest priority value that was set for a call destination record in the campaign. | Integer |
| TotalAwaitingCalls | Relevant only for IVR dialer campaigns. The sum of waiting records destinations to be dial at the IVR dialer service. This field is more recommended to use then "TotalPendingCalls" for IVR dialer campaign. In case of agent dialer campaign the returned value will be "null". | Integer |
| Code | The campaign unique identifier code. Needed for the auto dialer API methods. | String |
| Calls | JSON array type. List of the waited to be dialed calls. | Array |
| Phone | Call target destination phone number. Must be sent with the international prefix (for Israel destinations not mandatory). | String |
| CustomerName | Call target destination name. | String |
| CallerID | The phone number that will be display to the destination. Must be phone number in your Voicenter account. This field will display value only if this data was sent via API request. | String |
| Priority | Call target with higher priority values will dial before lower ones. | Integer |
| CustomData | You may set your own fields and values that will be associated with each call target destination. This data can be used for pop up and call log. | Array |
| OriginateTime | You can set calls to be dial at future date. EPOCH time format. In case this field is not sent in the request, the call will dial as soon as possible. Must be send together with "IsDateLocal" field. | Integer |
| IsDateLocal | Whether the future call date will be in local time as set in the Voicenter Cpanel. In case "false" value was set, the call will be dialed at GMT 0. It is recommended to send "true” value. Must be send together with "OriginateTime" field. | Boolean |
| CallStatus | JSON array type. The status of the waited to be dialed call. | Array |
| Status | "1" – A call pending to be dial. | Integer |
| Description | "Pending" - A call pending to be dial. | String |
Voicenter Response Example
{
"Data":
{
"Calls":
[
{
"Phone": "972525599100",
"CallerID": "",
"CallerName": "",
"OriginateTime": 1602819000,
"Priority": 42,
"CustomerName": "John Doe",
"CallStatus":
{
"Status": 1,
"Description": "Pending"
}
"CustomData":
{
"var_test1": "1",
"var_test2": "some value"
}
}
{
"Phone": "972525599100",
"CallerID": "",
"CallerName": "",
"OriginateTime": 1602755000,
"Priority": 42,
"CustomerName": "John Doe",
"CallStatus":
{
"Status": 2,
"Description": "Originated"
}
"CustomData":
{
"var_test1": "1",
"var_test2": "some value"
}
}
]
"Campaign":
{
"Name": "Campaign2",
"StatusName": "Enabled",
"TotalPendingCalls": 4,
"TotalOriginatedCalls": 0,
"MaxPriority": 42,
"MinPriority": 42,
"TotalAwaitingCalls": -1,
"Code": "jngqka31F7n1ujPZbOeEJsMzfVaoU2jp"
}
}
"ErrorCode": 0,
"Description": "OK"
}
UpdateCall
Will update an existing call target destination.
*In case call target does not exist in the campaign, it will add it (AddCall method 6.2).
URI
https://api.voicenter.com/ForwardDialer/Dialer/UpdateCall
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
| Target | Call target destination phone number. Must be sent with the international prefix (for Israel destinations not mandatory). | String | Mandatory |
| CustomerName | Call target destination name. | String | Optional |
| CallerID | The phone number that will be display to the destination. Must be phone number in your Voicenter account. | String | Optional |
| Priority | Call target with higher priority values will dial before lower ones. | Integer | Optional |
| CustomData | You may set your own fields and values that will be associated with each call target destination. This data can be used for pop up and call log. | Array | Optional |
| OriginateTime | You can set calls to be dial at future date. EPOCH time format. In case this field is not sent in the request, the call will dial as soon as possible. Must be send together with "IsDateLocal" field. | Integer | Optional |
| IsDateLocal | Whether the future call date will be in local time as set in the Voicenter Cpanel. In case "false" value was set, the call will be dialed at GMT 0. It is recommended to send "true” value. Must be send together with "OriginateTime" field. | Boolean | Integer |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/UpdateCall?Campaign=XXXXXXXXXXXXXXXXXXXXX&Target=0501234567&CustomerName=John Doe&Priority=42&var_leadID=1234567
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Target": "0501234567",
"CustomerName": "John Doe",
"CallerID": "0722776772",
"Priority": 42,
"OriginateTime": 1602750000,
"IsDateLocal": "true",
"CustomData":
{
"var_LeadID": 1234567,
"var_LeadCampaign": "Facebook"
}
}
Voicenter Response Parameters
| Field name | Description | Integer |
| ErrorCode | Response status: "0" – No errors. "1" – Invalid campaign code. "2" – Target missing. "-2" – Number is invalid. | Integer |
| Description | Response status description: "OK" – No errors. "Invalid campaign code" – The sent campaign identifier is invalid. "Campaign code missing" - The "Campaign" field is mandatory. "Target missing" – The "Target" field is mandatory. "Number is invalid" – The "Target" format is invalid or missing. | String |
Voicenter Response Example
{
"ErrorCode": 0,
"Description": "OK"
}
GetCampaignDetails
Returns details for requested campaign.
URI
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignDetails
Acceptable Request Types
1.POST-JSON
2.GET
Possible Response Formats
1.POST-JSON
Client Request Parameters
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
Client Request Example (GET)
1
https://api.voicenter.com/ForwardDialer/Dialer/GetCampaignDetails?Campaign=XXXXXXXXXXXXXXXXXXXXX
Client Request Example (POST - JSON)
{
"Campaign": "XXXXXXXXXXXXXXXXXXXXX"
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. | Integer |
| Description | Response status description: "OK" – No errors. | String |
| Data | JSON array type. List of the requested automatic dialer campaigns. | Array |
| Name | The Voicenter campaign name. | String |
| StatusName | Campaign status: "Enabled" – Active campaign. "Disabled" – Stopped campaign. | String |
| TotalPendingCalls | The sum of waiting records destinations to be dial. | Integer |
| MaxPriority | Returns the highest priority value that was set for a call destination record in the campaign. | Integer |
| MinPriority | Returns the lowest priority value that was set for a call destination record in the campaign. | Integer |
| TotalAwaitingCalls | Relevant only for IVR dialer campaigns. The sum of waiting records destinations to be dial at the IVR dialer service. This field is more recommended to use then "TotalPendingCalls" for IVR dialer campaign. In case of agent dialer campaign the returned value will be "-1". | Integer |
| Code | The campaign unique identifier code. Needed for the auto dialer API methods. | String |
Voicenter Response Example
{
"Data":
{
"Name": "Campaign1",
"StatusName": "Enabled",
"TotalPendingCalls": 23,
"MaxPriority": 1,
"MinPriority": 1,
"TotalAwaitingCalls": 23,
"Code": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
"ErrorCode": 0,
"Description": "OK"
}
| Field name | Description | Type | Remarks |
| Campaign | Campaign unique identifier, provided by GetCampaignList (7.1) method. | String | Mandatory |
| setQueueForMonitoring | Queue unique identifier. Can be found in the "Queues" section in the Cpanel. | Integer | Mandatory |
| setQueueMaximumCallers | Maximum amount of waiting calls in the selected queue. Value must be greater than "0". | Integer | Mandatory |
| setCoefficient | The campaign dialing call rate coefficient value. Value must be greater than "1". | Integer | Mandatory |
{
"Campaign": "xxxxxxxxxxxxxxxxxxxx",
"setQueueForMonitoring": 123456789,
"setQueueMaximumCallers": 1,
"setCoefficient": 2
}
Voicenter Response Parameters
| Field name | Description | Type |
| ErrorCode | Response status: "0" – No errors. | Integer |
| Description | Response status description: "OK" – No errors. | String |
Voicenter Response Example
{
"ErrorCode": 0,
"Description": "OK"
}