Справочник API публикуется на английском языке.

Read authoritative delivery status for a Board publication batch

GET/api/chat-endpoints/{endpointId}/conversations/{conversationId}/publications/{publicationId}/status
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Read authoritative delivery status for a Board publication batch.

Returns the complete ordered batch, its first unresolved part and separate delivered, waiting, declined, expired and cancelled counts. Dismissal is allowed only when every part is settled; a consent card or upload receipt is not final file delivery. This read-only endpoint never retries or sends provider messages. The original publication ID remains a stable batch anchor.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

endpointIdstring (uuid)ОбязательныйThe endpoint's id.
conversationIdstring (uuid)ОбязательныйThe conversation's id.
publicationIdstring (uuid)ОбязательныйThe publication's id.

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Chat channels