GetMessageHistory - данный метод применяется для получения истории сообщений. Необходимо выполнить GET запрос к /v2/accounts/{accountSID}/messages.
Точка подключения: https://msapi.mtt.ru:443/
Входные параметры
Name | Type | Description |
|---|---|---|
AccountSID | string | Идентификатор аккаунта |
authToken | string | Пароль |
Выходные параметры
Name | Type | Description |
|---|---|---|
| page | int | Номер страницы, начинается с 0. |
| limit | int | Количество возвращенных записей на странице (по умолчанию 20(максимальное кол-во)). |
| next | string | URI к следующей части списка. |
| prev | string | URI, к предыдущей части списка. |
| total | int | Общее количество записей в списке. |
| messages | Json array | Список сообщений. |
| messages /message_sid | string | Идентификатор сообщения. |
| messages /created_at | string | Дата создания. |
| messages /account_sid | string | Идентификатор аккаунта. |
| messages /number | string | Внешний номер, с/на который отправлено сообщение (в зависимости от направления). |
| messages /external_number | string | Наш номер с/на который отправлено сообщение (в зависимости от направления). |
| messages /text | string | Текст сообщения. |
| messages/direction | string | Направление сообщения: "inbound" или "outbound". |
| messages/status | string | Текущий статус сообщения. |
| messages/segment_count | string | Количество частей в сообщении |
Пример
JSON
curl –X GET 'v2/accounts/{accountSID}/messages?limit=5' \
-u {accountSID}:{authToken}
Успешный ответ
JSON
{
"page": 1,
"total": 379,
"limit": 5,
"offset": 0,
"prev": "",
"next": "http://172.16.102.108:8985/v2/accounts/accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe/messages?limit=5&offset=5",
"messages": [
{
"account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",
"message_sid": "msg204815e0-68d3-4193-999b-d142b749fd39",
"text": "работают",
"created_at": 1518091728,
"direction": "inbound",
"number": "79587625002",
"external_number": "79057259771",
"status": "received",
"segment_count": 1,
},
{
"account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",
"message_sid": "msg660c1d96-bdd3-4e62-a682-9665309b5cc3",
"text": "tester2 Privet!",
"created_at": 1518091728,
"direction": "inbound",
"number": "79587625002",
"external_number": "79166597045",
"status": "received",
"segment_count": 1,
},
{
"account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",
"message_sid": "msgfe14221b-4dff-4959-9962-de507af92f4a",
"text": "оистатусики",
"created_at": 1518091728,
"direction": "inbound",
"number": "79587625002",
"external_number": "79057259771",
"status": "received",
"segment_count": 1,
},
{
"account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",
"message_sid": "msg9c8045b5-0fab-4b8f-b0ee-278dcd93fdfc",
"text": "шик",
"created_at": 1518091728,
"direction": "inbound",
"number": "79587625002",
"external_number": "79057259771",
"status": "received",
"segment_count": 1,
},
{
"account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",
"message_sid": "msg9b23d61c-c28b-40cb-bd2c-adf290a3219c",
"text": "статусы в группе не проверишь)",
"created_at": 1518091728,
"direction": "inbound",
"number": "79587625002",
"external_number": "79166597045",
"status": "received",
"segment_count": 1,
}
]
}
Фильтр по параметрам
Для фильтрации возвращаемого списка сообщений необходимо задать значения параметров в запросе GET.
Пример запроса:
JSON
curl –X GET
'v2/accounts/{accountSID}/messages?direction=outbound&status=delivered \
-u {accountSID}:{authToken}
Возможна фильтрация возвращаемого списка по следующим параметрам:
- limit,
- message_sid,
- number,
- external_number,
- number_sid,
- direction,
- status