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) andPOST https://auth-sandbox.didww.com/token(Sandbox).The request is authenticated with an API key of the same environment in the
Api-Keyheader and takes anapplication/jsonbody.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(fullby default, orread),api_version(YYYY-MM-DD) andexpires_in(seconds, default900, clamped into60–3600).The
200 OKresponse returnsaccess_token,token_type(Bearer),expires_in,aud,scopeandapi_versionwithCache-Control: no-storeandPragma: no-cache.Errors use the OAuth shape
error/error_description:400(invalid_request,invalid_scope),401(invalid_client) and429(rate_limit_exceeded, withRetry-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; comparescopein the response with the one requested.Tokens cannot be refreshed. Mint a new token before
expires_inruns 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, andupdated_at.configuration.typeis one ofsms_to_email,http_in,http_out,smpp_esme, andsmpp_smsc.Supported relationships are
outgoing_dids,incoming_dids,sms_trunk_group, andsender_id_verifications.Collection filters include
id,name,external_reference_id, andconfiguration.type.Collection sorting includes
name,external_reference_id,blocked,priority,allow_in,allow_out,created_at, andupdated_at.Pagination defaults to
50records per page, with a maximum of100.
Behavior notes
The configuration type cannot be changed after creation. On
PATCH,configuration.typemust match, and only the configuration attributes sent are written.smpp_esmetrunks return a generatedsystem_idandpassword.http_outtrunks return a generatedauth_nameandauth_password.http_outtrunks returnmeta.host, the full URL of the endpoint to which outbound messages are submitted.priorityandsms_trunk_groupapply tosms_to_email,http_in,smpp_esme, andsmpp_smsctrunks. Onhttp_outtrunksprioritystaysnull.Enabling
allow_any_did_as_sourceremoves alloutgoing_dids.incoming_didsis read-only. DIDs are routed to a trunk through the DIDsms_trunkrelationship.DELETEreturns422while any DID is routed to the trunk.SMS trunks and SMS trunk groups share one account limit. When it is reached,
POSTreturns400with the titleQuota 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, andmeta.sms_trunks_count.Supported relationships are
sms_trunksandincoming_dids.Collection filters include
id,name, andexternal_reference_id.Collection sorting includes
name,external_reference_id,created_at, andupdated_at.
Behavior notes
Sending
sms_trunksreplaces the whole membership of the group.Only
sms_to_email,http_in,smpp_esme, andsmpp_smsctrunks can be members.DELETEalso deletes every trunk in the group, and returns422while any DID is routed to the group or to one of its trunks.incoming_didsis read-only. DIDs are routed to a group through the DIDsms_trunk_grouprelationship.
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_credentialswith the requiredsms_trunkrelationship.smpp_esmetrunks receive a newsystem_idandpassword.http_outtrunks receive a newauth_nameandauth_password.
Behavior notes
The
201response 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_verificationsandGET/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. Sendsms_trunkwithdata: nullto unassign the trunk.
Behavior notes
A
closedverification 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/priceson hostapi-vin.didww.com(Sandbox:api-vin-sandbox.didww.com).Added
GETandHEAD/v3/prices.csv.gzon the same host, which return the gzipped CSV filevoice_in_prices.csv.gz.filter[number]is required.filter[src_country_iso]is optional.The lookup returns resources of type
priceswithdestination,country,src_country_name,source_type,rate,connection_fee,initial_interval,next_interval, andreject_calls, plusmeta.total_records.
Behavior notes
Requests require a bearer access token whose
audlistsapi-vin.didww.com. Thereadscope is enough.datais never empty: no match returns404price_not_found.sort,page,fields,include, and unknown parameters return400.The file supports
If-Modified-Since(304) and returns503serving_failurewithRetry-Afterwhen it cannot be served.An account with no price plan receives
404price_plan_not_assigned. Rate-limited requests receive429withRetry-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/priceson hostapi-vout.didww.com(Sandbox:api-vout-sandbox.didww.com).Added
GETandHEAD/v3/prices.csv.gzon the same host, which return the gzipped CSV filevoice_out_prices.csv.gz.filter[number]is the only supported filter.The lookup returns resources of type
priceswithcategory,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, andcomment, plusmeta.total_records.
Behavior notes
Requests require a bearer access token whose
audlistsapi-vout.didww.com. Thereadscope 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 asRemoved.Any filter other than
number, includingfilter[src_country_iso], returns400.
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/pricesandGET/v3/sms_out/{a2p|p2p|otp}/lookup/priceson hostapi-sms.didww.com(Sandbox:api-sms-sandbox.didww.com).Added
GETandHEAD/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, andprice. SMS IN prices returnsource_prefix,source_number_length_min,source_number_length_max,destination_prefix,destination_number_length_min,destination_number_length_max,country, andprice.
Behavior notes
Requests require a bearer access token whose
audlistsapi-sms.didww.com. Thereadscope is enough.Each SMS domain has its own price plan. An account without a plan in a domain receives
404price_plan_not_assignedfrom 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.comrequires an access token minted withPOST /tokenon the token service.Exceptions:
GET /v3/exports/{filename}.csv.gzaccepts either an access token or an API key;GET /v3/public_keysrequires no authentication.A refused access token returns
401 UnauthorizedwithWWW-Authenticate: Bearer error="invalid_token".A
readtoken is refused every method exceptGETandHEADwith403 ForbiddenandWWW-Authenticate: Bearer error="insufficient_scope".
Affected resources
Upgrade
Keep the API key on the server and use it only to call
POST /tokenon the token service of the same environment.Request
aud: api.didww.com(add other service hosts if the integration calls them), the narrowestscopeyou need, andapi_version: 2026-11-19.Send
Authorization: Bearer <access_token>instead ofApi-Keyon every API request.Mint a new token before
expires_inruns out, and mint a new one when a request returns401withWWW-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_versionrequested 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-19or older than the account’s default version.X-DIDWW-API-Versionstill selects the version of API-key requests in versions up to2026-04-16. An API-key request whose version resolves to2026-11-19is refused with401 Unauthorized.
Affected resources
Upgrade
Set
api_versionexplicitly when minting tokens and checkmeta.api_versionin 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_typesandGET/v3/did_group_types/{id}. Requests to these paths return400 Bad Request.The
did_group_typerelationship is replaced by thenumber_typeattribute on DID groups, address requirements, emergency requirements, and emergency calling services.
Affected resources
Upgrade
Stop calling
/v3/did_group_types. Use thenumber_typevalueslocal,national,mobile,toll_free,shared_cost, andglobalinstead 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_typeattribute. Possible values:local,national,mobile,toll_free,shared_cost,global.Removed the
did_group_typerelationship.include=did_group_type,filter[did_group_type.id],sort=did_group_type.name, anddid_group_typeinfields[did_groups]return400 Bad Request.Added
filter[number_type]. It accepts a comma-separated list and matches any listed value.Added
number_typeand-number_typesort values.GET/v3/didsandGET/v3/dids/{id}no longer acceptinclude=did_group.did_group_type.
Affected resources
Upgrade
Replace
filter[did_group_type.id]=<id>withfilter[number_type]=<value>,sort=did_group_type.namewithsort=number_type, and readattributes.number_typeinstead 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 return400 Bad Request.Added
filter[did_group.number_type]. It accepts a comma-separated list oflocal,national,mobile,toll_free,shared_cost,global.Included DID groups return
number_typeandis_demoand no longer carrydid_group_type.
Affected resources
Upgrade
Replace
filter[did_group_type.id]=<id>withfilter[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_typewith possible valueslocal,national,mobile,toll_free,shared_cost, andglobal.Removed the
did_group_typerelationship fromaddress_requirements,emergency_requirements, andemergency_calling_services.Replaced the filter
did_group_type.idwithnumber_typeonGET/v3/address_requirements,GET/v3/emergency_requirements, andGET/v3/emergency_calling_services. The filter accepts a comma-separated list of values.include=did_group_type,filter[did_group_type.id], anddid_group_typeinfields[...]return400 Bad Request.
Affected resources
Upgrade
Read
number_typeinstead of resolving thedid_group_typerelationship.Replace
filter[did_group_type.id]=<id>withfilter[number_type]=<value>.Remove
did_group_typefromincludeandfields[...]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
popwith possible valuesnyc,fra,lac,mia,sg,hk,ams, ornull.nulllets DIDWW choose.POST/v3/voice_in_trunksandPATCH/v3/voice_in_trunks/{id}acceptpopinattributes. Any other value returns422 Unprocessable Entity.Removed the
poprelationship and theinclude=popvalue.GET/v3/didsandGET/v3/dids/{id}no longer acceptinclude=voice_in_trunk.pop.GET/v3/popsreturns400 Bad Request.
Affected resources
Upgrade
Send
"pop": "<code>"(ornull) inattributesinstead of apoprelationship with a POP ID.Read the
popattribute instead of thepoprelationship or includedpopsresources.Stop calling
/v3/popsand 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_idswithcodecs, a list of names. The first codec has the highest priority.amrandamr_wbhave been added to the values.codecsis optional onPOST/v3/voice_in_trunks. It defaults topcmu,pcma,g729,g723,telephone_event.
Affected resources
Upgrade
Send
codecsinstead ofcodec_ids, and map stored ids to the names on the Codecs page.Read
codecsfrom 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_idinbusiness_mandatory_fieldsis nowtax_id. The identity attribute is stillvat_id.Both lists are arrays, empty when none are mandatory, and are never
null.
Affected resources
Upgrade
Fill the identity attribute
vat_idwhenbusiness_mandatory_fieldscontainstax_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, andcontact_email.The address field is
area.
Affected resources
Upgrade
Compare these values with the API names.
tax_idis the identity attributevat_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, andPersonalare nowaddress,business, andpersonal, in responses and infilter[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 Createdresponse ofPOST/v3/encrypted_filesis sent asapplication/vnd.api+jsoninstead ofapplication/json. The response body is unchanged.
Affected resources
Upgrade
Accept
application/vnd.api+jsonas 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_trunksandPATCH/v3/voice_out_trunks/{id}return422 Unprocessable Entitywhen thedidsrelationship contains a DID whoseawaiting_registrationistrue.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_registrationisfalse).
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
Sourcecolumn fromcdr_inexport 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 inSource.Added
Source CountryandSource 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 Outinstead ofSource.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_demoboolean attribute.Added
filter[is_demo]and theis_demoand-is_demosort values.fields[did_groups]acceptsnumber_typeandis_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_trunkandsms_trunk_groupto-one relationships to DID responses.include,fields[dids], and the newfilter[sms_trunk.id]andfilter[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_outconfiguration type is rejected with422.The DID group must support inbound SMS. Otherwise the request returns
422."data": nullclears 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/identitiesandPATCH/v3/identities/{id}acceptcompany_websitefor business identities. A personal identity rejects it with422 Unprocessable Entity.Added the filters
company_website(exact match) andcompany_website_contains, and the sort valuecompany_website.company_websitecan be requested withfields[identities].
Behavior notes
Once the identity is in use, for example linked to DIDs or to a verification, a stored
company_websitecannot be changed or removed, and the request returns422 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_typeacceptssms_in(inbound message records) andsms_out(outbound message records) in addition tocdr_inandcdr_out.fromandtoare 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, andsms_id.sms_inalso acceptstrunk_type(smpp_smsc,smpp_esme,sms_to_email,http_in).sms_outalso acceptsservice_type(p2pora2p) andsender_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.gzdownload.
Behavior notes
The
sms_outfile contains theSender ID Verificationcolumn 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_numberfilter: the caller number as it reached DIDWW.Added the optional
source_number_outfilter: the caller number as delivered to the trunk.Added the optional
source_country_isofilter: an upper-case ISO 3166-1 alpha-2 country code, for exampleGB.
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, anddestinationfilters. They match theSource,CLI, andDestination Numberfile 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]andfilter[created_at_lteq].Added
filter[export_type]with valuescdr_in,cdr_out,sms_in, andsms_out.Added
filter[status]with valuespending,processing, andcompleted.
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, andamr_wb.codecsdefaults topcma,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, andrtcp_feedback_mode, with the valuesdisabled,accept, andinitiate.On inbound trunks these attributes are part of the SIP
configurationand default todisabled.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
429list it in their responses.Retry-Aftersays 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-Keyheader.
Affected resources