Dialer Make Call API
Use this API to initiate a Dialer Flow request.
...
API URL: https://central.phonon.in/kairos-apis/outbounddialer/create
Request Parameters:
Method |
| ||||||
---|---|---|---|---|---|---|---|
Body | JSON | ||||||
Headers | Content-Type: application/json | ||||||
Auth | None |
...
api-version
: Use1.0
to use the
orStatus colour Blue title In production TEST
to use the
version of the outbound flow.Status colour Yellow title In Testing 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 Dialer Flowcalls
: Array. Each element in the array represents one call. You can have up to 500 calls in one request.client-identifier
: Callback variable to uniquely represent this request.start-time
: ISO-8601 Timestamp. The date cannot be of past. If time is 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": "Ankit"
: Value of the above flow variable.
Response:
Successful Response:
Status Code:Status colour Green title 200 Code Block language json { "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" } ] }
...