reportByPeriod

GET

http://so.kazinfoteh.org/api/sms/report

Проверка статусов сообщений за временной период

INFO

TIP

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

CAUTION

Период в формате YYYY-MM-DD HH:mm:SS/YYYY-MM-DD HH:mm:SS
Даты разделяются между собой символом /
Пример: 2022-04-03 00:00:00/2022-04-07 23:59:59

📌

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

Request

Query Params

period

string

required

Период в формате YYYY-MM-DD HH:mm:SS/YYYY-MM-DD HH:mm:SS
Даты разделяются между собой символом /

Example:

2022-04-03 00:00:00/2022-04-07 23:59:59

Header Params

Authorization

string

required

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

Example:

Basic cGFydG5pKV2dZLUXQ=

Content-Type

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://so.kazinfoteh.org/api/sms/report?period=2022-04-03 00:00:00/2022-04-07 23:59:59' \
--header 'Authorization: Basic cGFydG5pKV2dZLUXQ=' \
--header 'Content-Type: application/json'

Responses

🟢200OK

application/json

Body

array of:

bulk_id

string

required

ID массовой рассылки.

>= 24 characters<= 24 characters

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

Описание ошибки (если есть)

Example

[
    {
        "bulk_id": "c4225cdc09d305b21beccae8",
        "message_id": "9",
        "extra_id": "1Y",
        "to": "77011234567",
        "sender": "KiT_Notify",
        "text": "txt1",
        "sent_at": "2022-09-21 10:43:13",
        "done_at": "2022-09-21 10:42:16",
        "sms_count": "1",
        "priority": "0",
        "callback_data": null,
        "status": "delivered",
        "mnc": "2",
        "err": null
    },
    {
        "bulk_id": "c4225cdc09d305b21beccae8",
        "message_id": "10",
        "extra_id": "2Y",
        "to": "77011234568",
        "sender": "KiT_Notify",
        "text": "txt2",
        "sent_at": "2022-09-21 10:43:13",
        "done_at": "2022-09-21 10:42:15",
        "sms_count": "1",
        "priority": "0",
        "callback_data": null,
        "status": "delivered",
        "mnc": "2",
        "err": null
    }
]

🟢200Not found

🟠401Unauthorized

🟠400Bad Request

🟠404Record Not Found

Modified at 2025-02-02 12:44:48

reportByBulkID

getSenders

reportByPeriod

Проверка статусов сообщений за временной период#

Request

Request samples

Responses

Проверка статусов сообщений за временной период