...
IP Whitelisting: IP must be whitelisted in the admin account.
Checksum Check: Two request must have at-least one byte change in it. If two requests are same, you’ll get Checksum Repeated error.
Outbound
...
Create Request API
Use this API to initiate an Outbound Flow request. In your Outbound Multicast Flow, you can configure your flow containing Call, SMS, Email or any combination of the same!
Before sending a request, make sure to whitelist the IP through which you send the API request in the whitelist section.
Note |
---|
...
As of Jan, 2023, Bulk API Request end-point provides a different response. Please go through the notification for the same. It’s currently getting worked upon, and the document will get updated accordingly. Please refer to this notification for further details. |
For Bulk Requests - Where you need high through-put or uploading a large data.
API End Point: https://central-api.phonon.io/kairos-apis/outbound/create
Rate Limit: 30k per minute
For Real Time Calling Requests - Low through-put but instant connect and faster response.
API End Point: https://central.phonon.io/kairos-apis/outbound/create
Rate Limit: 3k 500 per minute
Request Parameters:
URL | https://central-api.phonon.io/kairos-apis/outbound/create OR | ||||||
---|---|---|---|---|---|---|---|
Method |
| ||||||
Body | JSON | ||||||
Headers | Content-Type: application/json | ||||||
Auth | None |
...
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 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 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.
...
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" } ] }
...