К содержанию
sapportlydocs
Панель

Справочник публичного API

OpenAPI 1.4.0, 37 путей. Сгенерировано из спецификации, не из ручного списка.

Здесь только публичная поверхность: API-ключ, visitor JWT, Site ID. Панель, staff admin и agent token не документируются.

Status

МетодПутьAuthСуть
GET/v1/statusнетPublic API version

Ingest

МетодПутьAuthСуть
POST/v1/ingest/messagesAPI keyServer ingest message

Widget

МетодПутьAuthСуть
POST/v1/widget/bootstrapнетBootstrap visitor session (browser embed)
POST/v1/widget/embed-sessionAPI keyIssue visitor session (server BFF)
GET/v1/widget/messagesVisitor JWTVisitor chat history
POST/v1/widget/messagesVisitor JWTVisitor send message
POST/v1/widget/eventsVisitor JWTWidget analytics beacon
POST/v1/widget/identifyVisitor JWTSet visitor identity traits
POST/v1/widget/canned-promptVisitor JWTExchange canned prompt pair
GET/v1/widget/channel-securityVisitor JWTChannel encryption metadata for visitor
POST/v1/widget/e2ee/startVisitor JWTStart E2EE session handshake
GET/v1/widget/capability-confirmVisitor JWTPending capability confirm cards for the visitor
POST/v1/widget/capability-confirmVisitor JWTVisitor confirms or cancels a pending capability write

Attachments

МетодПутьAuthСуть
POST/v1/attachments/intentAPI keyCreate presigned upload intent
POST/v1/attachments/{id}/completeAPI keyFinalize attachment after S3 upload
GET/v1/attachments/{id}API keyAttachment metadata
GET/v1/attachments/{id}/downloadAPI keyDownload attachment bytes
POST/v1/attachments/upload-intentAPI keyAlias for POST /v1/attachments/intent
POST/v1/widget/attachments/intentVisitor JWTVisitor attachment upload intent
POST/v1/widget/attachments/{id}/completeVisitor JWTFinalize visitor attachment upload
GET/v1/widget/attachments/{id}/downloadVisitor JWTDownload visitor attachment

WebSocket

МетодПутьAuthСуть
POST/v1/ws/ticketAPI keyIssue WebSocket connection ticket

Channels

МетодПутьAuthСуть
GET/v1/channelsAPI keyList registered channels
POST/v1/channelsAPI keyCreate channel
GET/v1/channels/{id}API keyGet channel by id
PATCH/v1/channels/{id}API keyUpdate channel
DELETE/v1/channels/{id}API keyArchive channel

Conversations

МетодПутьAuthСуть
GET/v1/conversationsAPI keyList conversation summaries
GET/v1/conversations/{channel}/messagesAPI keyMessage history for a channel
POST/v1/conversations/{channel}/messagesAPI keyAgent reply in a widget conversation
GET/v1/conversations/{channel}/assignmentAPI keyGet conversation assignment
PUT/v1/conversations/{channel}/assignmentAPI keyAssign conversation
POST/v1/conversations/{channel}/transferAPI keyTransfer conversation assignment
GET/v1/conversations/{channel}/assignment/historyAPI keyAssignment history

Analytics

МетодПутьAuthСуть
POST/v1/analytics/trackAPI keyTrack widget or product analytics event

Team

МетодПутьAuthСуть
GET/v1/team/rolesAPI keyList tenant roles (SDK routing)

Webhooks

МетодПутьAuthСуть
GET/v1/webhooksAPI keyGet outbound webhook config
POST/v1/webhooksAPI keyCreate outbound webhook endpoint
PUT/v1/webhooksAPI keyLegacy update of the first outbound webhook
PATCH/v1/webhooks/{id}API keyUpdate webhook endpoint
DELETE/v1/webhooks/{id}API keyDelete webhook endpoint
POST/v1/webhooks/{id}/testAPI keySend a test webhook delivery
POST/v1/webhooks/testAPI keySend a test webhook delivery

RAG

МетодПутьAuthСуть
GET/v1/rag/documentsAPI keyList knowledge documents
POST/v1/rag/documentsAPI keyIndex a knowledge document
DELETE/v1/rag/documents/{id}API keyDelete a knowledge document

Contacts

МетодПутьAuthСуть
GET/v1/contactsAPI keyList visitor identities
GET/v1/contacts/{channel}API keyGet identity for a channel
PUT/v1/contacts/{channel}API keyUpsert identity traits for a channel

Страница полезна?

/docs/api/reference
Справочник публичного API — из OpenAPI · Sapportly Docs