Hangup a call

Hangup call command can be used in two situation:

• Hangup an ongoing call.

• Reject an inbound call that is starting or ringing

Hangup call

post

Hangup a channel call

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

Body

application/json

causestring · enumOptionalPossible values:

Responses

202

Call Command hangup 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

/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/hangup

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/hangup HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "cause": "rejected"
}

{
  "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: Hangup a call

Request Headers

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

Request Body

Response