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

Reasons hangup a call - not mandatory

type: object
title: HangupCalls
additionalProperties: false
properties:
  cause:
    type: "string"
    enum:
      - rejected
      - busy

Hangup call

post

Hangup a channel call

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

Body

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

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/hangup HTTP/1.1
Host: 
Authorization: Bearer jwt
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-access-key}"

Request Body

// N/A

Response

{
  "id": "db35bd0e-b5ed-4a6a-a01f-e12c2489059a",
  "callId": "c47724eb-978c-46a4-96f7-fbb061ba969a",
  "command": "hangup",
  "status": "accepted"
}