Sign in

v24

latestSwagger 2.0AGPL-3.0raw.githubusercontent.com2026-08-015163191.7 KB
Messages

Send an SMS message

Add a new SMS message to be sent by your Android phone

post/messages/send

Request body

attachmentsstring[]

Attachments are optional. When you provide a list of attachments, the message will be sent out as an MMS

contentstring required
encryptedboolean

Encrypted is an optional parameter used to determine if the content is end-to-end encrypted. Make sure to set the encryption key on the httpSMS mobile app

fromstring required
request_idstring

RequestID is an optional parameter used to track a request from the client's perspective

send_atstring

SendAt is an optional parameter used to schedule a message to be sent in the future. The time is considered to be in your profile's local timezone and you can queue messages for up to 20 days (480 hours) in the future.

tostring required

Example request

{
  "attachments": [
    "https://example.com/image.jpg",
    "https://example.com/video.mp4"
  ],
  "content": "This is a sample text message",
  "from": "+18005550199",
  "request_id": "153554b5-ae44-44a0-8f4f-7bbac5657ad4",
  "send_at": "2025-12-19T16:39:57-08:00",
  "to": "+18005550100"
}

Response

OK

messagestring required
statusstring required

Example response

{
  "data": {
    "attachments": [
      "https://example.com/image.jpg",
      "https://example.com/video.mp4"
    ],
    "contact": "+18005550100",
    "content": "This is a sample text message",
    "created_at": "2022-06-05T14:26:02.302718+03:00",
    "delivered_at": "2022-06-05T14:26:09.527976+03:00",
    "expired_at": "2022-06-05T14:26:09.527976+03:00",
    "failed_at": "2022-06-05T14:26:09.527976+03:00",
    "failure_reason": "UNKNOWN",
    "id": "32343a19-da5e-4b1b-a767-3298a73703cb",
    "last_attempted_at": "2022-06-05T14:26:09.527976+03:00",
    "max_send_attempts": 1,
    "order_timestamp": "2022-06-05T14:26:09.527976+03:00",
    "owner": "+18005550199",
    "received_at": "2022-06-05T14:26:09.527976+03:00",
    "request_id": "153554b5-ae44-44a0-8f4f-7bbac5657ad4",
    "request_received_at": "2022-06-05T14:26:01.520828+03:00",
    "scheduled_at": "2022-06-05T14:26:09.527976+03:00",
    "scheduled_send_time": "2022-06-05T14:26:09.527976+03:00",
    "send_time": 133414,
    "sent_at": "2022-06-05T14:26:09.527976+03:00",
    "status": "pending",
    "type": "mobile-terminated",
    "updated_at": "2022-06-05T14:26:10.303278+03:00",
    "user_id": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
  },
  "message": "Request handled successfully",
  "status": "success"
}