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.

How to work with notifications

⚙️ 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

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

chatId

Type: integer

The chat ID.

Min value: 1

messageId

Type: integer

The ID of the message.

Min value: 1

Responses

200 OK

The message and information about it.

Body

application/json
{
  "status": "OK"
}

Type: object

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

404 Not Found

The requested resource was not found. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

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.