Надсилання

Надішліть SMS за допомогою POST /v1/messages

POST/v1/messages

Надішліть один текст на один номер. Вартість знімається з балансу, коли запит приймається.

Тіло запиту

  • tostringобов'язково

    Номер у міжнародному форматі, наприклад +14155550123. Пробіли, тире, дужки та префікс 00 видаляються.

  • textstringобов'язково

    Повідомлення. До 10 сегментів; див. Текст і сегменти.

  • referencestringнеобов'язково

    Ваш власний ідентифікатор, до 100 символів. Він повертається в об'єкті повідомлення та в кожному вебхуку.

  • send_atstringнеобов'язково

    Час відправлення у форматі ISO 8601, від 2 хвилин до 45 днів вперед. Без цього повідомлення ставиться в чергу одразу.

Додайте заголовок Idempotency-Key, щоб зробити повторні спроби безпечними: див. Ідемпотентність.

curl https://bulksmsapi.cc/v1/messages \
  -H "Authorization: Bearer $BULKSMSAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+14155550123",
    "text": "Your Northwind code is 482913. It expires in 10 minutes.",
    "reference": "login-7781"
  }'
202 AcceptedJSON
{
  "id": "msg_8F3K2Q9TZ1MX",
  "object": "message",
  "batch_id": "bat_4M7Q1X0PK2RS",
  "to": "+14155550123",
  "country": "US",
  "text": "Your Northwind code is 482913. It expires in 10 minutes.",
  "segments": 1,
  "price": "0.00507",
  "currency": "USD",
  "status": "queued",
  "error": null,
  "reference": "login-7781",
  "created_at": "2026-11-07T09:30:12.418Z",
  "sent_at": null,
  "done_at": null
}

Об'єкт повідомлення

Поля

  • idstring

    Ідентифікатор повідомлення, msg_ з подальшими 12 символами.

  • objectstring

    Завжди повідомлення.

  • batch_idstring

    Пакет, до якого належить повідомлення (одиночне повідомлення також отримує пакет).

  • tostring

    Номер у форматі E.164 після очищення.

  • countrystring

    Код ISO 3166 країни, за якою було розцінено номер.

  • textstring

    Текст, як відправлено, з заповненими полями злиття.

  • segmentsinteger

    Кількість сегментів SMS, які використовує текст.

  • pricestring

    Вартість цього повідомлення в USD, 5 десяткових знаків (ціна за сегмент помножена на кількість сегментів).

  • currencystring

    Завжди USD.

  • statusstring

    заплановано, в черзі, відправлено, доставлено, не вдалося або скасовано.

  • errorobject or null

    Для невдалих або скасованих повідомлень: код і повідомлення.

  • referencestring or null

    Ваш власний посилання з запиту.

  • created_atstring

    Коли запит було прийнято (ISO 8601, UTC).

  • sent_atstring or null

    Коли повідомлення було передано в мережу.

  • done_atstring or null

    Коли було встановлено остаточний статус (доставлено, не вдалося або скасовано).

Отримати повідомлення

GET/v1/messages/{id}

Одне повідомлення за його msg_ ідентифікатором. Повідомлення інших облікових записів відповідають 404.

curl https://bulksmsapi.cc/v1/messages/msg_8F3K2Q9TZ1MX \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"

Список повідомлень

GET/v1/messages

Повідомлення облікового запису, від найновіших до найстаріших.

Параметри запиту

  • batch_idstringнеобов'язково

    Лише повідомлення цього пакету bat_.

  • statusstringнеобов'язково

    заплановано, в черзі, відправлено, доставлено, не вдалося або скасовано.

  • limitintegerнеобов'язково

    Від 1 до 100, за замовчуванням 20.

  • starting_afterstringнеобов'язково

    Ідентифікатор msg_: сторінка починається після нього. Використовуйте останній ідентифікатор з попередньої сторінки.

curl "https://bulksmsapi.cc/v1/messages?status=failed&limit=50" \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"
200 OKJSON
{
  "object": "list",
  "data": [ { "id": "msg_8F3K2Q9TZ1MX", "object": "message", "status": "failed", "...": "..." } ],
  "has_more": false
}
Надішліть SMS за допомогою POST /v1/messages | BulkSMSAPI Docs