Record a call. This command will record the call until one of the conditions apply:
This command doesn't record the whole call. This command is useful to record messages in a typical voicemail use case.
type: object
title: Record one Call
additionalProperties: false
properties:
endKey:
$ref: '../properties/Key.yml'
maxLength:
type: integer
timeout:
type: integer
beep:
type: boolean
transcribe:
type: boolean
transcribeLocale:
type: string
format: locale-bcp47
default: en-US
example:
- en-US
enum:
- 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
Example 1: Record one inbound / outbound call
curl -X POST "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/4fc2edf7-68f5-437a-89eb-3ce0095409d6
/record" \
-H 'Authorization: Bearer {Token}'
{
"beep": true,
"endKey": "#",
"maxLength": 60,
"timeout": 3,
"transcribe": true,
"transcribeLocale": "en-US"
}
{
"command": {
"id": "067f0409-fe5a-466a-bdc1-dccc76b02376",
"callId": "d34d4ebc-dd67-405e-95ef-ca72485a2975",
"command": "record",
"status": "accepted"
},
"recordingId": "61396ce4-2e1a-404e-a550-5863b594f387"
}