KiT Docs Portal

send

POSThttp://isms.center/api/sms/send

Запрос для отпарвки одиночного смс сообщения. Один запрос - Один номер телефона

:::tip
Токен авторизации, формируется из login:password и кодированный в base64
К токену в начало добавляется слово Basic
Basic base64.encode(login:password)

Пример заголовка авторизации: Basic cGFydG5lc2dwZEZLUXQ=
:::

:::highlight gray 📌
Тех. поддержка: support@kazinfoteh.kz
:::

Request

Header Params

Authorization

string

required

Токен авторизации, формируется из login:password и кодированный в base64
Basic base64.encode(login:password)

Example:

Basic cGFydG5lc2dwZEZLUXQ=

Content-Type

string

required

Example:

application/json

from

string

required

Заголовок (сендер) смс сообщения

>= 3 characters<= 17 characters

Example:

KiT_Notify

string

required

Номер телефона в формате 7XXXXXXXXX (без 8 и без +, например 77011234567)

>= 11 characters<= 15 characters

Example:

77011234567

text

string

required

Текст смс сообщения

>= 1 characters<= 1000 characters

Example:

test

sent_at

string

optional

Если необходимо то возможно указать дату и время, когда должна быть отпарвлено сообщение. Дата и время в фотмате YYY-MM-DD HH:mm:SS

Example:

2022-09-21 09:19:41

extra_id

string

optional

Ваш ID сообщения. Вы можете указать Ваш ID сообщения, из Вашей системы.

>= 1 characters<= 50 characters

Example:

123Y

notify_url

string

optional

Ваш URL "приемщик" (webhook) для получения статусов сообщений от нас. Подробнее в секции notify_url

>= 11 characters<= 255 characters

Example:

http://vashserver.kz/status

{
  "from": "KiT_Notify",
  "to": "77011234567",
  "text": "123",
  "sent_at": "2020-03-16 10:00:24",
  "extra_id": "123Y",
  "notify_url": "http://vashserver.kz/status"
}

Request samples

Responses

OK(200)

Bad Request(400)

Unauthorized(401)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

bulk_id

string

required

ID массовой рассылки. Если в запросе не один номер телефона, а список номеров. У всего списка номеров будет одинаковый ID рассылки. Смотрите секцию sendbulk

>= 24 characters<= 24 characters

Example:

24baf14ef1c86c101b6fbe71

message_id

string

required

Уникальный ID конкретного сообщения в нашей системе

extra_id

string | null

required

Ваш ID, если указывали в запросе поле extra_id

string

required

Номер телефона

sender

string

required

Заголовок (сендер) сообщения

text

string

required

Текст сообщения

sent_at

string

required

Время отправки в фотмате YYY-MM-DD HH:mm:SS

done_at

string | null

required

Время доставки/не доставки в фотмате YYY-MM-DD HH:mm:SS (если есть)

sms_count

string

required

Количество смс сообщений в длинном сообщении.

priority

string

required

Приоритет сообщения

callback_data

string | null

required

Дополнительные данные, которые были отправлены на notify_url

status

enum<string>

required

Статус сообщения:
send - в очереди на отправку
sending - в процессе отправка
sent - доставлено до оператора
delivered - доставлено до абонента
undelivered - не доставлено до абонента

Allowed values:

sendsendingsentdeliveredundelivered

mnc

enum<string>

required

Международный код оператора:
1 - Билайн
2 - Кселл
77 - Теле2
7 - Алтел
55 - Другие операторы

Allowed values:

1277755

err

string | null

required

Описание ошибки (если есть)
Значения:
707 - Блокирован оператор МТС
701 - Блокирован оператор Кселл
777 - Блокирован оператор Билайн

остальное описание ошибок в процессе добавления

{
  "bulk_id": "24baf14ef1c86c101b6fbe71",
  "message_id": "5",
  "extra_id": "123Y",
  "to": "77011234567",
  "sender": "KiT_Notify",
  "text": "123",
  "sent_at": "2022-09-21 09:02:19",
  "done_at": null,
  "sms_count": "1",
  "priority": "0",
  "callback_data": null,
  "status": "send",
  "mnc": "2",
  "err": null
}

Last modified: 5 months ago