Outbound Dialer API Documentation

Dialer Make Call API

Use this API to initiate a Dialer Flow Request.

Before sending a request, make sure to whitelist the IP through which you send an API request in the whitelist section.

Request Parameters:

URL	https://central.phonon.io/kairos-apis/outbounddialer/create
Method	POST
Body	JSON
Headers	Content-Type: application/json
Auth	None

Payload:

{
	"api-version": "1.0",
	"security-id": "<64 character alphanumeric>",
	"flow-id": "<8 character alphanumeric>",
	"calls": [
		{
			"client-identifier": "<identifier, callback parameter>",
			"start-time": "2021-04-28T03:48:07.111Z+05:30", // ISO-8601 Timeformat
			"contact-numbers": [
				"918000XXXXXX", // Customer Numbers
				"918100XXXXXX", // Alternate customer number(s)
			],
			"keys": [
				{
					"name": "$flow.key.Name",
					"value": "Ankit Parihar"
				},
				{
					"name": "$flow.key.Language",
					"value": "English"
				}
			]
		}
	]
}

Request Parameters Explanation:

api-version: Use 1.0 to use the In production or TEST to use the In Testing version of the outbound flow.
security-id: Get the security ID from the ‘Edit Flow’ page of any Outbound Flow
flow-id: Get the 8 characters alphanumeric Flow ID from the ‘Edit Flow’ page of any Dialer Flow
calls: Array. Each element in the array represents one call. You can have up to 500 calls in one request.
1. client-identifier: Callback variable to uniquely represent this request.
2. start-time: ISO-8601 Timestamp. The date cannot be from the past. If time is past (and the date is today) the flow will be initiated immediately.
3. contact-numbers: Array. Mobile numbers of the customer. You can provide alternate numbers of a customer and calls will be initiated to each number until one is connected in one attempt.
4. keys: Array of Flow Variables. There’s no limit on how many flow variables can be provided.
  1. "name": "$flow.key.<variable>": Name of flow variable.
  2. "value": "Ankit": Value of the above flow variable.

Response:

Successful Response:
Status Code: 200
{ "api-response-code": 200, "api-response-message": "Success", "request-id": "c46e46f4-dc58-4839-9483-f7dd9aac28a0", "call-details": [ { "client-identifier": "2021-04-28T03:48:07.110Z", "phonon-uuid": "501c78ee-8d06-498e-8952-fce3495f326b" } ] }

a. Request ID: Unique Identifier for the whole request.

b. Phonon UUID: Unique Identifier for each call.

2. Important Error Response:

{
  "api-response-code": 500/401/201/202/301,
  "api-response-message": "Failure/IP Not Whitelisted/Checksum Repeated/Invalid Security ID/Invalid Flow ID",
}

IP Not Whitelisted 401: Please whitelist your IP in the Whitelist section.
Checksum Repeated 201: You can trigger the same API payload more than once. Please change at least one parameter. (Date-time, client-identifier, etc.)
Invalid Security ID 202: The Security Id is invalid. Please check the endpoint and security ID.
Invalid Flow ID 301: Flow ID is invalid. Please check the endpoint and Flow ID.
Failure 500: Any Failure scenario.

3. All Error Codes:

	Status Code	Status Message	Status Name

	Status Code	Status Message	Status Name
1	400	Invalid Format	INVALID_FORMAT
2	201	Checksum Repeated	CHECKSUM_REPEATED
3	302	Empty Call List	EMPTY_CALL_LIST
4	500	Failure	FAILURE
5	301	Invalid Flow ID	INVALID_FLOW_ID
6	401	IP Not Whitelisted	IP_NOT_WHITELISTED
7	402	Phone Not Whitelisted	PHONE_NOT_WHITELISTED
8	202	Invalid Security ID	INVALID_SECURITY_ID
9	200	Success	SUCCESS
10	203	API Version not Supported	INVALID_API_VERSION
11	204	Invalid SMS Gateway	INVALID_GATEWAY_ID
12	205	Invalid Contact Number	INVALID_CONTACT_NUMBER
13	206	Failure from Gateway	FAILURE_FROM_GATEWAY
14	207	DID Not Mapped	DID_NOT_MAPPED
15	208	No Mask Available	NO_MASK_AVAILABLE
16	209	Partial Success	PARTIAL_SUCCESS
17	210	Invalid Mandatory Parameters	INVALID_MANDATORY_PARAMETERS
18	303	Max Data List Size Exceeded	MAX_DATA_LIST_SIZE_EXCEEDED
19	211	Validity Expired	VALIDITY_EXPIRED
20	212	Insufficient Balance	INSUFFICIENT_BALANCE
21	304	Invalid Flow Version	INVALID_FLOW_VERSION
22	213	No Data Available	NO_DATA_AVAILABLE