Page Comparison

...

The Central Outbound Multicast API allows you to send outbound communications to your customers on single or multiple channels including Calls, SMS and Email, WhatsApp.

The API will log a request in one of the workflows created in your admin account. The request will be picked subsequently and executed.

...

For Bulk Requests - Where you need high through-put or uploading a large data.
1. API End Point: https://central-api.phonon.io/kairos-apis/outbound/create
2. Rate Limit: 30k per minute
For Real Time Requests - Low through-put but instant connect and faster response.
1. API End Point: https://central.phonon.io/kairos-apis/outbound/create
2. Rate Limit: 500 per minute

Info
Note : There is a 256KB limit on the API request body. In case a request is received which has a message body of size greater than 256 KB, the system will not process such a request.

Request Parameters:

URL

https://central-api.phonon.io/kairos-apis/outbound/create OR

https://central.phonon.io/kairos-apis/outbound/create

Method

Status

colour	Green
title	POST

Body

JSON

Headers

Content-Type: application/json

Auth

None

Info
contact-numbers is a mandatory field, and hence, if you’re sending just an E-mail, configure a dummy number as the value.

Payload Schema:

Code Block

language	json

{
	"api-version": "1.0", // Fixed
	"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
		}
	]
}

...

Request Parameters Explanation:

Parameter

Type

Var Type

Description

Sample Value

api-version

Mandatory

String

Use 1.0 to use the

Status

colour	Blue
title	In production

. This is fixed value.

1.0

security-id

Mandatory

String

64 character alphanumeric. Get the security ID from the ‘Edit Flow’ page of any Outbound Flow

a0095e7ac42205cb1388d7ac0d2db4afad1b5b2304907a27a6154bf93253088c

flow-id

Mandatory

String

Decides which Workflow the request needs to be logged. 8 character alphanumeric Flow ID. Get the Flow ID from the ‘Edit Flow’ page of any Outbound Flow

wruHzoCK

calls

Mandatory

Array

Array of call object. Each object will add one request. Maximum 10,000 records in one API call.

[{…},{…}]

calls[0].client-identifier

Mandatory

Any

Callback variable. You’ll get the same value back in response.

Any

calls[0].start-time

Optional

Datetime

ISO-8601 Timestamp. The format is YYYY-MM-DDTHH:MM:SS+05:30. The date cannot be from the past. If the time is of past (and the date is today) the flow will be initiated immediately.

If you omit it, the request will be executed immediately when picked up.

2021-06-29T09:42:00+05:30

calls[0].contact-numbers

Mandatory

Array

Array of comma separated contact number. Must have at least one. Contact number can be string or number.

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.

Prefer to keep mobile number as E.164 format. If 10 digits are provided, it defaults to India.

+916262772728

916262772728

6262772728

calls[0].keys

Mandatory

Array

Array of Flow Variables. There’s no limit on how many flow variables can be provided.

[]

keys[0].name

Optional

String

Name of flow variable.

"$flow.key.variable"

keys[0].value

Optional

String

Value of the above flow variable.

"Abhinandan"

As text:

api-version: Use 1.0 to use the
Status
colour Blue
title In production
. This is fixed value.
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 Outbound Flow
calls: Array. Each element in the array represents one callrequest. You can have up to 500 calls requests in one request.
1. client-identifier: Callback variable to uniquely represent this request.
2. start-time: ISO-8601 Timestamp. The format is YYYY-MM-DDTHH:MM:SS+05:30. The date cannot be from the past. If the 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 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": "Abhinandan": Value of the above flow variable.

...

b. Phonon UUID: Unique Identifier for each callrequest.

2. Important Error Response:

...

IP Not Whitelisted
Status
colour Blue
title 401
: Please whitelist your IP in the Whitelist section.
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.)
Invalid Security ID
Status
colour Yellow
title 202
: The security ID is invalid. Please check the endpoint and security ID.
Invalid Flow ID
Status
colour Yellow
title 301
: Flow ID is invalid. Please check the endpoint and Flow ID.
Failure
Status
colour Red
title 500
: Any Failure scenario.

3. All Error Codes:

INVALID_SECURITY_ID

	Status Code	Status Message	Status Codename
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

Message Accepted	SUCCESS
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

FAQs:

How to get the status of the request?

...

Versions Compared

Old Version 14

New Version Current

Key

Request Parameters:

FAQs:

How to get the status of the request?