| Термин | Что значит |
|---|---|
| Канал | номер MAX, аккаунт Telegram, номер WhatsApp или почтовый ящик, подключённый к Gratio. У канала свой ключ и своя лента уведомлений. В Green API — «инстанс» |
| Ключ канала | пара idInstance и apiTokenInstance, открывает API только этого канала — см. Каналы и ключи |
idInstance |
номер канала в API, 10 цифр |
apiTokenInstance |
токен канала, 50 символов. Секрет |
| Площадка | мессенджер или почта, к которой подключён канал: MAX, Telegram, WhatsApp, почта |
| Номер канала | номер или адрес, который подключён к каналу; в ответах — wid: 79990000001@c.us |
| Собеседник | человек, с которым идёт переписка: клиент, участник группы |
chatId |
адрес чата: личного или группы. Формат зависит от площадки — см. Идентификаторы чатов и сообщений |
idMessage |
id сообщения на площадке; у правки, удаления и реакции — id события |
stanzaId |
id сообщения, к которому относится правка, удаление, реакция или цитата |
eventId |
ключ события в Gratio — для защиты от повторной обработки |
clientMessageId |
ваш ключ отправки: повтор с ним не создаёт второе сообщение — см. Надёжная отправка без дублей |
| Уведомление | сообщение Gratio о событии в канале: входящее, статус, звонок, событие группы — см. Формат уведомления |
typeWebhook |
вид уведомления: incomingMessageReceived, outgoingMessageStatus и др. |
typeMessage |
вид сообщения в уведомлении: textMessage, imageMessage и др. |
| Очередь | лента уведомлений канала, которую приложение читает методом receiveNotification |
receiptId |
номер уведомления в очереди — для deleteNotification |
| Вебхук | адрес приложения, на который Gratio сам отправляет уведомления — см. Вебхук |
| Подписка | копия ленты уведомлений по отдельному адресу, с подписью HMAC — см. subscriptions |
| Отравленное уведомление | уведомление, которое приложение не приняло 20 раз или час, — отложено, чтобы не держать очередь; см. getDeadNotifications |
| Догон | дочитывание пропущенного после обрыва связи с площадкой |
| Разрыв истории | догон не дочитал всё — уведомление syncGap |
| Темп | частота запросов к площадке, которую держит Gratio, чтобы номер не сочли ботом — см. Темп и лимиты |
| Правила качества | ограничения WhatsApp на первые сообщения, одинаковые тексты и группы — см. WhatsApp |
| Первое сообщение | сообщение в новый чат или собеседнику, который молчал 30 дней |
call_audio |
признак канала: сервер Gratio может ответить на звонок, позвонить и передать звук — см. Звонки: как это работает |
callId |
id звонка: в MAX — UUID, в WhatsApp — вида call-…; у входящего — idMessage из incomingCall |
| Цепочка | письма одной переписки по почте, threadId |
| Подписанная ссылка | ссылка на файл в хранилище Gratio, которая открывается без токена — см. Файлы и ссылки на них |
| Пауза | состояние канала с истёкшим сроком оплаты: отправка закрыта (402), приём работает |
Словарь
Была ли статья полезна?