DocumentatieEngagement Platform API
Sign inGet started
Guides
API

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
POST
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/hangup
Hangup a channel call
Verzoek-payload
cause
string
Possible values: rejected, busy
Antwoord-payload
id
string
callId
string
callFlowId
string
status
string
command
string
conditions
array of object
Onderliggende attributen tonen
conditions.variable
string
Possible values: keys, speech
conditions.operator
string
Possible values: eq, ne, ==, !=, contains
conditions.value
string
Codevoorbeeld
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/hangup' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Hangup a call

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