Request, cURL & Response Payloads
73 min
Endpoint (All Actions)
POST
/v2/accounts/{account_sid}/legs/{leg_sid}/actions
Full URL
https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions
Authentication
Authorization: Basic <BASE64_APIKEY_APITOKEN>
Content-Type: application/json
<Answer>
Request Payload
{
"action_custom_param": "answer_call",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Answer></Answer></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "answer_call",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Answer></Answer></Flow>"
}'
<Dial>
Request Parameters
Attribute | Required | Description |
|---|---|---|
contactUri | Yes | Destination number or SIP URI |
exophone | Yes | Caller ID |
networkType | No | pstn or voip |
absorbDtmf | No | Absorb DTMF during dial |
Request Payload
{
"action_custom_param": "test_dial",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Dial contactUri=\"9791111865\" exophone=\"02048566335\" networkType=\"pstn\" absorbDtmf=\"true\"></Dial></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "test_dial",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Dial contactUri=\"9791111865\" exophone=\"02048566335\" networkType=\"pstn\" absorbDtmf=\"true\"></Dial></Flow>"
}'
<Gather>
Request Parameters
Attribute | Required | Description |
|---|---|---|
numDigits | No | Number of digits to collect |
timeoutInSec | No | Timeout duration |
finishOnKey | No | Key to terminate input |
Request Payload
{
"action_custom_param": "collect_digits",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Gather numDigits=\"4\" timeoutInSec=\"10\" finishOnKey=\"#\"></Gather></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "collect_digits",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Gather numDigits=\"4\" timeoutInSec=\"10\" finishOnKey=\"#\"></Gather></Flow>"
}'
<Hangup>
Request Payload
{
"action_custom_param": "hangup_call",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Hangup></Hangup></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "hangup_call",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Hangup></Hangup></Flow>"
}'
<Hold>
Request Payload
{
"action_custom_param": "hold_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Hold></Hold></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "hold_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Hold></Hold></Flow>"
}'
<JoinBridge>
Request Parameters
Attribute | Required | Description |
|---|---|---|
bridgeSid | Yes | Bridge identifier |
absorbDtmf | No | Absorb DTMF |
Request Payload
{
"action_custom_param": "join_bridge",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><JoinBridge bridgeSid=\"BRIDGE_SID\" absorbDtmf=\"true\"></JoinBridge></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "join_bridge",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><JoinBridge bridgeSid=\"BRIDGE_SID\" absorbDtmf=\"true\"></JoinBridge></Flow>"
}'
<LeaveBridge>
Request Payload
{
"action_custom_param": "leave_bridge",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><LeaveBridge></LeaveBridge></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "leave_bridge",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><LeaveBridge></LeaveBridge></Flow>"
}'
<Mute> / <UnMute>
Request Parameters
Attribute | Required | Description |
|---|---|---|
direction | No | in, out, both |
Request Payload
{
"action_custom_param": "mute_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Mute direction=\"out\"></Mute></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "mute_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Mute direction=\"out\"></Mute></Flow>"
}'
<PlaySequence>
Request Parameters
Nested media actions only.
Request Payload
{
"action_custom_param": "play_sequence",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><PlaySequence><StartPlay>https://example.com/audio.wav</StartPlay><Say>Hello</Say></PlaySequence></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "play_sequence",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><PlaySequence><StartPlay>https://example.com/audio.wav</StartPlay><Say>Hello</Say></PlaySequence></Flow>"
}'
<Refer>
Request Parameters
Attribute | Required | Description |
|---|---|---|
legEventEndpoint | Yes | gRPC endpoint |
Request Payload
{
"action_custom_param": "refer_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Refer legEventEndpoint=\"grpc://host:port\"></Refer></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "refer_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Refer legEventEndpoint=\"grpc://host:port\"></Refer></Flow>"
}'
<Say>
Request Payload
{
"action_custom_param": "say_text",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Say>Hello</Say></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "say_text",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><Say>Hello</Say></Flow>"
}'
<SendDigits>
Request Parameters
Attribute | Required | Description |
|---|---|---|
duration | No | Tone duration (ms) |
between | No | Gap between digits |
Request Payload
{
"action_custom_param": "send_digits",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><SendDigits duration=\"100\" between=\"500\">1234#</SendDigits></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "send_digits",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><SendDigits duration=\"100\" between=\"500\">1234#</SendDigits></Flow>"
}'
<StartMonitoring>
Request Parameters
Attribute | Required | Description |
|---|---|---|
monitoringLegSid | Yes | Target leg SID |
rxAudio | No | muted / enabled |
Request Payload
{
"action_custom_param": "start_monitoring",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartMonitoring monitoringLegSid=\"LEG_SID\" rxAudio=\"muted\"></StartMonitoring></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "start_monitoring",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartMonitoring monitoringLegSid=\"LEG_SID\" rxAudio=\"muted\"></StartMonitoring></Flow>"
}'
<StartPlay>
Request Parameters
Attribute | Required | Description |
|---|---|---|
Body (URL) | Yes | Public or authenticated audio file URL |
Request Payload
{
"action_custom_param": "start_play",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartPlay>https://example.com/audio.wav</StartPlay></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "start_play",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartPlay>https://example.com/audio.wav</StartPlay></Flow>"
}'
<StartRecording>
Request Parameters
Attribute | Required | Description |
|---|---|---|
direction | No | in, out, both |
format | No | wav, mp3 |
storageType | No | https, s3 |
storageURL | No | Upload endpoint |
Request Payload
{
"action_custom_param": "start_recording",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartRecording direction=\"both\" format=\"wav\" storageType=\"https\" storageURL=\"https://example.com/upload\"></StartRecording></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "start_recording",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartRecording direction=\"both\" format=\"wav\" storageType=\"https\" storageURL=\"https://example.com/upload\"></StartRecording></Flow>"
}'
<StartStream>
Request Parameters
Attribute | Required | Description |
|---|---|---|
streamType | Yes | unidirectional / bidirectional |
streamUrl | Yes | WebSocket endpoint |
Request Payload
{
"action_custom_param": "start_stream",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartStream streamType=\"bidirectional\" streamUrl=\"wss://example.com/stream\"></StartStream></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "start_stream",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StartStream streamType=\"bidirectional\" streamUrl=\"wss://example.com/stream\"></StartStream></Flow>"
}'
<StopMonitoring>
Request Payload
{
"action_custom_param": "stop_monitoring",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopMonitoring></StopMonitoring></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "stop_monitoring",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopMonitoring></StopMonitoring></Flow>"
}'
<StopPlay>
Request Payload
{
"action_custom_param": "stop_play",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopPlay></StopPlay></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "stop_play",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopPlay></StopPlay></Flow>"
}'
<StopRecording>
Request Payload
{
"action_custom_param": "stop_recording",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopRecording></StopRecording></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "stop_recording",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopRecording></StopRecording></Flow>"
}'
<StopSay>
Request Payload
{
"action_custom_param": "stop_say",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopSay></StopSay></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "stop_say",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopSay></StopSay></Flow>"
}'
<StopStream>
Request Parameters
Attribute | Required | Description |
|---|---|---|
streamSid | Yes | Stream identifier |
Request Payload
{
"action_custom_param": "stop_stream",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopStream streamSid=\"STREAM_SID\"></StopStream></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "stop_stream",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><StopStream streamSid=\"STREAM_SID\"></StopStream></Flow>"
}'
<UnHold>
Request Payload
{
"action_custom_param": "unhold_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><UnHold></UnHold></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "unhold_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><UnHold></UnHold></Flow>"
}'
<UnMute>
Request Parameters
Attribute | Required | Description |
|---|---|---|
direction | No | in, out, both |
Request Payload
{
"action_custom_param": "unmute_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><UnMute direction=\"out\"></UnMute></Flow>"
}
cURL
curl --location 'https://cpaas-api.in.exotel.com/v2/accounts/{account_sid}/legs/{leg_sid}/actions' \
--header 'Authorization: Basic <BASE64_APIKEY_APITOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"action_custom_param": "unmute_leg",
"exoml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Flow><UnMute direction=\"out\"></UnMute></Flow>"
}'