API Resources Summary

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 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
balance	GET	Returns the prepaid balance as well as the available credit on the account.
cities	GET	Returns a list of cities included in the current DIDWW inventory, or returns the details of a specific city.
countries	GET	Returns a list of countries included in the current DIDWW inventory, or return the details of a specific country.
dids	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.
did_history	GET	Returns a list of DID history records or a single DID history record.
did_groups	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.
did_group_types	GET	Returns a list of the various types of DIDs supported by DIDWW (for example, mobile, toll-free, SMS).
capacity_pools	GET, PATCH	Returns a list of the Capacity Pools which include information about channels quantity, supported Countries, Shared Capacity Groups.
shared_capacity_groups	GET, POST, PATCH, DELETE	Returns a list of the Capacity Groups assigned to Capacity Pool.
export	GET, POST, PATCH	Returns call detail record (CDR) exports, creates a new export, or updates an existing export.
orders	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.
regions	GET	Returns a list of regions (for example, states within the USA) included in the current DIDWW inventory.
voice_in_trunks	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.
voice_out_trunks	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.
emergency_calling_services	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.
voice_in_trunk_groups	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.
available_dids	GET	Returns a list of available DID numbers in the current DIDWW coverage.
did_reservation	GET, POST, DELETE	Returns a list or a single DID reservations for the account.
address_verifications	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.
addresses	GET, POST, PATCH, DELETE	Returns the details of a address, create a new address, modify address settings, or delete an address.
encrypted_files	GET, POST, DELETE	Returns the details of a encrypted file, create a new encrypted file, or delete an encrypted file.
identities	GET, POST, PATCH, DELETE	Returns the details of a identity, create a new identity, modify identity settings, or delete an identity.
permanent_supporting_documents	GET, POST, DELETE	Returns a list of permanent supporting documents or the details of a single permanent supporting document, creates a new permanent supporting document, or deletes a permanent supporting document.
proof_types	GET	Returns a list or a single proof_types for the account.
proofs	GET, POST, DELETE	Returns a list of proofs or the details of a single proof, creates a new proof, or deletes a proof.
address_requirements	GET	Returns a list or a single address requirement for the account.
emergency_requirements	GET	Returns a list of emergency requirements for the account.
emergency_requirement_validations	POST	Checks whether an address and / or identity is valid against an emergency requirement.
emergency_verifications	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.
supporting_document_templates	GET	Returns a list or a single supporting document templates for the account.
areas	GET	Returns a list or a single regulatory area.
nanpa_prefixes	GET	Returns a list NANPA prefixes or a single NANPA prefix.