API Resources Summary v2026-11-19#
The DIDWW API allows you to perform an extensive set of actions such as querying the DID coverage and inventory, ordering and configuring phone numbers and services, setting capacity, creating SIP and SMS trunks, and looking up prices by using the following methods:
GET - Fetch data, where the data can be a collection or resources or an individual resource
HEAD - Fetch only the headers of a price file
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 history records or a single DID history record. |
|
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, 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, PATCH |
Returns exports of call and message records, creates a new export, or updates an existing export. |
|
GET, POST, PATCH, DELETE |
Returns a list of the orders previously placed in this account, creates a new order, updates an existing order, or deletes 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 inbound 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 outbound trunks configured by this account, create a new trunk, modify the existing trunk, or delete a trunk. |
|
POST |
Regenerates the username and password of an outbound trunk that uses the |
|
GET, DELETE |
Returns a list of Emergency Calling Services configured by the account, returns the details of a single service, or cancels an existing service. |
|
GET, POST, PATCH, DELETE |
Returns the details of an inbound trunk group, create a new trunk group, modify trunk group settings, or delete a trunk group. |
|
GET, POST, PATCH, DELETE |
Returns a list of all SMS trunks configured by this account, creates a new SMS trunk, modifies an existing SMS trunk, or deletes an SMS trunk. |
|
POST |
Regenerates the credentials of an SMPP ESME or HTTP OUT SMS trunk. |
|
GET, POST, PATCH, DELETE |
Returns a list of SMS trunk groups, creates a new SMS trunk group, modifies an existing group or replaces its member trunks, or deletes a group. |
|
GET, PATCH |
Returns a list of Sender ID verifications or the details of a single one, or updates a verification. |
|
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, PATCH |
Returns a list of address verifications, the details of a single address verification, creates a new address verification, or updates an existing address verification. |
|
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 |
Returns a list of RSA public keys used to encrypt files. |
|
GET, POST, PATCH, DELETE |
Returns the details of a identity, create a new identity, modify identity settings, or delete an identity. |
|
GET, POST, PATCH, DELETE |
Returns a list of permanent supporting documents or the details of a single permanent supporting document, creates a new permanent supporting document, updates an existing permanent supporting document, or deletes a permanent supporting document. |
|
GET |
Returns a list or a single proof_types for the account. |
|
GET, POST, PATCH, DELETE |
Returns a list of proofs or the details of a single proof, creates a new proof, updates an existing proof, or deletes a proof. |
|
GET |
Returns a list or a single address requirement for the account. |
|
POST |
Checks whether an address and / or identity is valid against an address requirement. |
|
GET |
Returns a list of emergency requirements for the account. |
|
POST |
Checks whether an address and / or identity is valid against an emergency requirement. |
|
GET, POST, PATCH |
Returns a list of Emergency Verifications, the details of a single Emergency Verification, creates a new Emergency Verification task, or updates an existing Emergency Verification. |
|
GET |
Returns a list or a single supporting document templates for the account. |
|
GET |
Returns a list or a single regulatory area. |
|
GET |
Returns a list NANPA prefixes or a single NANPA prefix. |
|
POST |
Mints an access token on the token service ( |
|
GET, HEAD |
Looks up the inbound call prices of a number, or downloads the inbound call price file ( |
|
GET, HEAD |
Looks up the outbound call prices of a number, or downloads the outbound call price file ( |
|
GET, HEAD |
Looks up SMS IN and SMS OUT prices of a number or a country, or downloads the SMS price files ( |