Ring a call

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

Ringing call

post

Send call ringing

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

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/ringing' \
  --header 'Authorization: Bearer jwt'

202

400

404

422

202

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

Call Command Ringing was accepted for processing

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