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
Текстовый статус.
sent - успешно доставлено до оператора;
delivered - успешно доставлено до абонента;
undelivered - не доставлено до абонента
Цифровой код статуса. 0 - доставлено. 1 - не доставлено
ID сообщения
Номер телефона
Заголовок (сендер) сообщения
Тип смс сообщения. Для текстовых смс SMS:TEXT
Текстовый статус, совпадает с параметром statusmessage (для поддержки старых версий).
sent - успешно доставлено до оператора;
delivered - успешно доставлено до абонента;
undelivered - не доставлено до абонента.
Дата и время доставки до оператора в формате YYYY-MM-DD HH:mm::SS
Дата и время доставки\не доставки до абонента в формате YYYY-MM-DD HH:mm::SS
Request samples
Responses
{}