canonical: https://jentic.com/apis/didww.com/didww # DIDWW Public API The DIDWW API browses telephony coverage, orders and manages DID phone numbers, and routes them to inbound and outbound voice trunks over a JSONAPI interface. Agents search coverage by country, region, city, and area, reserve numbers before purchase, place orders, and configure trunks and trunk groups. Account operations read the balance and request call-detail-record exports, and the API is versioned by dated releases selected per request. ## For AI agents Browse DID coverage, reserve and order phone numbers, and route them to voice trunks through DIDWW. Read the account balance and request call-detail-record exports over its JSONAPI interface. ## Scope Does not handle SMS messaging, call recording playback, or number portability filings. Use for DID provisioning and voice trunk routing only. ## Capabilities - Browse coverage by country, region, city, and area - List available DIDs and reserve a number before purchasing it - Order DIDs and track the order through to completion - Route DIDs to inbound and outbound voice trunks and trunk groups - Read the account balance and request call-detail-record exports - Review DID history and manage capacity and regulation records ## Use cases ### Provision a Phone Number An AI agent provisions a local number in a target market: it browses coverage for the country and city, lists available DIDs, reserves one so it cannot be taken, and places the order. The agent discovers the coverage, availability, reservation, and order operations through Jentic by intent, so it provisions a number without hardcoding endpoint paths. Example prompt: Browse coverage for a city, list available DIDs, reserve one, and create an order to purchase it ### Route Numbers to Trunks After purchasing DIDs, an agent wires them into the voice path. It creates an inbound voice trunk, groups trunks where needed, and updates a DID to point at the right trunk. DIDWW keeps trunks and DIDs as separate resources, so the agent configures routing by linking them. Example prompt: Create an inbound voice trunk and update a DID so its inbound calls route to that trunk ### Monitor Account and Usage A billing agent keeps an eye on spend and call activity. It reads the account balance, lists DID history, and requests a call-detail-record export to analyze usage offline. Because the export is created as a job, the agent requests it and retrieves the result when it is ready. Example prompt: Read the account balance, then request a CDR export and retrieve it once the export job completes ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/countries` | List coverage countries | | GET | `/did_groups` | List DID groups | | GET | `/available_dids` | List available DIDs | | POST | `/did_reservations` | Reserve a DID before purchase | | POST | `/orders` | Create an order | | GET | `/dids` | List DIDs on the account | | POST | `/voice_in_trunks` | Create an inbound voice trunk | | GET | `/balance` | Read the account balance | ## Key resources - **Coverage** — List countries, regions, cities, areas, and DID group types - **DIDs and reservations** — List available DIDs, reserve numbers, and manage purchased DIDs - **Orders** — Create, read, update, and cancel orders for DIDs - **Voice trunks** — Create and manage inbound and outbound voice trunks and trunk groups - **Account** — Read the balance, DID history, and request CDR exports ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 66 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 74 / 100 - Developer Experience & Jentic Compatibility: 66 / 100 - AI-Readiness & Agent Experience: 56 / 100 - Agent Usability: 83 / 100 - Security: 50 / 100 - AI Discoverability: 81 / 100 - **View full report:** https://jentic.com/apis/didww.com/didww/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring DIDWW by hand means issuing an API key, sending it in the api-key header, selecting the dated API version with a version header, and working through its JSONAPI request and response shapes. Through Jentic you install once, import DIDWW from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** You choose which DIDWW operations your agent may call, so you can allow coverage browsing and DID reservations while leaving order creation, trunk changes, and deletions out unless you add them. That keeps purchasing and routing changes off the table until you allow them. - **Credential handling:** Your DIDWW key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as list available phone numbers or route a DID to a trunk, and Jentic returns the matching DIDWW operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **SureVoIP** — SureVoIP provides UK VoIP and telephony services; DIDWW focuses on global DID coverage and voice trunk routing. - **VoIPstudio** — VoIPstudio is a hosted cloud phone system; DIDWW supplies the DID numbers and trunks that a phone system can route. - **The SMS Works** — The SMS Works sends and receives SMS; DIDWW covers the voice and number-provisioning side. ## FAQ ### What authentication does the DIDWW API use? The DIDWW API authenticates with an API key sent in the api-key request header, per its OpenAPI spec, and a dated API version is selected with a version header on each request. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never lands in the agent's prompt or logs. ### Can I buy phone numbers with the DIDWW API? Yes. Browse coverage to find numbers, list the available DIDs, reserve one so it is held for you, and create an order to purchase it. The reservation step keeps a number from being taken while the order is placed. ### What are the rate limits for the DIDWW API? The OpenAPI spec does not publish numeric rate limits for the DIDWW API. Check DIDWW's own API documentation for current limits, which its versioning and authentication guides link out to. ### Can I limit what my agent is allowed to do with the DIDWW API? Yes. Write a rule that allows only coverage browsing and DID reservations, so the agent can research and hold numbers while order creation, trunk changes, and deletions stay out unless you add them. Every call the agent makes is logged. ### How do I provision a number with the DIDWW API through Jentic? Search Jentic for an intent like provision a phone number, store your DIDWW key once, and your agent browses coverage, reserves a DID, and creates the order in sequence. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Is there a DIDWW MCP server? You don't need an MCP server to give your agent the DIDWW API. Jentic connects it directly from the API Directory: import it, store your key once, and your agent calls the operations it needs on demand.