Send a simple SMS message

Testing Env

https://test.your-api-server.com

POST

/api/sms/send-message/v1

Allows sending a simple SMS message to a single recipient.

Request

Authorization

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Message sent successfully

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test.your-api-server.com/api/sms/send-message/v1' \
--header 'X-ServiceAccount-ID;' \
--header 'X-Organisation-ID;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messageId": "string",
    "referenceId1": "string",
    "referenceId2": "string",
    "serviceId": "string",
    "requestId": "string",
    "initiatorId": "string",
    "text": "string",
    "destination": "string",
    "sourceAddress": "string",
    "priority": 0
}'

Response Example

200 - Example 1

{
    "code": 0,
    "message": null,
    "data": null,
    "correlationId": "string",
    "conversationId": "string",
    "requestId": "string",
    "items": [
        null
    ],
    "itemPagination": {
        "totalElements": 0,
        "pageSize": 0,
        "totalPages": 0,
        "pageNumber": 0,
        "offSet": 0
    },
    "deliveryStatus": "QUEUED",
    "isSuccessful": true
}

Modified at 2025-10-21 01:07:56

Retrieve access token

Send bulk SMS messages