KiT Docs Portal
  1. HTTP SMS API
KiT Docs Portal
  • KiT Docs Portal
  • Личный кабинет
  • WhatsApp API
    • Типы сообщений
    • Форматирование в текстовых сообщениях
    • Форматы WhatsApp Media
    • Коды ошибок платформы WABA
    • Шаблонные сообщения
      • Категории шаблонов
      • Типы заголовков в шаблонных сообщениях
      • Тело шаблонного сообщения
      • Кнопки в шаблонных сообщениях
      • Общее описание запроса
      • Сообщение со всеми параметрами - заголовок изображение
      • Сообщение со всеми параметрами - заголовок текст
      • Сообщение изображение и текст
      • Сообщение изображение, текст и подпись сообщения
      • Сообщение изображение, текст и 2 кнопки - переход на сайт и позвонить
      • Сообщение изображение, текст и 3 кнопки быстрого ответа
      • Сообщение с кнопками содержащие динамическое дополнение к основному URL
      • Сообщение местоположение и текст
      • Сообщение динамиечский текст тело сообщения
      • Сообщение динамиечский текст тело сообщения и заголовка сообщения
      • Сообщение статичный текст
      • Получить имена всех шаблонов - gettemplate
    • Авторизационныe сообщения
      • Авторизационное сообщение
    • Чат сообщения
      • Сообщение текстовое
      • Сообщение с изображением
      • Сообщение аудиозапись
      • Сообщение с документом
      • Сообщение с видео
      • Сообщение со стикерам
      • Сообщение с списками
      • Сообщение с кнопками ответа
      • Сообщение с кнопкой перехода на URL
      • Сообщение с местоположением
      • Сообщение запрос местоположения
    • Входящие сообщения от абонента
      • Входящие сообщения от абонента
      • Текстовое входящее сообщение
      • Медиа (изображение, аудио, видео, документ, стикер) - входящее сообщение
      • Местоположение - входящее сообщение
      • Нажатие на кнопку быстрого ответа
      • Нажатие на кнопку из списка (из листа)
    • Установить WebHook - setwebhook
      POST
    • Статусы сообщений на WebHook
      POST
  • HTTP SMS API
    • sendMessage
      GET
    • getMessageByID
      GET
    • reporturl
      GET
  • JSON SMS API
    • send
      POST
    • sendBulk
      POST
    • reportByID
      GET
    • reportByExtraID
      GET
    • reportByBulkID
      GET
    • reportByPeriod
      GET
    • getSenders
      GET
    • notify_url
      GET
  • SOAP SMS API
    • sendMessage
      POST
    • sendBulkMessage
      POST
    • getInfoByID
      POST
    • getBulkInfoByID
      POST
    • getAbonents
      POST
    • getReport
      POST
    • getSenders
      POST
  • XML SMS API
    • sendMessage
    • sendBulkMessage
    • getInfoByID
  • MobiCheck SMS API. OTP/2FA
    • sendRequest
    • verifyPin
    • verifyRequest
  • SMPP SMS API
    • SMPP 3.4
  1. HTTP SMS API

reporturl

GET
http://vashserver-sms-status.kz/status

Общая схема работы с параметром reporturl

  • В запросе на отправку смс сообщения action=sendmessage Вы указываете параметр reporturl с обязательными параметрами (макросы в параметрах будут заменяться на реальные данные)
  • При обновлении статуса мы вызываем ваш URL и подставляем данные
     
Пример заполнения reporturl в запросе на отпарвку смс action=sendmessage:
reporturl=https://vashserver.kz/sms?statusmessage=$statusmessage&statuscode=$statuscode&messageid=$messageid&recipient=$recipient&originator=$originator&messagetype=$messagetype&status=$status&deliveredtonetworkdate=$deliveredtonetworkdate&deliveredtohandsetdate=$deliveredtohandsetdate

 
 

CAUTION

Внимание! Название макросов, начинающиеся с $ (например, $statusmessage) не должны меняться и должны присутствовать в Вашем URL во время отправки action=sendmessage

 
Ваши название параметров могут быть любыми (например, status=$statusmessage или vremya=$deliveredtonetworkdate).
 
Так же вы можете добавлять Ваши специфические параметры, например, ID из Вашей системы
 

Пример, добавим специфический параметр external_id=12360651238617651720:
reporturl=https://vashserver.kz/sms?external_id=12360651238617651720&statusmessage=$statusmessage&statuscode=$statuscode&messageid=$messageid&recipient=$recipient&originator=$originator&messagetype=$messagetype&status=$status&deliveredtonetworkdate=$deliveredtonetworkdate&deliveredtohandsetdate=$deliveredtohandsetdate

CAUTION

Внимание! Все содержимое параметра reporturl необходимо передавать через Encode URL

 

Пример полного запроса на отправку смс с указанием reporturl:
http://kazinfoteh.org:9507/api?action=sendmessage&username=mycompany&password=1234567&recipient=77011234567&messagetype=SMS:TEXT&originator=KiT_Notify&messagedata=test&reporturl=https://vashserver.kz/sms?statusmessage=$statusmessage&statuscode=$statuscode&messageid=$messageid&recipient=$recipient&originator=$originator&messagetype=$messagetype&status=$status&deliveredtonetworkdate=$deliveredtonetworkdate&deliveredtohandsetdate=$deliveredtohandsetdate

 

INFO

Для генерации примера кода "приемщика" на нужном языке программирования, можете воспользоваться кнокой "</> Code Generate" в правом углу. Внести необходимые Вам изменения и разместить на Вашем сервере.

Request

Query Params
$statusmessage
string 
required
Текстовый статус.
sent - успешно доставлено до оператора;
delivered - успешно доставлено до абонента;
undelivered - не доставлено до абонента
$statuscode
integer 
required
Цифровой код статуса. 0 - доставлено. 1 - не доставлено
Example:
0
$messageid
string 
required
ID сообщения
Example:
1E5E6A3C-DAFC-4EE4-B1BB-C1198FC3E6C5
$recipient
string 
required
Номер телефона
Example:
77011234567
$originator
string 
required
Заголовок (сендер) сообщения
Example:
Kit_Notify
$messagetype
string 
required
Тип смс сообщения. Для текстовых смс SMS:TEXT
Example:
SMS:TEXT
$status
string 
required
Текстовый статус, совпадает с параметром statusmessage (для поддержки старых версий).
sent - успешно доставлено до оператора;
delivered - успешно доставлено до абонента;
undelivered - не доставлено до абонента.
Example:
delivered
$deliveredtonetworkdate
string 
required
Дата и время доставки до оператора в формате YYYY-MM-DD HH:mm::SS
Example:
2022-11-29 15:55:11
$deliveredtohandsetdate
string 
required
Дата и время доставки\не доставки до абонента в формате YYYY-MM-DD HH:mm::SS
Example:
2022-11-29 15:55:11

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://vashserver-sms-status.kz/status?$statusmessage=&$statuscode=0&$messageid=1E5E6A3C-DAFC-4EE4-B1BB-C1198FC3E6C5&$recipient=77011234567&$originator=Kit_Notify&$messagetype=SMS:TEXT&$status=delivered&$deliveredtonetworkdate=2022-11-29 15:55:11&$deliveredtohandsetdate=2022-11-29 15:55:11'

Responses

🟢200OK
application/json
Body
object {0}
Example
{}
Previous
getMessageByID
Next
JSON SMS API
Built with