获取可用的聊天

Info

Console

方法适用于所有模式.

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

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

返回与客户的聊天。

启用API通知

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

如何使用通知

参数的限制 limit

不要传递大于20的值。

⚙️ 限制：每小时10,000次请求

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

内阁ID。要找到答案，请使用请求 :no-translate[GET v2/campaigns].

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

如果省略该参数，则返回第一页。

我们建议传输输出参数的值 nextPageToken，在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 page 和 pageSize 它们被忽略了。
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
    "orderIds": [
        0
    ],
    "contexts": [
        {
            "type": "ORDER",
            "id": 0
        }
    ],
    "contextTypes": [
        "ORDER"
    ],
    "types": [
        "CHAT"
    ],
    "statuses": [
        "NEW"
    ]
}

Name	Description
contextTypes	Type: ChatContextType[] 按聊天上下文类型进行筛选。上下文类型: `ORDER` -根据要求聊天。关于订单和退款的聊天 `RETURN` -退款聊天(FBY, FBS 和快递）。关于订单和退款的聊天 `DIRECT` -客户开始的聊天。来自客户的信息 Enum: `ORDER`, `RETURN`, `DIRECT` Min items: `1` Unique items
contexts	Type: ChatContextDTO[] 按聊天上下文过滤。有关开始聊天的订单或退款的信息。 Min items: `1` Unique items
orderIds ⦸	Type: integer<int64>[] 通过市场上的订单Id进行过滤。 Min items: `1` Unique items
statuses	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` Min items: `1` Unique items
types	Type: ChatType[] 按聊天类型过滤。聊天类型: `CHAT` -与买家聊天。 `ARBITRAGE` -争论。 Enum: `CHAT`, `ARBITRAGE` Min items: `1` Unique items

ChatContextType

上下文类型:

ORDER -根据要求聊天。关于订单和退款的聊天
RETURN -退款聊天(FBY, FBS 和快递）。关于订单和退款的聊天
DIRECT -客户开始的聊天。来自客户的信息

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

ChatContextDTO

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

Name

Description

id*

Type: integer<int64>

订单或退款ID。

Min value: 1

type*

Type: ChatContextIdentifiableType

聊天类型:

ORDER -奉命行事。
RETURN -退款(FBY, FBS 和快递）。

有关订单和退款聊天的更多信息，请参阅燕基科斯.对卖家的市场帮助.

Enum: ORDER, RETURN

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`

ChatContextIdentifiableType

聊天类型:

ORDER -奉命行事。
RETURN -退款(FBY, FBS 和快递）。

有关订单和退款聊天的更多信息，请参阅燕基科斯.对卖家的市场帮助.

Type	Description
ChatContextIdentifiableType	Enum: `ORDER`, `RETURN`

Responses

200 OK

聊天列表。

Body

application/json

{
    "status": "OK",
    "result": {
        "chats": [
            {
                "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"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: GetChatsInfoDTO

聊天列表。

ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

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

GetChatsInfoDTO

聊天列表。

Name

Description

chats*

Type: GetChatInfoDTO[]

关于聊天的信息。
关于聊天的信息。

paging

Type: ForwardScrollingPagerDTO

下一页的ID。

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`

ForwardScrollingPagerDTO

下一页的ID。

Name

Description

nextPageToken

Type: string

下一个结果页面的ID。

ChatFullContextDTO

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

Name	Description
type*	Type: ChatContextType 上下文类型: `ORDER` -根据要求聊天。关于订单和退款的聊天 `RETURN` -退款聊天(FBY, FBS 和快递）。关于订单和退款的聊天 `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`

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}/评论]
禅宗: ：没有-翻译[https://zen.yandex.ru/user/{公共id}]
检讨报告: ：没有-翻译[https://yandex.ru/user/{公共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

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

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

这篇文章是否有用？

获得一个单一的聊天

接收消息