Record a Call
Record a call. This command will record the call until one of the conditions apply:
the
endKey
DTMF is detected.silence is detected for more than the duration defined in
timeout
.duration exceeds the
maxLength
.
This command doesn't record the whole call. This command is useful to record messages in a typical voicemail use case.
Record a channel call
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
callIdstring · uuidRequired
The ID for a call
channelIdstring · uuidRequired
The ID for a channel
Body
endKeystring · enumOptionalPossible values:
maxLengthintegerOptional
timeoutintegerOptional
beepbooleanOptional
transcribebooleanOptional
transcribeLocalestring · enumOptionalDefault:
en-US
Example: en-US
Possible values: Responses
202
Call Command Record was accepted for processing
application/json
400
The request did not pass validation
application/json
404
The request did not pass validation
application/json
422
The request did not pass validation
application/json
post
POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"endKey": "0",
"maxLength": 1,
"timeout": 1,
"beep": true,
"transcribe": true,
"transcribeLocale": "en-US"
}
{
"command": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"callId": "123e4567-e89b-12d3-a456-426614174000",
"callFlowId": "123e4567-e89b-12d3-a456-426614174000",
"status": "text",
"command": "text",
"conditions": [
{
"variable": "keys",
"operator": "eq",
"value": "text"
}
]
},
"recordingId": "123e4567-e89b-12d3-a456-426614174000"
}
Example 1: Record one inbound / outbound call
curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record" \
-H "Authorization: AccessKey YOUR_SECRET_TOKEN"
Last updated
Was this helpful?