通过ID进行聊天

Info

Console

方法适用于所有模式.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

communication — 与买家沟通
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

通过其ID返回聊天。

启用API通知

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

如何使用通知

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

Request

GET

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

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

Responses

200 OK

关于聊天的信息。

Body

application/json

{
    "status": "OK",
    "result": {
        "chatId": 0,
        "orderId": 0,
        "context": {
            "type": "ORDER",
            "customer": {
                "name": "string",
                "publicId": "string"
            },
            "campaignId": 0,
            "orderId": 0,
            "returnId": 0
        },
        "type": "CHAT",
        "status": "NEW",
        "createdAt": "2017-11-21T00:00:00+03:00",
        "updatedAt": "2017-11-21T00:00:00+03:00"
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

result

Type: GetChatInfoDTO

关于聊天的信息。

ApiResponseStatusType

响应的类型。可能的值:

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

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

GetChatInfoDTO

关于聊天的信息。

Name	Description
chatId*	Type: integer<int64> 的聊天ID。 Min value: `1`
context*	Type: ChatFullContextDTO 有关开始聊天的订单或退款的信息。
createdAt*	Type: string<date-time> 创建聊天的日期和时间。日期格式: ISO 8601 具有相对于 UTC. Example: `2017-11-21T00:00:00+03:00`
status*	Type: ChatStatusType 聊天状态: `NEW` — 一个新的聊天。 `WAITING_FOR_CUSTOMER` — 我们需要买家的回应。 `WAITING_FOR_PARTNER` — 我们需要商店的回应。 `WAITING_FOR_ARBITER` — 我们需要仲裁员的回应。 `WAITING_FOR_MARKET` — 我们需要Yandex的回应。市场。 `FINISHED` — 聊天结束了。 Enum: `NEW`, `WAITING_FOR_CUSTOMER`, `WAITING_FOR_PARTNER`, `WAITING_FOR_ARBITER`, `WAITING_FOR_MARKET`, `FINISHED`
type*	Type: ChatType 聊天类型: `CHAT` — 与买家聊天。 `ARBITRAGE` — 争议。 Enum: `CHAT`, `ARBITRAGE`
updatedAt*	Type: string<date-time> 聊天中最后一条消息的日期和时间。日期格式: ISO 8601 具有相对于 UTC. Example: `2017-11-21T00:00:00+03:00`
orderId ⦸	Type: integer<int64> 的订单ID。 Min value: `1`

ChatFullContextDTO

有关开始聊天的订单或退款的信息。

Name	Description
type*	Type: ChatContextType 上下文类型: `ORDER` — 根据要求聊天。关于订单和退款的聊天 `RETURN` — 退款聊天(FBY, FBS 和 Express). 关于订单和退款的聊天 `DIRECT` — 客户开始的聊天。来自客户的信息 Enum: `ORDER`, `RETURN`, `DIRECT`
campaignId	Type: integer<int64> 活动ID。它被退回的订单和退款。
customer	Type: ChatCustomerDTO Информация о покупателе.
orderId	Type: integer<int64> 的订单ID。它被退回的订单和退款。 Min value: `1`
returnId	Type: integer<int64> 退款ID。它仅用于退款。 Min value: `1`

ChatStatusType

聊天状态:

NEW — 一个新的聊天。
WAITING_FOR_CUSTOMER — 我们需要买家的回应。
WAITING_FOR_PARTNER — 我们需要商店的回应。
WAITING_FOR_ARBITER — 我们需要仲裁员的回应。
WAITING_FOR_MARKET — 我们需要Yandex的回应。市场。
FINISHED — 聊天结束了。

Type	Description
ChatStatusType	Enum: `NEW`, `WAITING_FOR_CUSTOMER`, `WAITING_FOR_PARTNER`, `WAITING_FOR_ARBITER`, `WAITING_FOR_MARKET`, `FINISHED`

ChatType

聊天类型:

CHAT — 与买家聊天。
ARBITRAGE — 争议。

Type	Description
ChatType	Enum: `CHAT`, `ARBITRAGE`

ChatContextType

上下文类型:

ORDER — 根据要求聊天。关于订单和退款的聊天
RETURN — 退款聊天(FBY, FBS 和 Express). 关于订单和退款的聊天
DIRECT — 客户开始的聊天。来自客户的信息

Type	Description
ChatContextType	Enum: `ORDER`, `RETURN`, `DIRECT`

ChatCustomerDTO

聊天中有关买家的信息。

Name

Description

name

Type: string

买方在Yandex Passport中的公开名称，显示在Yandex services中。

Min length: 1

publicId

Type: string

Yandex Passport中的公共用户ID。

使用它的例子

市场: https://market.yandex.ru/user/{public-id}/reviews
禅宗: https://zen.yandex.ru/user/{public-id}
检讨报告: https://yandex.ru/user/{public-id}

阅读更多关于公共数据的信息 Yandex ID文档.

Min length: 1

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

401 Unauthorized

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

403 Forbidden

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

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

Enum: OK, ERROR

这篇文章是否有用？

消息历史记录

获取聊天列表