获取聊天消息历史记录
方法适用于所有模式.
如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
- communication — 与买家沟通
- all-methods — 全面管理账户
- all-methods:read-only — 查看所有数据
返回与买家聊天中消息的历史记录。
| ⚙️ 限制: 每小时10,000次请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/chats/history
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> 内阁ID。 要找到答案，请使用请求 GET v2/campaigns. Min value: |
Query parameters
|
Name |
Description |
|
chatId* |
Type: integer<int64> 的聊天ID。 Min value: |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数，则返回第一页。 我们建议传输输出参数的值 如果设置 |
Body
application/json
{
"messageIdFrom": 0
}
|
Name |
Description |
|
messageIdFrom |
Type: integer<int64> 从接收所有后续消息的消息的ID。 Min value: |
Responses
200 OK
消息历史记录。
Body
application/json
{
"status": "OK",
"result": {
"orderId": 0,
"context": {
"type": "ORDER",
"customer": {
"name": "string",
"publicId": "string"
},
"campaignId": 0,
"orderId": 0,
"returnId": 0
},
"messages": [
{
"messageId": 0,
"createdAt": "2017-11-21T00:00:00+03:00",
"sender": "PARTNER",
"message": "string",
"payload": [
{
"name": "string",
"url": "string",
"size": 0
}
]
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Description |
||||||||||||||||||||||||
|
status* |
Type: string 响应的类型。 可能的值:
Enum: |
||||||||||||||||||||||||
|
result |
Type: object
消息的信息。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] 错误列表。 Min items: |
|
status |
Type: string 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.
例如, 请不要向客户询问联系人，不要发送链接到其他网站。 当聊天室的通信规则被违反时，我们会看到通信并将商品隐藏在展示柜中。