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.

Command record a call

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

Record call

post

Record a channel call

Authorizations

useraccessKey

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-USExample: en-USPossible 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

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record HTTP/1.1
Host: 
Authorization: Bearer jwt
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

Request Headers

curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/record" \
     -H "Authorization: AccessKey {your-access-key}"

Request Body

{
  "beep": true,
  "endKey": "#",
  "maxLength": 60,
  "timeout": 3,
  "transcribe": true,
  "transcribeLocale": "en-US"
}

Response

{
  "command": {
    "id": "067f0409-fe5a-466a-bdc1-dccc76b02376",
    "callId": "d34d4ebc-dd67-405e-95ef-ca72485a2975",
    "command": "record",
    "status": "accepted"
  },
  "recordingId": "61396ce4-2e1a-404e-a550-5863b594f387"
}