SMS Prices#
Note
For more information about SMS services in DIDWW, see Messaging.
Use the SMS Prices resource to read what SMS cost, as priced by the SMS plans assigned to your DIDWW account.
SMS prices are served by the SMS Rates service:
Environment |
Base URL |
|---|---|
Production |
|
Sandbox |
|
The access token must list api-sms.didww.com in its aud, on the sandbox host as well.
A token with the read scope is enough. See Prices Resources for
authentication, common rules and errors.
SMS prices are split into four price domains. The account is assigned a plan in each domain separately, and each domain has its own lookup and its own price file:
Domain |
Prices |
Path prefix |
|---|---|---|
SMS OUT A2P |
SMS sent through the account’s A2P plan, per destination. |
|
SMS OUT P2P |
SMS sent through the account’s P2P plan, per destination. |
|
SMS OUT OTP |
SMS sent through the account’s OTP plan, per destination. |
|
SMS IN |
SMS arriving on one of the account’s numbers. |
|
Prices are in USD, VAT excluded, and are never rounded. When the account holds no price plan
of the service in a domain (no plan at all, or a plan for which the service publishes no
prices), every operation of that domain returns 404 with the error code
price_plan_not_assigned.
Endpoints#
Action |
Method |
Endpoint |
|---|---|---|
Look up SMS OUT prices |
|
|
Download SMS OUT price file |
|
|
Look up SMS IN prices |
|
|
Download SMS IN price file |
|
|
Look up SMS prices#
Returns the prices of one number or one country in the plan of the domain. Send
filter[dst_number], filter[dst_country_iso], or both. At least one of them is
required.
With
filter[dst_number], the longest destination prefix of the plan covering the number wins, and every price of the plan under that prefix is returned.With
filter[dst_country_iso]alone, every price of the plan for that country is returned, under every prefix.With both, the country narrows the prices before the prefixes are ranked.
See Look up SMS OUT Prices and Look up SMS IN Prices.
GET /v3/sms_out/a2p/lookup/prices?filter[dst_number]=4915123456789
GET /v3/sms_in/lookup/prices?filter[dst_country_iso]=US
Download SMS price files#
Downloads the whole price list of the plan of a domain as a gzipped CSV file. Use HEAD
or If-Modified-Since to check whether your copy is current.
Domain |
File name |
|---|---|
SMS OUT A2P |
|
SMS OUT P2P |
|
SMS OUT OTP |
|
SMS IN |
|
See Get SMS OUT Price File and Get SMS IN Price File.
GET /v3/sms_out/a2p/prices.csv.gz
HEAD /v3/sms_in/prices.csv.gz
Data reference#
SMS OUT Price Object — attributes returned by the SMS OUT lookups.
SMS IN Price Object — attributes returned by the SMS IN lookup.
Common SMS prices use cases#
Use case |
Description |
|---|---|
Check what an outbound SMS to a number may cost |
Look up the number in the SMS OUT domain you send through and compare the prices of each network. |
Compare the prices of a destination country |
Look up the country with |
Check rejected destinations |
Find SMS OUT prices where |
Estimate the cost of inbound SMS |
Look up one of your numbers in the SMS IN domain. |
Keep a local price list |
Download the price file of a domain and refresh it when |