Answer call
POST/calls/:call_control_id/actions/answer
Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call.
Expected Webhooks:
call.answered
streaming.started
,streaming.stopped
orstreaming.failed
ifstream_url
was set
Request
Path Parameters
Unique identifier and token for controlling the call
- application/json
Body
required
Answer call request
Array [
]
Array [
]
Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID.
Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id
for the same call_control_id
.
custom_headers
object[]
Custom headers to be added to the SIP INVITE response.
The name of the header to add.
The value of the header.
sip_headers
object[]
SIP headers to be added to the SIP INVITE response. Currently only User-to-User header is supported.
Possible values: [User-to-User
]
The name of the header to add.
The value of the header.
sound_modifications
object
Use this field to modify sound effects, for example adjust the pitch.
Set the pitch directly, value should be > 0, default 1 (lower = lower tone)
Adjust the pitch in semitones, values should be between -14 and 14, default 0
Adjust the pitch in octaves, values should be between -1 and 1, default 0
Default value: outbound
The track to which the sound modifications will be applied. Accepted values are inbound
or outbound
The destination WebSocket address where the stream is going to be delivered.
Possible values: [inbound_track
, outbound_track
, both_tracks
]
Default value: inbound_track
Specifies which track should be streamed.
Default value: false
Generate silence RTP packets when no transmission available.
Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.
Possible values: [POST
, GET
]
Default value: POST
HTTP request type used for webhook_url
.
Responses
200: Successful response upon making a call control command.
- application/json
- Schema
- Example (from schema)
Schema
data
object
{
"data": {
"result": "ok"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Callbacks