DocumentatieEngagement Platform API
Sign inGet started
Guides
API

Forward a call

Forward a call to another phone number or to a SIP URI. This command will create a new call resource and both calls will be connected (bridged).
POST
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/bridge
Creates a new channel call and forward to it
Verzoek-payload
from
string
to
string
verplicht
ringTimeout
integer
maxDuration
integer
ringTone
string
Possible values: be, ca, cn, cy, cz, de, dk, dz, eg, fi, fr, hk, hu, il, in, jp, ko, pk, pl, ro, rs, ru, sa, tr, uk, us
hangupAfterBridge
boolean
record
boolean
recordStart
string
Possible values: record-from-answer, record-from-ringing
recordStereo
boolean
callFlow
array of object
Onderliggende parameters tonen
callFlow.command
string
Possible values: hangup, playback, say, gather, 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
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
Antwoord-payload
command
object
Onderliggende attributen tonen
command.id
string
command.callId
string
command.callFlowId
string
command.status
string
command.command
string
command.conditions
array of object
Onderliggende attributen tonen
command.conditions.variable
string
Possible values: keys, speech
command.conditions.operator
string
Possible values: eq, ne, ==, !=, contains
command.conditions.value
string
bridgedCall
object
Onderliggende attributen tonen
bridgedCall.id
string
verplicht
bridgedCall.channelId
string
verplicht
bridgedCall.from
string
verplicht
bridgedCall.to
string
verplicht
bridgedCall.originator
object
verplicht
Onderliggende attributen tonen
bridgedCall.originator.contact
object
Onderliggende attributen tonen
bridgedCall.originator.contact.id
string
verplicht
bridgedCall.originator.contact.identifierKey
string
verplicht
bridgedCall.originator.contact.identifierValue
string
verplicht
bridgedCall.originator.number
object
verplicht
Onderliggende attributen tonen
bridgedCall.originator.number.type
string
verplicht
Possible values: pstn, sip, webrtc
bridgedCall.originator.number.number
string
verplicht
bridgedCall.originator.number.anonymous
boolean
bridgedCall.originator.number.callerIdName
string
bridgedCall.originator.number.identity
string
bridgedCall.originator.number.countryIsoCode
string
bridgedCall.originator.number.pstnNumberType
string
bridgedCall.receiver
object
verplicht
Onderliggende attributen tonen
bridgedCall.receiver.contact
object
Onderliggende attributen tonen
bridgedCall.receiver.contact.id
string
verplicht
bridgedCall.receiver.contact.identifierKey
string
verplicht
bridgedCall.receiver.contact.identifierValue
string
verplicht
bridgedCall.receiver.number
object
verplicht
Onderliggende attributen tonen
bridgedCall.receiver.number.type
string
verplicht
Possible values: pstn, sip, webrtc
bridgedCall.receiver.number.number
string
verplicht
bridgedCall.receiver.number.anonymous
boolean
bridgedCall.receiver.number.callerIdName
string
bridgedCall.receiver.number.identity
string
bridgedCall.receiver.number.countryIsoCode
string
bridgedCall.receiver.number.pstnNumberType
string
bridgedCall.parentId
string
bridgedCall.direction
string
verplicht
Possible values: incoming, outgoing
bridgedCall.status
string
verplicht
Possible values: accepted, starting, ringing, ongoing, completed, busy, no-answer, failed, cancelled, scheduled
bridgedCall.reason
string
bridgedCall.type
string
verplicht
Possible values: pstn, sip, webrtc
bridgedCall.duration
integer
bridgedCall.hangupCauseCode
integer
bridgedCall.hangupSource
string
Possible values: callee, caller, api, timeout, media-timeout, none
bridgedCall.hangupSipCode
string
bridgedCall.createdAt
string
verplicht
bridgedCall.updatedAt
string
verplicht
bridgedCall.ringingAt
string
bridgedCall.answeredAt
string
bridgedCall.endedAt
string
bridgedCall.scheduledFor
string
bridgedCall.callFlow
object
Onderliggende attributen tonen
bridgedCall.callFlow.id
string
bridgedCall.callFlow.commands
array of object
Onderliggende attributen tonen
bridgedCall.callFlow.commands.id
string
bridgedCall.callFlow.commands.callId
string
bridgedCall.callFlow.commands.callFlowId
string
bridgedCall.callFlow.commands.status
string
bridgedCall.callFlow.commands.command
string
bridgedCall.callFlow.commands.conditions
array of object
Onderliggende attributen tonen
bridgedCall.callFlow.commands.conditions.variable
string
Possible values: keys, speech
bridgedCall.callFlow.commands.conditions.operator
string
Possible values: eq, ne, ==, !=, contains
bridgedCall.callFlow.commands.conditions.value
string
bridgedCall.notification
object
Onderliggende attributen tonen
bridgedCall.notification.url
string
bridgedCall.qualityInsights
object
Onderliggende attributen tonen
bridgedCall.qualityInsights.mos
string
bridgedCall.qualityInsights.pdd
string
bridgedCall.sipInsights
object
Onderliggende attributen tonen
bridgedCall.sipInsights.hangupSipCode
string
bridgedCall.sipInsights.edgeRegion
string
bridgedCall.sipInsights.providerName
string
bridgedCall.sipInsights.userAgent
string
bridgedCall.sipInsights.remoteSignallingIp
string
bridgedCall.sipInsights.remoteMediaIp
string
bridgedCall.amdResult
object
Onderliggende attributen tonen
bridgedCall.amdResult.result
string
Possible values: human, machine, noSpeech, beep, unknown
bridgedCall.amdResult.speech
string
bridgedCall.amdResult.locale
string
bridgedCall.sipType
string
Possible values: elastic, byoc, forward
bridgedCall.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/{callId}/bridge' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Forward an inbound call to an external number

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