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 and phone calls and modify active calls.

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 digits for some period of time.
<Hangup> The Hangup verb is used to hangup current call.
<Pause> The Pause verb is used to delay for a period of time in the call.
<PlayAudio> The PlayAudio verb is used to play an audio file in the call.
<Redirect> The Redirect verb is used to redirect the current XML execution to another URL.
<SendDtmf> The SendDtmf verb is used to play DTMF digits in the call.
<SpeakSentence> The SpeakSentence verb is used to convert any text into speak for the caller.
<Transfer> The Transfer verb is used to transfer the call to another number.

BXML Callbacks

Callback Description
Answer Bandwidth API sends this to the application when the call is answered.
Gather Bandwidth API sends this when a <Gather> is completed.
Initiate Bandwidth API sends this to the application when an inbound call arrives.
Redirect Bandwidth API sends this to the application 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 to the application when the <Transfer> is answered.
Transfer Complete Bandwidth API sends this to the application when the <Transfer> is complete.

Asynchronous Callbacks

Callback Description
Disconnect Bandwidth API sends this to the application when a call ends.

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 ""