Record a call session

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

Record call session

Record a channel call session

POST/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

callId*string (uuid)

The ID for a call

channelId*string (uuid)

The ID for a channel

Body

application/json

maxLengthinteger

stereoboolean

Response

202400404422

Call Command RecordCall was accepted for processing

Body

application/json

commandCallCommandResponse

recordingIdId-2 (string (uuid))

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "command": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "callId": "123e4567-e89b-12d3-a456-426614174000",
    "callFlowId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "command": "text"
  },
  "recordingId": "123e4567-e89b-12d3-a456-426614174000"
}

Request Headers

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
/recordings" \
     -H 'Authorization: Bearer {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"
}