KiT Docs Portal

getMessageByID

GEThttp://kazinfoteh.org:9507/?action=getmessagebyid

Получение статуса смс сообщения по ID сообщения.

Пример запроса:
http://kazinfoteh.org:9507/?action=getmessagebyid&username=mycompany&password=1234567&msgID=1E5E6A3C-DAFC-4EE4-B1BB-C1498FC2E6C5

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

Request

Query Params

action

string

required

Тип запроса. Обязательныq параметр указывающий на получение статуса смс. action=getmessagebyid

Example:

getmessagebyid

username

string

required

Логин выданный менеджером

Example:

mycompany

password

string

required

Пароль выданный менеджером

Example:

1234567

msgID

string

required

ID сообщения полученный из запросе sendmessage

Example:

1E5E6A3C-DAFC-4EE4-B1BB-C1498FC2E6C5

Request samples

Responses

OK(200)

Invalid username or password(200)

Empty msgid(200)

Message ID does not exist(200)

Record Not Found(404)

HTTP Code: 200

Content Type : XMLapplication/xml

action

string

required

Тип вовзвращаемого ответа

data

object

required

messageid

string

required

ID сообщения

originator

string

required

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

recipient

string

required

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

senttime

string

required

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

receivedtime

string

required

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

creationtime

string

required

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

state

enum<integer>

required

Статус сообщения:
0 - ожидание
1 - доставлено до оператора
4 - ошибка доставки (ошибка оператора)
10 - доставлено до абонента
11 - не доставлено до абонента

Allowed values:

0141011

messagetype

string

required

Тип смс сообщения. Для текстовых смс SMS:TEXT

messagedata

string

required

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

<response>
    <action>
        getMsgInfoByID
    </action>
    <data>
        <messageid>
            1E5E6A3C-DAFC-4EE4-B1BB-C1498FC3E6C5
        </messageid>
        <originator>
            KiT_Notify
        </originator>
        <recipient>
            77011234567
        </recipient>
        <senttime>
            2023-09-20 12:07:35
        </senttime>
        <receivedtime>
            2023-09-20 12:07:00
        </receivedtime>
        <creationtime>
            2023-09-20 12:07:35
        </creationtime>
        <state>
            10
        </state>
        <messagetype>
            SMS:TEXT
        </messagetype>
        <messagedata>
            test
        </messagedata>
    </data>
</response>

Last modified: a year ago