Outbound Multicast API Documentation

Outbound Make Call API

Use this API to initiate an Outbound Flow request.

Before sending request, make sure to whitelist your IP through which you are sending API request in the whitelist section.

Request Parameters:

Payload Schema:

{
	"api-version": "<1.0 or TEST>",
	"security-id": "<64 character alphanumeric>",
	"flow-id": "<8 character alphanumeric>",
	"calls": [
		{
			"client-identifier": "<identifier, callback parameter>",
			"start-time": "<ISO-8601 Format YYYY-MM-DDTHH:MM:SS+05:30",
			"contact-numbers": [
				"918000XXXXXX",
				"918100XXXXXX",
				"<Other Alternate Numbers>"
			],
			"keys": [
				{
					"name": "$flow.key.Name",
					"value": "Abhinandan"
				},
				{
					"name": "$flow.key.Language",
					"value": "English"
				},
				{
					// Other flow variables
				}
			]
		},
		{
			// 2nd Call to be place
		}
	]
}

Sample Payload

{
	"api-version": "1.0",
	"security-id": "a0095e7ac42205cb1388d7ac0d2db4afad1b5b2304907a27a6154bf93253088c",
	"flow-id": "wruHzoCK",
	"calls": [
		{
			"client-identifier": "AcmeBankCampaign_001",
			"start-time": "2021-06-29T09:42:00+05:30",
			"contact-numbers": [
				"916262772728"
			],
			"keys": [
				{
					"name": "$flow.key.LeadID",
					"value": "130586000000165414"
				},
				{
					"name": "$flow.key.token",
					"value": "English"
				}
			]
		}
	]
}

Request Parameters Explanation:

1. api-version: Use 1.0 to use the IN PRODUCTION or TEST to use the 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 character alpha numeric Flow ID from the ‘Edit Flow’ page of any Outbound Flow

4. calls: Array. Each element in 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. Format is YYYY-MM-DDTHH:MM:SS+05:30. Date cannot be of past. If time is of past (and 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 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": "Abhinandan": Value of the above flow variable.

Response:

1. 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",
}

1. IP Not Whitelisted 401 : Please whitelist your IP in the Whitelist section.

2. Checksum Repeated 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 202 : Security ID is invalid. Please check the end point and security ID.

4. Invalid Flow ID 301 : Flow ID is invalid. Please check the end point and Flow ID.

5. Failure 500 : Any Failure scenario.

3. All Error Codes:

Other Docs:

1. Todo: https://docs.google.com/document/d/1A5UciLQYB6hS7VwKjazU204IxMwlfD_KwSnexlkaa8Y/edit#

2. Tech API Docs: /wiki/spaces/CB/pages/201752979

3. Todo, add Security: /wiki/spaces/CB/pages/209224413

_{P.S.: There’s an easter egg hidden here. Did you find it?}