VendorChatApi
All URIs are relative to https://business.apis.kesk.app/v1Â
| Method | HTTP request | Description |
|---|---|---|
| vendorGetChat | GET /vendors/{vendor_id}/chats/{session_id} | Get chat session details |
| vendorGetChatMedia | GET /vendors/{vendor_id}/chats/{session_id}/media/{media_id} | Get a specific media item from a vendor chat session |
| vendorGetChatMessages | GET /vendors/{vendor_id}/chats/{session_id}/messages | Get chat messages |
| vendorListChatMedia | GET /vendors/{vendor_id}/chats/{session_id}/media | List all media in a vendor chat session |
| vendorListChats | GET /vendors/{vendor_id}/chats | List vendor chat sessions |
| vendorSendChatMessage | POST /vendors/{vendor_id}/chats/{session_id}/messages | Send a message in chat |
| vendorUploadChatMedia | POST /vendors/{vendor_id}/chats/{session_id}/media | Upload media for a vendor chat session |
vendorGetChat
VendorChatSessionResponse vendorGetChat(vendor_id, session_id)
Get chat session details
Retrieves details of a specific chat session including metadata.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
vendorGetChatMedia
VendorChatMediaResponse vendorGetChatMedia(vendor_id, session_id, media_id)
Get a specific media item from a vendor chat session
Retrieves information about a specific media file in a chat session.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | Long | [default to null] | |
| media_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
vendorGetChatMessages
VendorChatMessagesResponse vendorGetChatMessages(vendor_id, session_id, limit, before_message_id)
Get chat messages
Retrieves messages from a chat session with pagination support.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | Long | [default to null] | |
| limit | Integer | [optional] [default to null] | |
| before_message_id | Long | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
vendorListChatMedia
List vendorListChatMedia(vendor_id, session_id, limit, offset)
List all media in a vendor chat session
Retrieves a paginated list of all media files in a chat session.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | Long | [default to null] | |
| limit | Integer | [optional] [default to null] | |
| offset | Integer | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
vendorListChats
VendorChatSessionListResponse vendorListChats(vendor_id, limit, before)
List vendor chat sessions
Retrieves all chat sessions for the specified vendor with pagination support. Returns chat sessions ordered by most recent activity.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| limit | Integer | [optional] [default to null] | |
| before | String | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
vendorSendChatMessage
VendorChatMessageResponse vendorSendChatMessage(vendor_id, session_id, VendorSendMessageRequest)
Send a message in chat
Sends a message in the chat session as a vendor representative.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | Long | [default to null] | |
| VendorSendMessageRequest | VendorSendMessageRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
vendorUploadChatMedia
VendorChatMediaUploadResponse vendorUploadChatMedia(vendor_id, session_id, file)
Upload media for a vendor chat session
Uploads a file (image, audio, video, or document) to be used in a chat message. Returns media information including the URL to include in the message payload.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| session_id | Long | [default to null] | |
| file | File | The file to upload | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json; charset=utf-8