Skip to main content
POST
sms.send-preview

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
to
string
required

Phone number in E.164 format, including the leading plus.

Pattern: ^\+[1-9]\d{1,14}$
body
string
required

Text to simulate, up to 1600 UTF-16 units; no message is sent.

Required string length: 1 - 1600
from
string

Phone number in E.164 format, including the leading plus.

Pattern: ^\+[1-9]\d{1,14}$
variables
object

Up to 50 named text replacements.

Response

The result

recipients
number
required

One simulated recipient.

parts
integer
required

SMS parts the simulated text uses.

Required range: 1 <= x <= 24
body
string
required

Personalized simulated text.

Maximum string length: 1600
encoding
enum<string>
required

Text encoding for the simulated message.

Available options:
text,
unicode
estimatedPriceUsd
number

What sending this text is estimated to be charged, in US dollars: its parts at the current per-part price. An estimate, not a quote; a send is charged what it actually costs.

Required range: x >= 0