...
URL | https://central-api.phonon.io/kairos-apis/outbound/create OR | ||||||
---|---|---|---|---|---|---|---|
Method |
| ||||||
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 | ||
---|---|---|
| ||
{ "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 } ] } |
...
api-version
: Use1.0
to use the
. This is fixed value.Status colour Blue title In production security-id
: Get the security ID from the ‘Edit Flow’ page of any Outbound Flowflow-id
: Get the 8 characters' alphanumeric Flow ID from the ‘Edit Flow’ page of any Outbound Flowcalls
: Array. Each element in the array represents one callrequest. You can have up to 500 calls requests in one request.client-identifier
: Callback variable to uniquely represent this request.start-time
: ISO-8601 Timestamp. The format isYYYY-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.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.keys
: Array of Flow Variables. There’s no limit on how many flow variables can be provided."name": "$flow.key.<variable>"
: Name of flow variable."value": "Abhinandan"
: Value of the above flow variable.
...
b. Phonon UUID: Unique Identifier for each callrequest.
2. Important Error Response:
...