接收聊天消息

方法适用于所有模式.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一
  • communication — 与买家沟通
  • all-methods — 全面管理账户
  • all-methods:read-only — 查看所有数据

按其ID返回消息。

启用API通知

燕基科斯.Market会向您发送请求。 POST 通知书 出现新聊天或消息时。

如何使用通知

⚙️ 限制: 每小时1,000个请求

Request

GET

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/chats/message

Path parameters

Name

Description

businessId*

Type: integer<int64>

内阁ID。 要找到答案，请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店？

Min value: 1

Query parameters

Name

Description

chatId*

Type: integer<int64>

的聊天ID。

Min value: 1

messageId*

Type: integer<int64>

消息的ID。

Min value: 1

Responses

200 OK

的消息和关于它的信息。

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

status*

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

result
Type: object

createdAt*

Type: string<date-time>

创建消息的日期和时间。

日期格式: ISO 8601 具有相对于 UTC.

Example: 2017-11-21T00:00:00+03:00

messageId*

Type: integer<int64>

消息的ID。

Min value: 1

sender*

Type: string

谁发的消息:

  • PARTNER — 商店。
  • CUSTOMER — 买方。
  • MARKET — 市场(自动讯息).
  • SUPPORT — Yandex的员工。市场支持服务。

Enum: PARTNER, CUSTOMER, MARKET, SUPPORT

message

Type: string

消息的文本。

如果返回参数，可选参数 payload.

payload

Type: object[]

附加到消息的文件的信息。

如果返回参数，可选参数 message.
附加到消息的文件的信息。

Min items: 1

消息的信息。

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

500 Internal Server Error

市场的内部错误。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

例如, 请不要向客户询问联系人，不要发送链接到其他网站。 当聊天室的通信规则被违反时，我们会看到通信并将商品隐藏在展示柜中。

上一篇
获取聊天列表
下一篇
创建新聊天