Метод используется для получения информации о заметке.
Принцип использования
Синтаксис и URL для вызова метода
https://api.unisender.com/en/api/getSubscriberNote?format=json&api_key=KEY&id=ID
| Аргументы | |
| api_key* | Ключ доступа к API. |
| id* | Идентификатор заметки. |
| format | Формат вывода возвращаемого результата. Может принимать значения html | json, по умолчанию json (формат html предназначен только для визуального просмотра результата, парсер в данном формате работать не будет). |
Возвращаемое значение
JSON-массив следующего формата:
{
"result": {
"id": 23,
"user_id": 2,
"subscriber_id": 963127808,
"content": "test",
"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 – дата и время редактирования заметки