Receiving a chat message
The method is available for all models.
If you are using an API Key token, one of the accesses in the list is required to call the method
- communication — Customer communication
- all-methods — Full account management
- all-methods:read-only — View all data
Returns a message by its ID.
Enable API notifications
Yandex.Market will send you a request. POST notification when a new chat or message appears.
| , Limit: 1,000 requests per hour |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/chats/message
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market?
Min value: |
Query parameters
|
Name |
Description |
|
chatId* |
Type: integer<int64> The chat ID. Min value: |
|
messageId* |
Type: integer<int64> The ID of the message. Min value: |
Responses
200 OK
The message and information about it.
Body
application/json
{
"status": "OK",
"result": {
"messageId": 0,
"createdAt": "2017-11-21T00:00:00+03:00",
"sender": "PARTNER",
"message": "string",
"payload": [
{
"name": "string",
"url": "string",
"size": 0
}
]
}
}
|
Name |
Description |
|
result |
Type: ChatMessageDTO Information about the message. |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ChatMessageDTO
Information about the message.
|
Name |
Description |
|
createdAt* |
Type: string<date-time> The date and time when the message was created. Date format: ISO 8601 with an offset relative to UTC. Example: |
|
messageId* |
Type: integer<int64> The ID of the message. Min value: |
|
sender* |
Type: ChatMessageSenderType Sender. Enum: |
|
message |
Type: string The text of the message. Optional parameter if the parameter is returned |
|
payload |
Type: ChatMessagePayloadDTO[] Information about the files attached to the message. Optional parameter if the parameter is returned Min items: |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
ChatMessageSenderType
Who sent the message:
PARTNER— the store.CUSTOMER— the buyer.MARKET— Market (automatic message).SUPPORT— a Yandex. Market support employee.
|
Type |
Description |
|
Enum: |
ChatMessagePayloadDTO
Information about the files attached to the message.
|
Name |
Description |
|
name* |
Type: string The file name. |
|
size* |
Type: integer<int32> The file size in bytes. |
|
url* |
Type: string The link to download the file. Min length: Max length: |
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
|
Name |
Description |
|
code* |
Type: string The error code. |
|
message |
Type: string Description of the error. |
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error in Yandex. Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.
For example, Please do not ask customers for contacts, do not send links to other sites. We see the correspondence and hide the goods from the showcase when the rules of communication in chat rooms are violated.