Changelog#

This changelog lists API changes introduced in version 2026-11-19.

New Endpoints#

The token service (auth.didww.com) now supports POST /token.

POST /token on the DIDWW token service exchanges an API key for a short-lived bearer access token.

What changed

  • Added POST https://auth.didww.com/token (Production) and POST https://auth-sandbox.didww.com/token (Sandbox).

  • The request is authenticated with an API key of the same environment in the Api-Key header and takes an application/json body.

  • Body parameters: aud (required; one service host or a list: api.didww.com, api-vin.didww.com, api-vout.didww.com, api-sms.didww.com), scope (full by default, or read), api_version (YYYY-MM-DD) and expires_in (seconds, default 900, clamped into 60–3600).

  • The 200 OK response returns access_token, token_type (Bearer), expires_in, aud, scope and api_version with Cache-Control: no-store and Pragma: no-cache.

  • Errors use the OAuth shape error / error_description: 400 (invalid_request, invalid_scope), 401 (invalid_client) and 429 (rate_limit_exceeded, with Retry-After).

Behavior notes

  • A token is accepted only in the environment that minted it and only by the services listed in its aud. Sandbox services use the production host names as audiences.

  • A read: value that is not known is granted as its closest known ancestor; compare scope in the response with the one requested.

  • Tokens cannot be refreshed. Mint a new token before expires_in runs out.

Affected resources

Read, write, update, and delete endpoints have been added for /v3/sms_trunks.

/v3/sms_trunks read, create, update, and delete endpoints are available.

What changed

  • Added GET /v3/sms_trunks.

  • Added GET /v3/sms_trunks/{id}.

  • Added POST /v3/sms_trunks.

  • Added PATCH /v3/sms_trunks/{id}.

  • Added DELETE /v3/sms_trunks/{id}.

  • SMS trunk responses include name, external_reference_id, blocked, priority, allow_any_did_as_source, allow_in, allow_out, configuration, created_at, and updated_at.

  • configuration.type is one of sms_to_email, http_in, http_out, smpp_esme, and smpp_smsc.

  • Supported relationships are outgoing_dids, incoming_dids, sms_trunk_group, and sender_id_verifications.

  • Collection filters include id, name, external_reference_id, and configuration.type.

  • Collection sorting includes name, external_reference_id, blocked, priority, allow_in, allow_out, created_at, and updated_at.

  • Pagination defaults to 50 records per page, with a maximum of 100.

Behavior notes

  • The configuration type cannot be changed after creation. On PATCH, configuration.type must match, and only the configuration attributes sent are written.

  • smpp_esme trunks return a generated system_id and password. http_out trunks return a generated auth_name and auth_password.

  • http_out trunks return meta.host, the full URL of the endpoint to which outbound messages are submitted.

  • priority and sms_trunk_group apply to sms_to_email, http_in, smpp_esme, and smpp_smsc trunks. On http_out trunks priority stays null.

  • Enabling allow_any_did_as_source removes all outgoing_dids.

  • incoming_dids is read-only. DIDs are routed to a trunk through the DID sms_trunk relationship.

  • DELETE returns 422 while any DID is routed to the trunk.

  • SMS trunks and SMS trunk groups share one account limit. When it is reached, POST returns 400 with the title Quota limit reached.

Affected resources

Read, write, update, and delete endpoints have been added for /v3/sms_trunk_groups.

/v3/sms_trunk_groups read, create, update, and delete endpoints are available.

What changed

  • Added GET /v3/sms_trunk_groups.

  • Added GET /v3/sms_trunk_groups/{id}.

  • Added POST /v3/sms_trunk_groups.

  • Added PATCH /v3/sms_trunk_groups/{id}.

  • Added DELETE /v3/sms_trunk_groups/{id}.

  • SMS trunk group responses include name, external_reference_id, created_at, updated_at, and meta.sms_trunks_count.

  • Supported relationships are sms_trunks and incoming_dids.

  • Collection filters include id, name, and external_reference_id.

  • Collection sorting includes name, external_reference_id, created_at, and updated_at.

