Parameter | Type | Description | Sample |
uid | String | unique id of call | s4.1231221asd31e13 |
node_id |
String | Node id shown in the callflow page as shown in image below |
1a18f23cf93c4c15958779042f |
timestamp |
Integer | current timestamp value in seconds |
1585631149 |
clid |
String | formatted caller id(if caller id received by myoperator
as 08527384897 or 918527384897 then 8527384897 will be sent) |
8527384897 |
input |
Integer | input provided by the
caller(if any) |
15 |
Key | Example Values | Type | Description | Required |
Target URL |
https://example.com |
string | Your site URL which
needs to provide response |
yes |
Header |
["Content-Type: application/json","header key:value"] |
string | Headers which you want to be sent by us to
given URL - NOTE: Default content type is
application/x-www- form-urlencoded |
no |
Credential |
{ "username": "abc", "password": "abc" } |
string (JSON) | BASIC Auth username and password to be sent for
the given request |
no |
Key | Possible Values | Type | Description | Required |
action |
|
string | action to be performed |
yes |
|
tts |
string | Play from Text To Speech |
|
| url | string | Play from URL |
|
value |
|
string | data for action . could be a text for action:tts or file url for action:url |
yes |
operation |
|
string | followup action to be performed after action |
|
| hangup | string | hang up the call |
|
| dial-users | string | dial the users |
|
|
dial-numbers |
string | dial numbers ( anonymous case ) |
|
| jump-node | string | jump to another node |
|
operation-data |
{depends on operation} |
{depends on operation} | data required by operation . See table below for possible scenarios | |
Operation | Operation-data key | Type | Description |
hangup | {not required} |
|
|
dial-users | data | list | list of user ids to be dialed |
dial-users |
dial_method |
string | dial method to use in case
of multiple users |
dial-numbers | data | list | list of numbers to be dialed |
dial-numbers |
dial_method |
string | dial method to use in case
of multiple users |
dial-numbers |
anon_uuid |
string | uuid of anonymous user if configured |
jump-node |
node_id |
string | node id of the node to process next |
{ "action": "tts", "value": "welcome to company ABC" } |
{ "action": "url", "value": "http://myurl.com/file.mp3" } |
{ "action": "tts", "value": "welcome to company ABC", "operation": "jump-node", "operation_data":{ "node_id":"5d26dd68ee5ed818" } } |
{ "action": "tts", "value": "I will be played but users will be dialed", "operation": "dial-users", "operation_data": { "data": ["5d10680d44bc1498", "5784e85138748421"], "dial_method": "serial" } } |
{ "action": "tts", "value": "", "operation": "dial-users", "operation_data": { "data": ["5d10680d44bc1498", "5784e85138748421"], "dial_method": "serial" } } |
{ "action": "tts", "value": "I will be played but call will hangup immediately", "operation": "hangup" } |
{ "action": "tts", "value": "I will be played but users will be dialed", "operation": "dial-numbers", "operation_data": { "data": ["91-9212992129", "1-2019424084"], "dial_method": "serial", "anon_uuid" : "d0238udj923jd023dd32" } } |