SMS

SMS API

Auth: JWT Bearer or Basic Auth · Base URL: https://www.614901.xyz/api/3rdparty/v1

# Send an SMS

curl -X POST https://www.614901.xyz/api/3rdparty/v1/messages \

  -u LOGIN:PASSWORD \

  -H "Content-Type: application/json" \

  -d '{"phoneNumbers":["+12025550100"],"textMessage":{"text":"Hello!"}}'

Messages

POST

/api/3rdparty/v1/messages

Queue an SMS. Body: { phoneNumbers[], textMessage: { text }, simNumber?, withDeliveryReport?, priority?, scheduleAt?, validUntil? }.

Sample Request

POST /api/3rdparty/v1/messages
Authorization: Basic LOGIN:PASSWORD
Content-Type: application/json

{
  "phoneNumbers": ["+12025550100"],
  "textMessage": { "text": "Hello from API" },
  "withDeliveryReport": true
}

Sample Response

200 OK
{
  "id": "c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c"
}

GET

/api/3rdparty/v1/messages

List messages. Query: skip (default 0), limit (default 20, max 100).

Sample Request

GET /api/3rdparty/v1/messages?skip=0&limit=20
Authorization: Basic LOGIN:PASSWORD

Sample Response

200 OK
[
  {
    "id": "c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c",
    "state": "Pending",
    "createdAt": "2026-05-17T09:32:11.421Z"
  }
]

GET

/api/3rdparty/v1/messages/{id}

Get full status and recipient states for a single message.

Sample Request

GET /api/3rdparty/v1/messages/c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c
Authorization: Basic LOGIN:PASSWORD

Sample Response

200 OK
{
  "id": "c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c",
  "state": "Delivered",
  "recipients": [
    { "phoneNumber": "+12025550100", "state": "Delivered", "error": null }
  ]
}

POST/api/3rdparty/v1/messages

Queue an SMS. Body: { phoneNumbers[], textMessage: { text }, simNumber?, withDeliveryReport?, priority?, scheduleAt?, validUntil? }.

Sample Request

POST /api/3rdparty/v1/messages
Authorization: Basic LOGIN:PASSWORD
Content-Type: application/json

{
  "phoneNumbers": ["+12025550100"],
  "textMessage": { "text": "Hello from API" },
  "withDeliveryReport": true
}

Sample Response

200 OK
{
  "id": "c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c"
}

GET/api/3rdparty/v1/messages

List messages. Query: skip (default 0), limit (default 20, max 100).

Sample Request

GET /api/3rdparty/v1/messages?skip=0&limit=20
Authorization: Basic LOGIN:PASSWORD

Sample Response

200 OK
[
  {
    "id": "c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c",
    "state": "Pending",
    "createdAt": "2026-05-17T09:32:11.421Z"
  }
]

GET/api/3rdparty/v1/messages/{id}

Get full status and recipient states for a single message.

Sample Request

GET /api/3rdparty/v1/messages/c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c
Authorization: Basic LOGIN:PASSWORD

Sample Response

200 OK
{
  "id": "c6f1f7cc-97c1-44a2-99fb-83c4b3f9ef4c",
  "state": "Delivered",
  "recipients": [
    { "phoneNumber": "+12025550100", "state": "Delivered", "error": null }
  ]
}