Behavior notes

  • Sending sms_trunks replaces the whole membership of the group.

  • Only sms_to_email, http_in, smpp_esme, and smpp_smsc trunks can be members.

  • DELETE also deletes every trunk in the group, and returns 422 while any DID is routed to the group or to one of its trunks.

  • incoming_dids is read-only. DIDs are routed to a group through the DID sms_trunk_group relationship.

Affected resources

A write endpoint has been added at /v3/sms_trunk_regenerate_credentials.

/v3/sms_trunk_regenerate_credentials write endpoint is available.

What changed

  • Added POST /v3/sms_trunk_regenerate_credentials with the required sms_trunk relationship.

  • smpp_esme trunks receive a new system_id and password. http_out trunks receive a new auth_name and auth_password.

Behavior notes

  • The 201 response contains only the trunk ID. Retrieve the trunk to read the new credentials.

  • Other trunk types return 422.

Affected resources

Read and update endpoints have been added for /v3/sender_id_verifications.

/v3/sender_id_verifications lists the Sender ID verifications of the account and updates them.

What changed

  • Added GET /v3/sender_id_verifications and GET /v3/sender_id_verifications/{id}.

  • Added PATCH /v3/sender_id_verifications/{id}, which changes the name, or the SMS trunk outbound messages are routed through. Send sms_trunk with data: null to unassign the trunk.

Behavior notes

  • A closed verification cannot be updated.

Affected resources

Inbound call prices are now available for audience api-vin.didww.com.

Inbound call price lookups and the inbound call price file are available from the Inbound Call Rates service.

What changed

  • Added GET /v3/lookup/prices on host api-vin.didww.com (Sandbox: api-vin-sandbox.didww.com).

  • Added GET and HEAD /v3/prices.csv.gz on the same host, which return the gzipped CSV file voice_in_prices.csv.gz.

  • filter[number] is required. filter[src_country_iso] is optional.

  • The lookup returns resources of type prices with destination, country, src_country_name, source_type, rate, connection_fee, initial_interval, next_interval, and reject_calls, plus meta.total_records.

Behavior notes

  • Requests require a bearer access token whose aud lists api-vin.didww.com. The read scope is enough.

  • data is never empty: no match returns 404 price_not_found.

  • sort, page, fields, include, and unknown parameters return 400.

  • The file supports If-Modified-Since (304) and returns 503 serving_failure with Retry-After when it cannot be served.

  • An account with no price plan receives 404 price_plan_not_assigned. Rate-limited requests receive 429 with Retry-After.

Affected resources

Outbound call prices are now available for audience api-vout.didww.com.

Outbound call price lookups, including scheduled price changes, and the outbound call price file are available from the Outbound Call Rates service.

What changed

  • Added GET /v3/lookup/prices on host api-vout.didww.com (Sandbox: api-vout-sandbox.didww.com).

  • Added GET and HEAD /v3/prices.csv.gz on the same host, which return the gzipped CSV file voice_out_prices.csv.gz.

  • filter[number] is the only supported filter.

  • The lookup returns resources of type prices with category, country, network, prefix, rate, connection_fee, initial_increment, recurring_increment, reject_calls, next_rate, next_connection_fee, next_initial_increment, next_recurring_increment, effective_at, and comment, plus meta.total_records.

Behavior notes

  • Requests require a bearer access token whose aud lists api-vout.didww.com. The read scope is enough.

  • The price file lists prefixes that open within 30 days as New Breakout, and prices that end within 30 days with no price of the same prefix taking over as Removed.

  • Any filter other than number, including filter[src_country_iso], returns 400.

Affected resources

SMS prices are now available for audience api-sms.didww.com.

SMS IN and SMS OUT (A2P, P2P, OTP) price lookups and price files are available from the SMS Rates service.

What changed

  • Added GET /v3/sms_in/lookup/prices and GET /v3/sms_out/{a2p|p2p|otp}/lookup/prices on host api-sms.didww.com (Sandbox: api-sms-sandbox.didww.com).

  • Added GET and HEAD /v3/sms_in/prices.csv.gz (sms_in_prices.csv.gz) and /v3/sms_out/{a2p|p2p|otp}/prices.csv.gz (sms_out_a2p_prices.csv.gz, sms_out_p2p_prices.csv.gz, sms_out_otp_prices.csv.gz).

  • Lookups accept filter[dst_number], filter[dst_country_iso], or both. At least one is required.

  • SMS OUT prices return source_prefix, destination_prefix, country, mcc, mcc_name, mnc, mnc_name, reject_sms, and price. SMS IN prices return source_prefix, source_number_length_min, source_number_length_max, destination_prefix, destination_number_length_min, destination_number_length_max, country, and price.

