Bandwidth Voice & Messaging APIs

Base URL

https://api.catapult.inetwork.com/v1

Conventions

Some of the URLs in this documentation contain placeholders for values that your API client program must provide. These placeholders are shown in curly braces, like {this}. When you construct the URL to access these resources, replace those placeholders with the values you want to use.

Postman

REST API Reference Index

Resource Description
/account Account API allows you to retrieve your current balance, transaction list, account type and all elements related to your platform account.
/applications The Applications resource lets you define call and message handling applications. You write an application on your own servers and have Bandwidth API send events to it by configuring a callback URL.
/availableNumbers The Available Numbers resource lets you search for numbers that are available for use with your application.
/bridges The Bridges resource allows you to bridge two calls together allowing for two way audio between them. A common example is bridging an incoming phone call together with a outgoing phone call.
/calls The Calls resource lets you make phone calls and view information about previous inbound and outbound calls.
/conferences The Conference resource allows you create conferences, add members to it, play audio, speak text, mute/unmute members, hold/unhold members and other things related to conferencing. Once a conference is created there is no timeout associated with it, i.e., the conference will stay in created state until it is explicitly terminated. After the last member of a conference is removed from it, the conference will be set automatically as completed.
/domains A domain is a way to logically group endpoints. There is a 100 domain max. per account limit. Most use cases require using a single domain for all endpoints. The name of the domain will be part of a public DNS record. For that reason, we let the customer choose their domain names. Once a domain has been created, endpoints can be created and managed within the context of the domain. Because endpoints can only exist within the context of a domain, creating a domain is the first step in creating endpoints.
/endpoints An endpoint represents is an entity that can register with the Application Platform SIP Registrar and place and receive calls. This can be a device like a phone or a pad, or it can be a softphone on a computer.
/errors The Errors resource lets you see information about errors that happened in your API calls and during applications callbacks. This error information can be very helpful when you're debugging an application. Because error information can be large, and errors in the distant past are less useful than new ones, Bandwidth API limits the number of user errors it keeps.
/media The Media resource lets you upload your media files to Bandwidth API servers so they can be used in applications without requiring a separate hosting provider. You can upload files up to 65MB and file storage is free for an unlimited number of files. Files you upload can only be accessed by you when you supply your API access token and secret. They are not available to anonymous users. Bandwidth API supports the Cache-Control header when you upload files.
/messages The Messages resource lets you send SMS/MMS messages and view messages that were previously sent or received.
/numberInfo This resource provides a CNAM number info. CNAM is an acronym which stands for Caller ID Name. CNAM can be used to display the calling party's name alongside the phone number, to help users easily identify a caller. CNAM API allows the user to get the CNAM information of a particular number.
/phoneNumbers The Phone Numbers resource lets you get phone numbers for use with your programs and manage numbers you already have.
/recordings Retrieve information about call recordings. The recording information retrieved by GET method contains only textual data related to call recording as described on Properties section. To properly work with recorded media content such as download and removal of media file, please access /media documentation. To learn about how to transcribe recordings, read the /recordings/{id}/transcriptions documentation.
/recordings/{id}/transcriptions The Transcription resource lets you transcribe a voicemail recording. This resource can be either created automatically when the call property transcriptionEnabled is set to true, when call is created, or during the call by posting an event. The transcription is based on a call audio recording. By enabling/disabling call property recordingEnabled, a call can have more than one recording, so it's possible to have one or more transcriptions for each one of those recordings. When transcriptionEnabled is set to true all the recordings generated within that call are going to be transcribed, i.e, if you start to record a call, at any given time when the call is active, and then terminate the recording, the transcription resource will be automatically started for this recording; this process can happen many times.

REST API Callback Reference Index

Messaging Events

Event Description
SMS Event Bandwidth API sends this event to the application when an SMS is sent or received
MMS Event Events sent to your server for inbound and outbound MMS messages.

Voice Events

Event Description
Answer Event Bandwidth API sends this message to the application when the call is answered.
Audio File Playback Events Bandwidth API sends this message to the application when audio file playback is started or done playing.
CallTimeout Event Bandwidth API sends this message to the application when the call is not answered until the specified timeout.
Conference Event Bandwidth API sends this event to the application when a conference is created or completed.
Conference Audio File Playback Event Bandwidth API sends this message to the application when audio playback has started or is done (stopped) in a conference. Note: For playback event in conference member, use the call playback event.
Conference Member Event Bandwidth API sends this message to the application when a conference member has joined / left the conference or when it as muted or put on hold.
Conference Speak Event Bandwidth API sends this message to the application when text-to-speech speaking has started or is done (stopped) in a conference. Note:— For speak event in conference member, use the call speak event.
DTMF Event Bandwidth API sends this message to the application when it receives number pad tone signals during a call.
Gather Event The Bandwidth API generates a gather event when the gather command completes in a call.
Incoming Call Event Bandwidth API sends this message to the application when an incoming call arrives. For incoming call the callback set is the one related to the Application associated with the called number.
Hangup Event Bandwidth API sends this message to the application when the call ends.
Recording Event Bandwidth API sends this event to the application when an the recording media file is saved or an error occurs while saving it.
Reject Event Bandwidth API sends this message to the application when the call is rejected.
Speak Event Bandwidth API sends this message to the application when text-to-speech starts or stops.
Transcription Event – BETA Bandwidth API sends this event to the application when a transcription is terminated or an error occurs while processing it.

results matching ""

    No results matching ""