DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Initiate an outbound call

In order to create an outbound call from a voice channel you can use this request. You can set a callFlow with commands to be executed after call is answered.
POST
/workspaces/{workspaceId}/channels/{channelId}/calls
Create a channel call
Verzoek-payload
from
string
to
string
verplicht
ringTimeout
integer
maxDuration
integer
sendKeys
string
record
boolean
recordStart
string
Possible values: record-from-answer, record-from-ringing
flowStart
string
Possible values: from-answer, from-ringing
stereo
boolean
callFlow
array of object
Onderliggende parameters tonen
callFlow.command
string
Possible values: hangup, playback, say, gather, record, bridge, pause
callFlow.conditions
array of object
Onderliggende parameters tonen
callFlow.conditions.variable
string
Possible values: keys, speech
callFlow.conditions.operator
string
Possible values: eq, ne, ==, !=, contains
callFlow.conditions.value
string
callFlow.options
object
Onderliggende parameters tonen
callFlow.options.media
array of string
verplicht
callFlow.options.loop
integer
callFlow.options.timeout
integer
callFlow.options.pauseMilliseconds
integer
scheduledFor
string
notification
object
Onderliggende parameters tonen
notification.url
string
amdSettings
object
Onderliggende parameters tonen
amdSettings.enabled
boolean
verplicht
amdSettings.wordCount
number
verplicht
amdSettings.speechTimeout
number
verplicht
amdSettings.speechLocale
string
verplicht
Possible values: de-DE, en-AU, en-GB, en-US, es-US, it-IT, ja-JP, ko-KR, pt-BR, th-TH, zh-CN
amdSettings.beepTimeout
number
amdSettings.ifMachineNotifyAfter
string
verplicht
Possible values: beep, wordCount
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.
Antwoord-payload
id
string
verplicht
channelId
string
verplicht
from
string
verplicht
to
string
verplicht
originator
object
verplicht
Onderliggende attributen tonen
originator.contact
object
Onderliggende attributen tonen
originator.contact.id
string
verplicht
originator.contact.identifierKey
string
verplicht
originator.contact.identifierValue
string
verplicht
originator.number
object
verplicht
Onderliggende attributen tonen
originator.number.type
string
verplicht
Possible values: pstn, sip, webrtc
originator.number.number
string
verplicht
originator.number.anonymous
boolean
originator.number.callerIdName
string
originator.number.identity
string
originator.number.countryIsoCode
string
originator.number.pstnNumberType
string
receiver
object
verplicht
Onderliggende attributen tonen
receiver.contact
object
Onderliggende attributen tonen
receiver.contact.id
string
verplicht
receiver.contact.identifierKey
string
verplicht
receiver.contact.identifierValue
string
verplicht
receiver.number
object
verplicht
Onderliggende attributen tonen
receiver.number.type
string
verplicht
Possible values: pstn, sip, webrtc
receiver.number.number
string
verplicht
receiver.number.anonymous
boolean
receiver.number.callerIdName
string
receiver.number.identity
string
receiver.number.countryIsoCode
string
receiver.number.pstnNumberType
string
parentId
string
direction
string
verplicht
Possible values: incoming, outgoing
status
string
verplicht
Possible values: accepted, starting, ringing, ongoing, completed, busy, no-answer, failed, cancelled, scheduled
reason
string
type
string
verplicht
Possible values: pstn, sip, webrtc
duration
integer
hangupCauseCode
integer
hangupSource
string
Possible values: callee, caller, api, timeout, media-timeout, none
hangupSipCode
string
createdAt
string
verplicht
updatedAt
string
verplicht
ringingAt
string
answeredAt
string
endedAt
string
scheduledFor
string
callFlow
object
Onderliggende attributen tonen
callFlow.id
string
callFlow.commands
array of object
Onderliggende attributen tonen
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
Onderliggende attributen tonen
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
Onderliggende attributen tonen
notification.url
string
qualityInsights
object
Onderliggende attributen tonen
qualityInsights.mos
string
qualityInsights.pdd
string
sipInsights
object
Onderliggende attributen tonen
sipInsights.hangupSipCode
string
sipInsights.edgeRegion
string
sipInsights.providerName
string
sipInsights.userAgent
string
sipInsights.remoteSignallingIp
string
sipInsights.remoteMediaIp
string
amdResult
object
Onderliggende attributen tonen
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.
Codevoorbeeld
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Initiate an outbound call, play an announcement and hangup

Codevoorbeeld
curl -X POST "https://api.bird.com/workspaces/:workspaceId/channels/:channelId/calls" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN`

Example 2: Initiate an outbound call with TTS

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