Метод используется для получения информации о всех заметок контакта.
Принцип использования
Синтаксис и URL для вызова метода
https://api.unisender.com/en/api/getSubscriberNotes?format=json&api_key=&limit=2&offset=3&subscriber_id=963127808&order_by=created_at&order_type=DESC
| Аргументы | |
| api_key* | Ключ доступа к API. |
| subscriber_id* | ID контакта, чьи заметки необходимо получить. |
| limit | Количество записей в ответе на один запрос. |
| offset | Параметр используется для указания с какой записи вы хотите начать получение информации. Установив значение offset, вы можете пропустить определенное количество элементов в результатах запроса и получить данные, начиная со следующего элемента после указанного смещения. |
| order_type | ASC – сортировка заметок по возрастанию параметра order_by;
DESC – сортировка заметок по убыванию параметра order_by. |
| order_by | created_at – дата и время создания заметки;
updated_at – дата и время обновления заметки; pinned_at – дата и время закрепления заметки. |
| is_pinned | 0 - будут получены все незакрепленные заметки;
1 - будут получены все закрепленные заметки. |
| format | Формат вывода возвращаемого результата. Может принимать значения html | json, по умолчанию json (формат html предназначен только для визуального просмотра результата, парсер в данном формате работать не будет). |
По умолчанию вверху списка будут отображаться закрепленные элементы в порядке возрастания даты закрепления (от самых старых к самым новым), а остальные элементы будут располагаться в порядке убывания даты обновления (от самых новых к самым старым).
Возвращаемое значение
JSON-массив следующего формата: со следующим полями:
{
"result": [
{
"id": 24,
"user_id": 2,
"subscriber_id": 963127808,
"content": "dzcddsf",
"origin": "api",
"is_pinned": true,
"pinned_at": "2023-03-16 18:28:50",
"created_at": "2023-03-15 13:01:55",
"updated_at": "2023-03-15 13:01:55"
},
{
"id": 25,
"user_id": 2,
"subscriber_id": 963127808,
"content": "htr",
"origin": "api",
"is_pinned": false,
"pinned_at": null,
"created_at": "2023-03-15 13:02:30",
"updated_at": "2023-03-15 13:02:30"
}
]
}
где:
id – идентификатор заметки.
user_id – id аккаунта Unisender.
subscriber_id – id контакта, которому принадлежит заметка.
content – текст заметки.
origin – способ создания заметки (api - заметка создана с помощью метода createSubsciberNote; manual - заметка создана вручную).
is_pinned – принимает значение "false" или "true" в зависимости от того, закреплена ли данная заметка в карточке контакта.
pinned_at – дата и время закрепления заметки.
created_at – дата и время создания заметки
updated_at – дата и время редактирования заметки
