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

Hangup a channel call

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

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

Body

application/json

causeenum

rejectedbusy

Response

202400404422

Call Command hangup 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}/hangup', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
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: Hangup a call

Request Headers

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

Request Body

// N/A

Response

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