...
Code Block | ||
---|---|---|
| ||
{
"api-version": "1.0",
"security-id": "<64 character alphanumeric>",
"flow-id": "<8 character alphanumeric>",
"calls": [
{
"client-identifier": "<identifier, callback parameter>",
"start-time": "2021-04-28T03:48:07.111+05:30",
"contact-numbers": [
"918000XXXXXX",
"918100XXXXXX",
],
"keys": [
{
"name": "$flow.key.Name",
"value": "Abhinandan"
},
{
"name": "$flow.key.Language",
"value": "English"
}
]
}
]
} |
...
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 character alpha numeric Flow ID from the ‘Edit Flow’ page of any Outbound Flowcalls
: Array. Each element in 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 is2021YYYY-04MM-28T03DDTHH:48MM:07.111SS+05:30
. Date cannot be of past. If time is of past (and 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 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.
...