Отправка

Отправьте 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

    Всегда message.

  • batch_idstring

    Пакет, к которому относится сообщение (одиночное сообщение также получает пакет).

  • tostring

    Номер в формате E.164 после очистки.

  • countrystring

    Код страны ISO 3166, по которому был рассчитан тариф для номера.

  • textstring

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

  • segmentsinteger

    Количество сегментов SMS, используемых текстом.

  • pricestring

    Стоимость сообщения в USD, 5 знаков после запятой (цена за сегмент, умноженная на количество сегментов).

  • currencystring

    Всегда USD.

  • statusstring

    scheduled, queued, sent, delivered, failed или canceled.

  • errorobject or null

    Для сообщений с failed или canceled: код и сообщение.

  • referencestring or null

    Ваш собственный reference из запроса.

  • created_atstring

    Когда запрос был принят (ISO 8601, UTC).

  • sent_atstring or null

    Когда сообщение было передано в сеть.

  • done_atstring or null

    Когда был установлен финальный статус (delivered, failed или canceled).

Получить сообщение

GET/v1/messages/{id}

Одно сообщение по его msg_ id. Сообщения других аккаунтов возвращают 404.

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

Список сообщений

GET/v1/messages

Сообщения аккаунта, новые сверху.

Параметры запроса

  • batch_idstringнеобязательно

    Только сообщения этого пакета bat_.

  • statusstringнеобязательно

    scheduled, queued, sent, delivered, failed или canceled.

  • limitintegerнеобязательно

    От 1 до 100, по умолчанию 20.

  • starting_afterstringнеобязательно

    msg_ id: страница начинается после него. Используйте последний id предыдущей страницы.

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