DokumentationEngagement Platform API
Sign inGet started
Guides
API

Update a call

Update an active call resource. You can use this request to do additional actions:
  • You can use this request to hangup the call by setting status to completed
  • It can also be used to update the callFlow of the call. Commands of the new callFlow will be executed after the Patch.

CallFlowCommand

Check bellow the available commands when initiating an outbound call. In order to assess the options of each command, you may explore each command section.
Codebeispiel
type: string
enum:
  - answer
  - hangup
  - playback
  - say
  - gather
  - record
  - bridge
  - pause
  - ringing
PATCH
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}
Update a call
Anfrage-Payload
status
string
Possible values: completed
callFlow
array of object
Untergeordnete Parameter anzeigen
callFlow.command
string
Possible values: answer, hangup, playback, say, gather, record, bridge, pause, ringing
callFlow.options
object
Untergeordnete Parameter anzeigen
callFlow.conditions
array of object
Untergeordnete Parameter anzeigen
callFlow.conditions.variable
string
Possible values: keys, speech
callFlow.conditions.operator
string
Possible values: eq, ne, ==, !=, contains
callFlow.conditions.value
string
Antwort-Payload
id
string
erforderlich
channelId
string
erforderlich
from
string
erforderlich
to
string
erforderlich
originator
object
erforderlich
Untergeordnete Attribute anzeigen
originator.contact
object
Untergeordnete Attribute anzeigen
originator.contact.id
string
erforderlich
originator.contact.identifierKey
string
erforderlich
originator.contact.identifierValue
string
erforderlich
originator.number
object
erforderlich
Untergeordnete Attribute anzeigen
originator.number.type
string
erforderlich
Possible values: pstn, sip, webrtc
originator.number.number
string
erforderlich
originator.number.anonymous
boolean
originator.number.callerIdName
string
originator.number.identity
string
originator.number.countryIsoCode
string
originator.number.pstnNumberType
string
receiver
object
erforderlich
Untergeordnete Attribute anzeigen
receiver.contact
object
Untergeordnete Attribute anzeigen
receiver.contact.id
string
erforderlich
receiver.contact.identifierKey
string
erforderlich
receiver.contact.identifierValue
string
erforderlich
receiver.number
object
erforderlich
Untergeordnete Attribute anzeigen
receiver.number.type
string
erforderlich
Possible values: pstn, sip, webrtc
receiver.number.number
string
erforderlich
receiver.number.anonymous
boolean
receiver.number.callerIdName
string
receiver.number.identity
string
receiver.number.countryIsoCode
string
receiver.number.pstnNumberType
string
parentId
string
direction
string
erforderlich
Possible values: incoming, outgoing
status
string
erforderlich
Possible values: accepted, starting, ringing, ongoing, completed, busy, no-answer, failed, cancelled, scheduled
reason
string
type
string
erforderlich
Possible values: pstn, sip, webrtc
duration
integer
hangupCauseCode
integer
hangupSource
string
Possible values: callee, caller, api, timeout, media-timeout, none
hangupSipCode
string
createdAt
string
erforderlich
updatedAt
string
erforderlich
ringingAt
string
answeredAt
string
endedAt
string
scheduledFor
string
callFlow
object
Untergeordnete Attribute anzeigen
callFlow.id
string
callFlow.commands
array of object
Untergeordnete Attribute anzeigen
callFlow.commands.id
string
callFlow.commands.callId
string
callFlow.commands.callFlowId
string
callFlow.commands.status
string
callFlow.commands.command
string
callFlow.commands.conditions
array of object
Untergeordnete Attribute anzeigen
callFlow.commands.conditions.variable
string
Possible values: keys, speech
callFlow.commands.conditions.operator
string
Possible values: eq, ne, ==, !=, contains
callFlow.commands.conditions.value
string
notification
object
Untergeordnete Attribute anzeigen
notification.url
string
qualityInsights
object
Untergeordnete Attribute anzeigen
qualityInsights.mos
string
qualityInsights.pdd
string
sipInsights
object
Untergeordnete Attribute anzeigen
sipInsights.hangupSipCode
string
sipInsights.edgeRegion
string
sipInsights.providerName
string
sipInsights.userAgent
string
sipInsights.remoteSignallingIp
string
sipInsights.remoteMediaIp
string
amdResult
object
Untergeordnete Attribute anzeigen
amdResult.result
string
Possible values: human, machine, noSpeech, beep, unknown
amdResult.speech
string
amdResult.locale
string
sipType
string
Possible values: elastic, byoc, forward
tags
array of string
Tags to associate with the call. Tags are converted to lower case and tags that do not exist are automatically created. You can view your created tags in the UI. You can specify up to 10 tags per call.
Codebeispiel
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Update a call by answering

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

Example 2: Update a call by sending ringing, pause for 2 seconds, answer and play an announcement

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