DocumentationEngagement Platform API
Sign inGet started
Guides
API

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.
POST
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record
Record a channel call
Corps de la requête
endKey
string
Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #
maxLength
integer
timeout
integer
beep
boolean
transcribe
boolean
transcribeLocale
string
Possible values: ar-AE, ar-SA, zh-CN, zh-TW, da-DK, nl-NL, en-AU, en-GB, en-IN, en-IE, en-NZ, en-AB, en-ZA, en-US, en-WL, fr-FR, fr-CA, fa-IR, de-DE, de-CH, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, pt-PT, pt-BR, ru-RU, es-ES, es-US, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN
Corps de la réponse
command
object
Afficher les attributs enfants
command.id
string
command.callId
string
command.callFlowId
string
command.status
string
command.command
string
command.conditions
array of object
Afficher les attributs enfants
command.conditions.variable
string
Possible values: keys, speech
command.conditions.operator
string
Possible values: eq, ne, ==, !=, contains
command.conditions.value
string
recordingId
string
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Record one inbound / outbound call

Exemple de code
curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"