Skip to main content
POST

Authorizations

x-api-key
string
header
required

Body

application/x-www-form-urlencoded
phone_number
string
required

Telefonní číslo příjemce (akceptován je i alias number).

Example:

"420777123456"

message
string
required

Tělo zprávy (akceptován je i alias body).

sender
string
required

Název odesílatele nebo virtuální číslo (může být vyžadována předchozí registrace).

gateway
enum<string>
default:high

SMS brána použitá pro odeslání.

Available options:
high,
lowcost,
direct,
custom,
simhost,
gsm
datetime
string<date-time>

Naplánovaný čas odeslání zprávy, v UTC (akceptován je i alias time).

Example:

"2025-01-11T10:00:00Z"

customID
string

Váš vlastní identifikátor zprávy. Je uložen v payload zprávy (jako customID) a vrácen v notifikacích o doručení.

Response

Jednoduchá zpráva byla úspěšně odeslána

request_id
string

Unikátní identifikátor požadavku.

Example:

"bc36f3d1-d284-463a-921b-a3560c154649"

message_id
string

Unikátní identifikátor zprávy.

Example:

"bc36f3d1-d284-463a-921b-a3560c154649"

accepted
boolean

True, pokud byla zpráva přijata, false, pokud byla odmítnuta.

Example:

true