Behavior notes

  • Requests require a bearer access token whose aud lists api-sms.didww.com. The read scope is enough.

  • Each SMS domain has its own price plan. An account without a plan in a domain receives 404 price_plan_not_assigned from that domain.

Affected resources

Breaking Changes#

Requests are authenticated with bearer access tokens instead of the Api-Key header.

Version 2026-11-19 authenticates requests with Authorization: Bearer <access token>.

Why this is a breaking change

Requests that send an API key in the Api-Key header are refused with 401 Unauthorized in version 2026-11-19.

What changed

  • Every operation on api.didww.com requires an access token minted with POST /token on the token service.

  • Exceptions: GET /v3/exports/{filename}.csv.gz accepts either an access token or an API key; GET /v3/public_keys requires no authentication.

  • A refused access token returns 401 Unauthorized with WWW-Authenticate: Bearer error="invalid_token".

  • A read token is refused every method except GET and HEAD with 403 Forbidden and WWW-Authenticate: Bearer error="insufficient_scope".

Affected resources

Upgrade

  • Keep the API key on the server and use it only to call POST /token on the token service of the same environment.

  • Request aud: api.didww.com (add other service hosts if the integration calls them), the narrowest scope you need, and api_version: 2026-11-19.

  • Send Authorization: Bearer <access_token> instead of Api-Key on every API request.

  • Mint a new token before expires_in runs out, and mint a new one when a request returns 401 with WWW-Authenticate: Bearer error="invalid_token".

The API version is selected by the access token’s api_version claim.

For bearer requests, the version is the api_version of the access token, not the X-DIDWW-API-Version header.

Why this is a breaking change

Integrations that select a version with X-DIDWW-API-Version no longer control the version of bearer requests with that header.

What changed

  • The version of a request is the api_version requested when the token was minted. If it is omitted, the token carries the default version of the account, or the current default version of the platform when the account has none.

  • A well-formed version name that the API does not know selects the newest version.

  • An access token is never served a version older than 2026-11-19 or older than the account’s default version.

  • X-DIDWW-API-Version still selects the version of API-key requests in versions up to 2026-04-16. An API-key request whose version resolves to 2026-11-19 is refused with 401 Unauthorized.

Affected resources

Upgrade

  • Set api_version explicitly when minting tokens and check meta.api_version in responses.

The /v3/did_group_types endpoint has been removed.

/v3/did_group_types is no longer available. The number type is returned in the number_type attribute of the resources that used the relationship.

Why this is a breaking change

Requests sent to the DID group types endpoints are no longer valid.

What changed

  • Removed GET /v3/did_group_types and GET /v3/did_group_types/{id}. Requests to these paths return 400 Bad Request.

  • The did_group_type relationship is replaced by the number_type attribute on DID groups, address requirements, emergency requirements, and emergency calling services.

Affected resources

Upgrade

  • Stop calling /v3/did_group_types. Use the number_type values local, national, mobile, toll_free, shared_cost, and global instead of DID group type IDs.

The did_group_type relationship on /v3/did_groups has been replaced with the number_type attribute.

/v3/did_groups returns the number type in the number_type attribute instead of the did_group_type relationship.

Why this is a breaking change

Integrations that include, filter, sort, or read the did_group_type relationship must switch to number_type.

What changed

  • Added the read-only number_type attribute. Possible values: local, national, mobile, toll_free, shared_cost, global.

  • Removed the did_group_type relationship. include=did_group_type, filter[did_group_type.id], sort=did_group_type.name, and did_group_type in fields[did_groups] return 400 Bad Request.

  • Added filter[number_type]. It accepts a comma-separated list and matches any listed value.

  • Added number_type and -number_type sort values.

  • GET /v3/dids and GET /v3/dids/{id} no longer accept include=did_group.did_group_type.

Affected resources

Upgrade

  • Replace filter[did_group_type.id]=<id> with filter[number_type]=<value>, sort=did_group_type.name with sort=number_type, and read attributes.number_type instead of the included DID group type.

