MediaUrl parameter upgrades the message to MMS automatically.
Endpoint
Path parameters
Body parameters
The phone number to send the message to, in E.164 format (e.g.
+491234567890).Your mycpaas phone number to send the message from, in E.164 format (e.g.
+491098765432).The text content of the message. Maximum 1,600 characters for SMS; long messages are split into segments automatically.
A publicly accessible URL of the media file to attach. Including this parameter sends an MMS instead of an SMS. Supported types include JPEG, PNG, GIF, and MP4.
A URL that mycpaas will send a POST request to whenever the message status changes (e.g.
sent, delivered, failed). Use this to track delivery in real time.Send an SMS
Send an MMS
Include aMediaUrl to attach an image or other media file. The URL must be publicly accessible — mycpaas fetches the file at send time.
Response
A successful request returns HTTP201 Created with a JSON object representing the message.
A unique identifier for the message, prefixed with
SM.The destination phone number in E.164 format.
The mycpaas number the message was sent from, in E.164 format.
The text content of the message.
The current delivery status of the message. See the status table below.
The ISO 8601 timestamp of when the message was created.
The relative path to fetch this message resource via the API.
Message status values
| Status | Meaning |
|---|---|
queued | The message has been accepted and is waiting to be sent. |
sending | mycpaas is in the process of dispatching the message to the carrier. |
sent | The message has been handed off to the carrier successfully. |
delivered | The carrier has confirmed delivery to the recipient’s handset. |
failed | The message could not be sent. Check the error code in the response for details. |
List messages
Use a GET request to retrieve a paginated list of messages for your account. You can filter results by any combination of the query parameters below.Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
To | string | — | Filter to messages sent to this number (E.164). |
From | string | — | Filter to messages sent from this number (E.164). |
DateSent | string | — | Filter to messages sent on this date (YYYY-MM-DD). |
Status | string | — | Filter by status: queued, sending, sent, delivered, or failed. |
Page | integer | 0 | The page number to retrieve (zero-indexed). |
PageSize | integer | 50 | Number of messages per page. |

