Bandwidth Voice API

Base API URL

https://voice.bandwidth.com/api/v2/accounts/{accountId}

REST API Reference Index

Resource Description
/calls The Calls resource lets you make phone calls and modify active calls.
/recordings The Recordings resource lets you retrieve information about recordings created during calls as well as manage recordings on a live call.

BXML verbs

Verb Description
<Forward> The Forward verb is used to forward an unanswered incoming call to another number.
<Gather> The Gather verb is used to collect DTMF digits.
<Hangup> The Hangup verb is used to hang up or reject a call.
<Pause> The Pause verb is used to delay verb execution for a period of time.
<PauseRecording> The PauseRecording verb is used to pause a recording previously started by a <StartRecording> verb.
<PlayAudio> The PlayAudio verb is used to play an audio file in the call.
<Record> The Record verb allows a segment of audio to be recorded during a call.
<Redirect> The Redirect verb is used to redirect the current XML execution to another URL.
<ResumeRecording> The ResumeRecording verb is used to resume a recording previously paused by a <PauseRecording> verb.
<SendDtmf> The SendDtmf verb is used to play DTMF digits in the call.
<SpeakSentence> The SpeakSentence verb converts text into audible speech.
<StartRecording> The StartRecording verb allows a segment of a call to be recorded while other verbs are executing.
<StopRecording> The StopRecording verb stops a recording that was previously started by a <StartRecording>.
<Transfer> The Transfer verb is used to transfer the call to another number.

BXML Callbacks

Callback Description
Answer Bandwidth API sends this when the call is answered.
Gather Bandwidth API sends this when a <Gather> is completed.
Initiate Bandwidth API sends this when an inbound call arrives.
Record Complete Bandwidth API sends this when a <Record> is completed. The recording is not available to download until the Recording Available event is received.
Redirect Bandwidth API sends this when a <Redirect> is requested or when a POST request is made to the /calls/{callId} endpoint requesting a redirect.
Transfer Answer Bandwidth API sends this when the <Transfer> is answered.
Transfer Complete Bandwidth API sends this when the <Transfer> is complete and the original call needs to continue.

Asynchronous Callbacks

Callback Description
Disconnect Bandwidth API sends this when a call ends.
Recording Available Bandwidth API sends this when a recording started by either a <StartRecording> or a <Record> verb is available for download.
Transfer Disconnect Bandwidth API sends this when any leg of a <Transfer> ends.
Transcription Available Bandwidth API sends this when the transcription of a recording is available for download.

Error Codes

Type Description
Rate Limits Every endpoint is rate limited
HTTP Errors Learn about the different errors that you may encounter using the API

results matching ""

    No results matching ""