The did_group_type.id filter on /v3/available_dids has been replaced with did_group.number_type.

/v3/available_dids filters by number type with did_group.number_type.

Why this is a breaking change

Requests that use filter[did_group_type.id] are no longer accepted.

What changed

  • Removed filter[did_group_type.id]. Requests that send it return 400 Bad Request.

  • Added filter[did_group.number_type]. It accepts a comma-separated list of local, national, mobile, toll_free, shared_cost, global.

  • Included DID groups return number_type and is_demo and no longer carry did_group_type.

Affected resources

Upgrade

  • Replace filter[did_group_type.id]=<id> with filter[did_group.number_type]=<value>.

The did_group_type relationship on /v3/address_requirements, /v3/emergency_requirements, and /v3/emergency_calling_services has been replaced with the number_type attribute.

Address requirements, emergency requirements, and emergency calling services return the number type as the number_type attribute instead of the did_group_type relationship.

Why this is a breaking change

Requests that include, filter by, or request sparse fields of did_group_type are no longer valid, and responses no longer contain the did_group_type relationship.

What changed

  • Added the read-only attribute number_type with possible values local, national, mobile, toll_free, shared_cost, and global.

  • Removed the did_group_type relationship from address_requirements, emergency_requirements, and emergency_calling_services.

  • Replaced the filter did_group_type.id with number_type on GET /v3/address_requirements, GET /v3/emergency_requirements, and GET /v3/emergency_calling_services. The filter accepts a comma-separated list of values.

  • include=did_group_type, filter[did_group_type.id], and did_group_type in fields[...] return 400 Bad Request.

Affected resources

Upgrade

  • Read number_type instead of resolving the did_group_type relationship.

  • Replace filter[did_group_type.id]=<id> with filter[number_type]=<value>.

  • Remove did_group_type from include and fields[...] parameters.

The pop relationship on /v3/voice_in_trunks has been replaced with the pop attribute. The /v3/pops endpoint has been removed.

/v3/voice_in_trunks sets and returns the Point of Presence as the string attribute pop, and GET /v3/pops is no longer available.

Why this is a breaking change

Requests that send pop as a relationship, include pop, or call /v3/pops are no longer valid, and responses no longer contain the pop relationship.

What changed

  • Added the nullable attribute pop with possible values nyc, fra, lac, mia, sg, hk, ams, or null. null lets DIDWW choose.

  • POST /v3/voice_in_trunks and PATCH /v3/voice_in_trunks/{id} accept pop in attributes. Any other value returns 422 Unprocessable Entity.

  • Removed the pop relationship and the include=pop value. GET /v3/dids and GET /v3/dids/{id} no longer accept include=voice_in_trunk.pop.

  • GET /v3/pops returns 400 Bad Request.

Affected resources

Upgrade

  • Send "pop": "<code>" (or null) in attributes instead of a pop relationship with a POP ID.

  • Read the pop attribute instead of the pop relationship or included pops resources.

  • Stop calling /v3/pops and replace stored POP IDs with the POP codes listed above.

The codec_ids attribute on /v3/voice_in_trunks has been replaced with codecs.

The configuration of a SIP inbound trunk lists its codecs by name, in priority order.

Why this is a breaking change

Requests that send codec_ids are no longer valid, and responses no longer contain it.

What changed

  • Replaced the numeric codec_ids with codecs, a list of names. The first codec has the highest priority.

  • amr and amr_wb have been added to the values.

  • codecs is optional on POST /v3/voice_in_trunks. It defaults to pcmu, pcma, g729, g723, telephone_event.

Affected resources

Upgrade

  • Send codecs instead of codec_ids, and map stored ids to the names on the Codecs page.

  • Read codecs from responses.

The mandatory fields of /v3/address_requirements list tax_id and are never null.

business_mandatory_fields names a VAT number as tax_id. personal_mandatory_fields and business_mandatory_fields return an empty array when no field is mandatory.

Why this is a breaking change

Clients that compare these values with vat_id, or that check them for null, no longer match the response.

What changed

  • vat_id in business_mandatory_fields is now tax_id. The identity attribute is still vat_id.

  • Both lists are arrays, empty when none are mandatory, and are never null.

