Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization Code flow against Dialbird's OIDC provider. The issued access token is a JWT with aud: "public-api", verified against the issuer JWKS.

Headers

Idempotency-Key
string

Client-generated key (≤255 chars) to make a write request safely retriable.

Maximum string length: 255

Body

application/json
to
string
required

Destination phone number, E.164.

Example:

"+15551234567"

body
string
required

Message text.

Minimum string length: 1
from
string

Sender phone number owned by the business, E.164. Optional unless the business has multiple numbers.

Example:

"+15557654321"

Response

Message accepted and queued.

message
object