Docs for Developers
› Bandwidth APIs
Login
Support
Pricing
Free Trial
Overview
About
Bandwidth Dashboard
Get Started
Webhooks / HTTP Callbacks
Authenticated Callbacks
API Credentials & Security
Voice, Numbers, Account
Messaging
SDKs & Developer Tools
Python
Ruby
C#
Node
Messaging, Usage and Migration Guide
Voice, Usage and Migration Guide
Java
PHP
Examples on GitHub
OpenAPI/Swagger on GitHub
Postman Collections
Quickstart CLI
Developer Forum
Try Sandbox
Account
Guides & Tutorials
Bandwidth Account Structure
Account
Sub-Account (Site)
Location (Sip-peer)
Application
Bandwidth Account Setup Guide
Create a Sub-Account
Create a Voice Application
Create a Messaging Application
Create a Location
Order a Phone Number
Next Steps
Automate Account Setup
Create messaging application
Create voice application
Create Sub-Account (Site)
Create Location (Sip-peer)
Enable SMS on Location (Sip-peer)
Enable MMS on Location (Sip-peer)
Assign Application to Location (Sip-peer)
Enable HTTP Voice on Location (Sip-peer)
Setup Network Bridge
Pre-Requs
Steps
Create New Sip Credentials
Generate MD5 Hash
Add the Newly Created Hash to Sip Credentials
Create Call Using the Network Bridge
Applications
POST
Create Application
GET
List Applications
GET
Fetch Application info
PAT
Partial Update Application
PUT
Completely Update Application
DEL
Remove Application
GET
List Associated Sippeers
Subscriptions
POST
Create Subscription
GET
List Subscription
GET
Fetch Subscription info
PUT
Completely Update Subscription
DEL
Remove Subscription
Numbers
Overview
Rate Limits
Guides & Tutorials
Searching Phone Numbers
AreaCode
TollFree
localVanity
Npanxxx
Npanxxx With LCA
Node example
C# example
PHP example
Ruby example
Java example
Order Phone Numbers - callback
Create Subscription
Search for Phone Numbers
Create order for Phone Numbers
Receive HTTP Callback with order status
Fetch information about order
Order Phone Numbers - polling
Search For Phone Numbers
Order Phone Numbers
Fetch Order Info
Disconnecting a Phone Number
Fetching Disconnect Info
Disconnect a Phone Number
Disconnect a Phone Number
Fetch Disconnect Info
Managing Line Features
About
Single TN Option Assignment
Calling Name Display
Directory Listing and Directory Assistance (DLDA)
Creating and Managing a DLDA Order
Retrieving the history of a DLDA order
Checking DLDA information associated with a TN
Set a Failover URI
Managing Orders
About
Associating Notes with Work Orders
Order Change Notifications
Email Notifications
Callback URL Notifications
Downloading Reports
About
Account Reports
Request a Report
Query Report Status
Download the Report
Billing Reports
Request a Report
Query Report Status
Download the Report
Hosted Messaging - import TNs
Create Subscription
Create importTNOrder
Receive callback
Fetch Order Status
Upload Loa
Check in service numbers
Porting Phone Numbers
About Porting
Overview of the Port-in Process
Checking LNP Availability
Creating an LNP Order
LOA Upload
Modifying an LNP Order (Supp LNP Order)
Canceling LNP Order
Activating Ported Numbers
Number Utilization Review API
Portout Passcode Protection
CSR Lookup API
Create Subscriptions
Create a CSR Order
Receive callback
Fetch Order Status
Searching Tns - All Accounts
Searching For TNs
Searching For Specific TNs
Retrieving TN Information
Retrieving TN Details
Retrieving TN Sites
Retrieving TN SipPeers
Retrieving TN Rate Center
Retrieving TN Lca
Retrieving TN Lata
Retrieving TN Reservation
Retrieving TN Available Nn Routes
Number Lookup API
Create a Phone Number Lookup Request
Fetch Status of a Request
API Methods
Callbacks
Order Notification
Portout Validation
Callback Request
Allow Portout
Deny Portout
Events Notification
Errors
Voice
Overview
Rate Limits
Guides & Tutorials
BXML Recording
CNAM Service
API Methods
Create & Update Calls
POST
Create Call
GET
Call Information
POST
Update Call
PUT
Pause/Resume Recording
Conferences
GET
Account Conferences
GET
Conference Information
POST
Update Conference
GET
Member Information
PUT
Update Conference Member
Recording Management
GET
Account Recordings
PUT
Pause/Resume Recording
GET
Call Recordings
GET
Recording Information
DEL
Delete Recording Information
GET
Download Recording
DEL
Delete Recording
POST
Transcribe recording
GET
Download Transcription
DEL
Delete Transcription
Call Control (BXML)
Bridge
Conference
Forward
Gather
Hangup
Pause
PauseRecording
PlayAudio
Record
Redirect
ResumeRecording
Ring
SendDtmf
SpeakSentence
StartGather
StartRecording
StopGather
StopRecording
Tag
Transfer
Callbacks
Answer
BridgeComplete
BridgeTargetComplete
Conference Created
Conference Member Join
Conference Member Exit
Conference Completed
Conference Redirect
Conference Recording Available
Disconnect
DTMF
Gather
Initiate
RecordComplete
RecordingAvailable
TranscriptionAvailable
Redirect
Transfer Answer
Transfer Complete
Transfer Disconnect
Errors
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
409 - Conflict
415 - Invalid Media-Type
429 - Too Many Requests
500 - Internal Server Error
503 - Unavailable
Messaging
Overview
Rate Limits
Billing information
How Bandwidth Helps Messaging
Default Rate Limits
Managing Messages
API Methods
Create Messages
Get Messages
Media Management (MMS)
GET
List Media
GET
Get Media
PUT
Upload Media
DEL
Delete Media
Callbacks
Incoming SMS/MMS Message
Incoming Group Message
Message Delivered
Message Failed
Message Sending (MMS only)
Errors
HTTP Errors
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
415 - Invalid Media-Type
429 - Too Many Requests
Messaging Errors
Messaging Error Code Schema
Messaging Error Code Table
Bandwidth Detected Client Errors
Carrier Reported Client Errors
Bandwidth Service Failures
Carrier Reported Service Failures
Carrier Errors with Ambiguous Cause
International Overview
Sending SMS messages
Create Message API
HTTP Responses (Success & Errors)
Callbacks
DLR Parameters
DLR Error Codes
10DLC Campaigns
CSP
Reseller and Brand Dashboard UI Guide
Reseller and Brand API Guide
Campaign UI Guide
Campaign API Guide
FAQs
Imports
Dashboard UI Guide
API Guide
Managing Multiple CSP IDs
FAQs
Multi-Factor Authentication
Overview
API Methods
POST
Voice
POST
Messaging
POST
Verify
Callbacks
North America - Message Delivered
North America - Message Failed
International - Message Delivered
International - Message Failed
Rate Limits
Errors
WebRTC Calling and Video API
Overview
WebRTC Concept Overview
Quickstart Guide
API Methods
Participants
POST
Create Participant
DEL
Delete Participant
GET
Get Participant
Sessions
PUT
Add Participant
POST
Create Session
DEL
Delete Session
GET
Get Participant Subscriptions
GET
Get Session
DEL
Remove Participant From Session
PUT
Update Participant Subscriptions
Errors
Emergency Services
Overview
911 Dynamic Location Routing
Guides & Tutorials
911 DLR Integration Guide
About Emergency Notifications
Overview
Notification Types
Relationships and constraints
API Endpoint Overview
Key terminology
Setup Emergency Notifications
Create Recipients
Create Groups
Associate Groups & Endpoints
Updating Configuration
Removing Configuration
Emergency Calling API Integration Guide
911 Access Dashboard API
Usage Guide
API Methods
SOAP Overview
REST API Methods
GET
Authentication Check
GET
URIs
GET
Locations by URI
GET
Provisioned Location by URI
GET
Provisioned Location History by URI
POST
Validate Location
POST
Add Location
POST
Remove Location
POST
Remove URI
POST
Provision Location
Emergency Notifications
GET
List Recipients
POST
Create Recipient
GET
Recipient Information
PAT
Update Recipient
DEL
Remove Recipient
GET
Recipient Endpoint Associations
PAT
Update Recipient Endpoint Association
DEL
Remove Recipient Endpoint Association
Faults and Limits
v1 Docs
Home Page
Voice
Messaging
Guides & Tutorials
Voice Guides
BXML
BXML Recording
CNAM
CNAM Service
results matching "
"
No results matching "
"