Affected resources

Upgrade

  • Fill the identity attribute vat_id when business_mandatory_fields contains tax_id.

  • Treat an empty array as no mandatory fields.

The mandatory fields of /v3/emergency_requirements are API names instead of labels.

personal_mandatory_fields, business_mandatory_fields and address_mandatory_fields return API names rather than human-readable labels.

Why this is a breaking change

Clients that compare these values with labels such as Birth Date no longer match the response.

What changed

  • Identity fields are birth_date, country, id_number, personal_tax_id, tax_id, company_reg_number, and contact_email.

  • The address field is area.

Affected resources

Upgrade

  • Compare these values with the API names. tax_id is the identity attribute vat_id.

The entity_type values of /v3/proof_types are lowercase.

entity_type and its filter use address, business, and personal.

Why this is a breaking change

Clients that compare these values, or that filter by them, in the previous spelling no longer match.

What changed

  • Address, Business, and Personal are now address, business, and personal, in responses and in filter[entity_type].

Affected resources

Upgrade

  • Send and compare the lowercase values.

The media type of the 201 Created response to POST /v3/encrypted_files has changed to application/vnd.api+json.

POST /v3/encrypted_files returns its 201 Created response with Content-Type: application/vnd.api+json.

Why this is a breaking change

Clients that check for application/json on a successful upload no longer match the response.

What changed

  • The 201 Created response of POST /v3/encrypted_files is sent as application/vnd.api+json instead of application/json. The response body is unchanged.

Affected resources

Upgrade

  • Accept application/vnd.api+json as the media type of a successful upload response.

The dids relationship on /v3/voice_out_trunks rejects DIDs awaiting registration.

/v3/voice_out_trunks no longer accepts a DID that is awaiting registration as an allowed CLI.

Why this is a breaking change

A create or update request that assigns such a DID in the dids relationship fails with 422 Unprocessable Entity.

What changed

  • POST /v3/voice_out_trunks and PATCH /v3/voice_out_trunks/{id} return 422 Unprocessable Entity when the dids relationship contains a DID whose awaiting_registration is true.

  • The response contains one error per rejected DID, with source.pointer /data/relationships/dids/<DID ID>.

Affected resources

Upgrade

  • Assign a DID as an allowed CLI only after its registration is approved (awaiting_registration is false).

The Source column in cdr_in files from /v3/exports has been replaced with Source Number and Source Number Out.

cdr_in export files no longer contain the Source column.

Why this is a breaking change

Integrations that read the Source column by name or by position must be updated: the column is replaced, and new columns shift the positions of the columns that follow it.

What changed

  • Removed the Source column from cdr_in export files.

  • Added Source Number: the caller number as it reached DIDWW.

  • Added Source Number Out: the caller number as delivered to the trunk. It holds the value previously returned in Source.

  • Added Source Country and Source Network: the country and network of the caller number.

  • Column order after the time columns: Status, Source Number, Source Number Out, Source Name, Source Country, Source Network, Destination DID, followed by the remaining columns unchanged.

Affected resources

Upgrade

  • Read the caller number from Source Number Out instead of Source.

  • Map CSV columns by header name rather than by position.

Enhancements#

The is_demo attribute has been added to /v3/did_groups.

/v3/did_groups now exposes the is_demo attribute.

What changed

  • Added the read-only is_demo boolean attribute.

  • Added filter[is_demo] and the is_demo and -is_demo sort values.

  • fields[did_groups] accepts number_type and is_demo.

Affected resources

The sms_trunk and sms_trunk_group relationships have been added to /v3/dids.

/v3/dids routes inbound SMS to an SMS trunk or an SMS trunk group.

What changed

  • Added the sms_trunk and sms_trunk_group to-one relationships to DID responses.

  • include, fields[dids], and the new filter[sms_trunk.id] and filter[sms_trunk_group.id] accept them.

  • PATCH /v3/dids/{id} accepts both relationships.

Behavior notes

  • A DID routes inbound SMS to one SMS trunk or one SMS trunk group. Assigning one replaces the other. Sending both with an ID in one request returns 422 Unprocessable Entity.

  • The SMS trunk must accept inbound SMS. A trunk with the http_out configuration type is rejected with 422.

  • The DID group must support inbound SMS. Otherwise the request returns 422.

  • "data": null clears the route only when the DID is currently routed through that relationship.

