Ring a call

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

Ringing call

post

Send call ringing

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token

Path parameters

workspaceIdstring · uuidRequired

The unique identifier of the workspace.

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Responses

202

Call Command Ringing was accepted for processing

application/json

idstring · uuidOptional

callIdstring · uuidOptional

callFlowIdstring · uuid · nullableOptional

statusstringOptional

commandstringOptional

400

An error

application/json

404

An error

application/json

422

The request contains invalid parameters or body fields.

application/json

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

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/ringing HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

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

Example 1: Ringing an inbound call

Request Header

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

Request Body

Response