Ring a call

In order to initiate ringing on an inbound call you can use this request.

Ringing call

Send call ringing

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

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

Response

202400404422

Call Command Ringing was accepted for processing

Body

application/json

idId-2 (string (uuid))

callIdId-2 (string (uuid))

callFlowIdId-2 (string (uuid))

statusstring

commandstring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/ringing', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

202400404422

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

Example 1: Ringing an inbound call

Request Header

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

Request Body

// N/A

Response

{
  "id": "1b416337-856e-4c6a-bfbd-ef872fad172a",
  "callId": "48609ac0-5c5e-40af-8c0c-08c59bd902cd",
  "command": "ringing",
  "status": "accepted"
}