Record a call session

Records the call session. If a call is bridged, both audio streams are recorded.

Record call session

post

Record a channel call session

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

maxLengthintegerOptional

stereobooleanOptional

Responses

202

Call Command RecordCall 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}/recordings HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "maxLength": 1,
  "stereo": true
}

{
  "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"
}

Request Headers

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

Request Body

{
  "maxLength": 0,
  "stereo": true
}

Response

{
  "command": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "callId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "callFlowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "string",
    "command": "string"
  },
  "recordingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}