API Resources Summary
The DIDWW API allows you perform an extensive set of actions such as querying the DID coverage and inventory, ordering and configuring phone numbers and services, setting capacity and creating SIP trunks by using the following methods:
GET - Fetch data, where the data can be a collection or resources or an individual resource
POST - Create a new resource
PATCH - Update an existing resource
DELETE - Remove an existing resource
API Call |
Method/s |
Details |
GET |
Returns the prepaid balance as well as the available credit on the account. |
|
GET |
Returns a list of cities included in the current DIDWW inventory, or returns the details of a specific city. |
|
GET |
Returns a list of countries included in the current DIDWW inventory, or return the details of a specific country. |
|
GET, PATCH |
Returns a list of all of the DIDs owned by an account or the details for a single DID, or modify the settings for a single DID owned by an account. |
|
GET |
Returns a list of DID Groups, which is essentially a list of the current DIDWW coverage. DID Groups are phone numbers that share a common city or area code. |
|
GET |
Returns a list of the various types of DIDs supported by DIDWW (for example, mobile, toll-free, SMS). |
|
GET, PATCH |
Returns a list of the Capacity Pools which include information about channels quantity, supported Countries, Shared Capacity Groups. |
|
GET, POST, PATCH, DELETE |
Returns a list of the Capacity Groups assigned to Capacity Pool. |
|
GET, POST |
Returns a call detail records (CDRs) or create a CDR for export. |
|
GET, POST, DELETE |
Returns a list of the orders previously placed in this account, create a new order, or delete an order. |
|
GET |
Returns a list of regions (for example, states within the USA) included in the current DIDWW inventory. |
|
GET, POST, PATCH, DELETE |
Returns a list of all of the voice in trunks configured by this account, create a new trunk, modify the settings of an existing trunk, or delete a trunk. |
|
GET, POST, PATCH, DELETE |
Returns a list of all voice out trunks configured by this account, create a new trunk, modify the existing trunk, or delete a trunk. |
|
GET, POST, PATCH, DELETE |
Returns the details of a voice in trunk group, create a new trunk group, modify trunk group settings, or delete a trunk group. |
|
GET |
Returns a list of available DID numbers in the current DIDWW coverage. |
|
GET, POST, DELETE |
Returns a list or a single DID reservations for the account. |
|
GET, POST |
Returns a list or a single address verifications for the account. |
|
GET, POST, PATCH, DELETE |
Returns the details of a address, create a new address, modify address settings, or delete an address. |
|
GET, POST, DELETE |
Returns the details of a encrypted file, create a new encrypted file, or delete an encrypted file. |
|
GET, POST, PATCH, DELETE |
Returns the details of a identity, create a new identity, modify identity settings, or delete an identity. |
|
POST, DELETE |
Create a new permanent supporting document, or delete a permanent supporting document. |
|
GET |
Returns a list or a single proof_types for the account. |
|
POST, DELETE |
Create a new proof, or delete a proof. |
|
GET |
Returns a list or a single requirements for the account. |
|
GET |
Returns a list or a single supporting document templates for the account. |
|
GET |
Returns a list or a single regulatory area. |