...
Use this API to initiate an Outbound Flow request.
Before sending a request, make sure to whitelist your the IP through which you are sending send the API request in the whitelist section.
...
api-version: Use 1.0 to use the
| Status |
|---|
| colour | Blue |
|---|
| title | In production |
|---|
|
or TEST to use the | Status |
|---|
| colour | Yellow |
|---|
| title | In Testing |
|---|
|
version of the outbound flow.security-id: Get the security ID from the ‘Edit Flow’ page of any Outbound Flow
flow-id: Get the 8 character alpha numeric characters' alphanumeric Flow ID from the ‘Edit Flow’ page of any Outbound Flow
calls: 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. Format The format is YYYY-MM-DDTHH:MM:SS+05:30. Date The date cannot be of 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 calling 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.
...
IP Not Whitelisted
: Please whitelist your IP in the Whitelist section.Checksum Repeated
: You can trigger the same API payload more than once. Please change at - least one parameter. (Date-time, client-identifier, etc.)Invalid Security ID
: Security The security ID is invalid. Please check the end point endpoint and security ID.Invalid Flow ID
: Flow ID is invalid. Please check the end point endpoint and Flow ID.Failure
: Any Failure scenario.
...