Affected resources

The company_website attribute has been added to /v3/identities.

/v3/identities now exposes the company_website attribute.

What changed

  • Added the nullable attribute company_website.

  • POST /v3/identities and PATCH /v3/identities/{id} accept company_website for business identities. A personal identity rejects it with 422 Unprocessable Entity.

  • Added the filters company_website (exact match) and company_website_contains, and the sort value company_website.

  • company_website can be requested with fields[identities].

Behavior notes

  • Once the identity is in use, for example linked to DIDs or to a verification, a stored company_website cannot be changed or removed, and the request returns 422 Unprocessable Entity.

Affected resources

The sms_in and sms_out export types have been added to /v3/exports.

/v3/exports exports inbound and outbound SMS records.

What changed

  • export_type accepts sms_in (inbound message records) and sms_out (outbound message records) in addition to cdr_in and cdr_out.

  • from and to are required for both types, with the same range rules as CDR exports.

  • Both types accept source_address_eq, source_address_cont, destination_address_eq, destination_address_cont, status, sms_trunk.id, and sms_id.

  • sms_in also accepts trunk_type (smpp_smsc, smpp_esme, sms_to_email, http_in).

  • sms_out also accepts service_type (p2p or a2p) and sender_id_verification.id.

  • SMS exports follow the same lifecycle as CDR exports: statuses, external_reference_id, callbacks (callback_url, callback_method) that include the download URL, and a .csv.gz download.

Behavior notes

  • The sms_out file contains the Sender ID Verification column only for accounts with A2P messaging enabled.

Affected resources

The source_number, source_number_out, and source_country_iso filters have been added for cdr_in exports in /v3/exports.

cdr_in exports can be limited by caller number and caller country.

What changed

  • Added the optional source_number filter: the caller number as it reached DIDWW.

  • Added the optional source_number_out filter: the caller number as delivered to the trunk.

  • Added the optional source_country_iso filter: an upper-case ISO 3166-1 alpha-2 country code, for example GB.

Affected resources

The source, cli, and destination filters have been added for cdr_out exports in /v3/exports.

cdr_out exports can be limited by source number, CLI, and destination number.

What changed

  • Added the optional source, cli, and destination filters. They match the Source, CLI, and Destination Number file columns exactly.

Affected resources

The created_at_gteq, created_at_lteq, export_type, and status filters have been added to GET /v3/exports.

The export collection can be filtered by creation time, export type, and status.

What changed

  • Added filter[created_at_gteq] and filter[created_at_lteq].

  • Added filter[export_type] with values cdr_in, cdr_out, sms_in, and sms_out.

  • Added filter[status] with values pending, processing, and completed.

Affected resources

The codecs attribute has been added to /v3/voice_out_trunks.

Outbound trunks list their codecs by name, in priority order.

What changed

  • Added codecs, a list of names. The first codec has the highest priority.

  • The values are telephone_event, g723, g729, pcmu, pcma, gsm, g722, opus, amr, and amr_wb.

  • codecs defaults to pcma, pcmu, telephone_event.

Affected resources

ICE and RTCP modes have been added to /v3/voice_in_trunks and /v3/voice_out_trunks.

Trunks set how ICE, RTCP multiplexing, and RTCP feedback are handled on their calls.

What changed

  • Added ice_mode, rtcp_mux_mode, and rtcp_feedback_mode, with the values disabled, accept, and initiate.

  • On inbound trunks these attributes are part of the SIP configuration and default to disabled.

  • On outbound trunks they default to accept.

Affected resources

Operations answer 429 Too Many Requests with Retry-After.

Requests spend the account’s rate-limit budget. Once it is spent, the answer is 429 with Retry-After.

What changed

  • The operations that can answer 429 list it in their responses.

  • Retry-After says how many seconds to wait.

Affected resources

GET /v3/exports/{filename}.csv.gz accepts bearer access tokens.

The export file download accepts an access token as well as an API key.

What changed

  • The download accepts Authorization: Bearer <access token>, like every other request in this version.

  • The download also accepts an API key in the Api-Key header.

Affected resources