Error
A valid request URL is required to generate request examples{
"message": {
"conversation_id": "<string>",
"status": "queued",
"direction": "outgoing",
"to_number": "<string>",
"from_phone_number_id": "<string>",
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}Messages
Send an SMS
Sends a single SMS to a destination phone number. v1 supports text
bodies only (no media attachments). The send is asynchronous: the API
returns 202 Accepted once queued; final delivery status is reported via
the message.outgoing.delivered webhook.
If the business has multiple phone numbers, from (E.164) is required to
choose the sender; otherwise it is optional and defaults to the primary
number.
POST
/
messages
Error
A valid request URL is required to generate request examples{
"message": {
"conversation_id": "<string>",
"status": "queued",
"direction": "outgoing",
"to_number": "<string>",
"from_phone_number_id": "<string>",
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}Authorizations
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
Client-generated key (≤255 chars) to make a write request safely retriable.
Maximum string length:
255Body
application/json
Response
Message accepted and queued.
Show child attributes
Show child attributes
Was this page helpful?
.png)