Page Comparison

...

URL

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

Method

Status

colour	Green
title	POST

Body

JSON

Headers

Content-Type: application/json

Auth

None

Payload Schema:

Code Block

language	json

{
	"api-version": "1<1.0 or TEST>",
	"security-id": "<64 character alphanumeric>",
	"flow-id": "<8 character alphanumeric>",
	"calls": [
		{
			"client-identifier": "<identifier, callback parameter>",
			"start-time": "2021-04-28T03:48:07<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

Code Block

language	json

{
	"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:

...

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
: Security ID is invalid. Please check the end point and security ID.
Invalid Flow ID
Status
colour Yellow
title 301
: Flow ID is invalid. Please check the end point and Flow ID.
Failure
Status
colour Red
title 500
: Any Failure scenario.

3. All Error Codes:

	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

Other Docs:

Todo: https://docs.google.com/document/d/1A5UciLQYB6hS7VwKjazU204IxMwlfD_KwSnexlkaa8Y/edit#
Tech API Docs: /wiki/spaces/CB/pages/201752979
Todo, add Security: /wiki/spaces/CB/pages/209224413

Versions Compared

Old Version 8

New Version 9

Key

Other Docs:

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