REST
API Spec
Search
did require doc
Getting Started
DID numbers
SIP trunks
Call Detail Records (CDRs)
SMS and MMS
Campaign builder
E911 API
Number Validator
Speech Analytics API
Environments
Production
Authorizing your client
API Endpoints
SIP Trunks
GET
List SIP Trunks of the Account
POST
Create a New SIP Trunk
GET
SIP Trunk Info
PUT
Update SIP Trunk Configuration
DELETE
Delete SIP Trunk
Buy
GET
Get List of Countries
GET
Get Regions
GET
Get List of Cities in a Country
GET
Get List of Cities in a Region
GET
Get DIDs Available for Purchase
My DIDs
GET
Get DIDs on the Account
DELETE
Return DIDs to Stock
POST
Update DID Destinations
POST
Upload a Document for DID
CDR
GET
Get CDRs on the Account
Cart
PUT
Add DID Numbers to Cart
POST
Check Out DID Numbers
GET
Get Cart Content
SMS and MMS
POST
Send SMS or MMS Message
POST
Receive Inbound Message
POST
Opt Out a Phone Number of SMS Messages
GET
Retrieve Inbound and Outbound SMS or MMS Messages
GET
Get SMS or MMS Message Details
GET
List Sender IDs on the Account
POST
Provision a New Sender ID
GET
Get Sender ID Restrictions
DELETE
Delete Sender ID
POST
Send High-Volume Traffic
Billing
GET
Get Transactions on the Account
GET
Get Invoices on the Account
GET
Download Invoice
Profile
GET
Get Customer Info
GET
Get Account Settings
PUT
Update Customer Info
E911
GET
List E911 Records
POST
Provision a New E911 Record
DELETE
Delete E911 Record
POST
Validate Address
Voice Campaigns
POST
Trigger a Scenario
Number Validator
GET
Validate a Single Phone Number
POST
Validate Multiple Phone Numbers
GET
Get Asynchronous Validation Results
Speech Analytics
GET
Request Transcription for a Specific Call
POST
Search for Calls Containing Specific Keywords or Phrases
PUT
Transcribe a Single Call
Models
Structures
Cdr
Inbound CDR
Outbound CDR
DID
Document
Doc Types
Did Destination
Pagination
Location
City
Dids Page
State
Country
SIP Trunk Configuration
SIP Trunk
Destination Blacklist Request Body
Destination Blacklist Response Body
Allowed Ip Request Body
Allowed Ip
Allowed Ips
Cities
Buy Countries Regions Cities Response
Regions
Countries
Buy Countries Search Locations Response
CDR Response
Destination
Hlr Response
Host Request
IP Auth Request
Passthrough Request
Purchases Active Response
Purchases Non Active DID Numbers Counts Response
Purchases Response
Purchases Search Locations Response
Update DID Destination Request
SIP Trunk List
Stats
Login Details
Auth Token
Message Details
Send Message Request Body
Message Body
Message Opt-Out Request
Opt Out
Inbound Message
EDRs
EDRs Response
DID in Cart
Purchased DIDs
Transaction
Get Transactions Response
Invoice
Get Invoices Response
Create SIP Trunk Request
Customer Profile
Account Default Destinations
Account Settings
Global Limits
Update Customer Info Request
Support Ticket Stats
Received Message
Message Content
Sender ID
Sender ID Registration Request
Registered Sender IDs
Sender ID Restrictions
E911 Detailed Address
E911 Address
E911 Record
List of E911 -enabled Numbers
E911 Validate Address Response
E911 Validate Address Request
Send Message Response
E911 Detailed Record
Voice Campaign
Initiate a Call Request
Number Format Response
Number Analysis Response
Number Validation Response
Validate Multiple Phone Numbers Request
Validate Multiple Phone Numbers Response
Validate Multiple Phone Numbers Async Response
Turn
Full Text Transcription
Call Transcription
Keywords and Phrases Filter
Transcription Search
Call Transcription Search Request
Call Transcription URL
Calls With Transcription
Call With Transcription
Transcribe a Single Call Request
Send High-Volume Traffic Response
Exceptions
Bad Request
Error
DID Checkout Error
Enumerations
Did Require Doc
Name
Status
Doc Status
Status 2
Transport
Type
DID Type
Outbound Message Delivery Status
Inbound Message Delivery Status
Transaction Status
Transaction Type
Support Ticket Status
Sender ID Type
E911 Address Validation Results
Disposition
Phone Number Validation Type
Transcription Status
Transcription Language
API Docs by
APIMATIC
Did Require Doc
Types of documents required for the DID activation
Fields
Name
Description
1
Any form of ID
2
Proof of address
3
Proof of local address