Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL

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

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

Method

Status
colourGreen
titlePOST

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

...

  1. api-version: Use 1.0 to use the

    Status
    colourBlue
    titleIn production
    . This is fixed value.

  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 Flow

  4. 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:

...