Page Comparison

Dialer Make Call API

Use this API to initiate a Dialer Flow requestRequest.

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

Request Parameters:

...

...

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"
				}
			]
		}
	]
}

...

1. api-version: Use 1.0 to use the

   Status
   colour Blue title In production

   or TEST to use the

   Status
   colour Yellow title In Testing

   version of the outbound flow.

2. security-id: Get the security ID from the ‘Edit Flow’ page of any Outbound Flow

3. flow-id: Get the 8 characters alphanumeric Flow ID from the ‘Edit Flow’ page of any Outbound Dialer Flow

4. 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 of from the past. If time is of 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 calling 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:

1. Successful Response:
   Status Code:

   Status
   colour Green title 200

   Code Block
   language json
   { "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" } ] }

...

1. IP Not Whitelisted

   Status
   colour Blue title 401

   : Please whitelist your IP in the Whitelist section.

2. Checksum Repeated

   Status
   colour Yellow title 201

   : You can trigger the same API payload more than once. Please change at - least one parameter. (Date-time, client-identifier, etc.)

3. Invalid Security ID

   Status
   colour Yellow title 202

   : The Security ID Id is invalid. Please check the end point endpoint and security ID.

4. Invalid Flow ID

   Status
   colour Yellow title 301

   : Flow ID is invalid. Please check the end point endpoint and Flow ID.

5. Failure

   Status
   colour Red title 500

   : Any Failure scenario.

3. All Error Codes: