网易云信服务端支持查询指定消息（包括单聊消息、高级群消息和超大群消息）的快捷评论。

调用添加消息快捷评论接口前，请至网易云信控制台 开通消息快捷评论。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

POST https://open.yunxinapi.com/im/v2/messages/actions/quick_comment

Header

请求 Header 的参数说明请参考 请求 Header。

请求体参数

参数名称	类型	是否必选	描述
- messages	Array of objects	是	待查询的消息列表，单次最多查询 20 条。
conversation_type	Integer	是	会话类型。1：单聊；2：高级群；3：超大群。
sender_id	String	是	消息的发送者 ID。
receiver_id	String	是	消息的接收者 ID。
message_server_id	Long	是	消息的服务器 ID。
message_client_id	String	是	消息的客户端 ID。
create_time	Long	是	消息的发送时间。

请求体示例

json{
    "messages": [
        {
            "sender_id": "account1",
            "receiver_id": "account2",
            "conversation_type": 1,
            "message_server_id": 123456,
            "message_client_id": "abc123",
            "create_time": 1633420800
        },
        {
            "sender_id": "xx",
            "receiver_id": "xx",
            "conversation_type": 1,
            "message_server_id": 654321,
            "message_client_id": "xxxx",
            "create_time": 1234567
        }
    ]
}

响应

Header

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
- success_list	Array of objects	查询成功的评论信息列表。	否
conversation_type	Integer	会话类型。1：单聊；2：高级群；3：超大群。	是
sender_id	String	消息的发送者 ID。	是
receiver_id	String	消息的接收者 ID。	是
message_server_id	Long	消息的服务器 ID。	是
message_client_id	String	消息的客户端 ID。	是
create_time	Long	消息的发送时间。	是
- comments	Array of objects	消息的快捷评论信息。	是
operator_id	String	评论的用户账号 ID。	是
index	Long	快捷评论类型，必须大于 0。可在本地自定义映射关系，例如： 表情回复。1：笑脸。2：大笑。UI 层根据 index 展示对应的表情。 文本快捷回复等其他回复场景。	是
extension	String	快捷评论的扩展字段，JSON 格式。例如："{"k":"v"}"。	否
time	Long	添加快捷评论的时间。	是
- failed_list	Array of objects	查询失败的消息列表。	是
conversation_type	Integer	会话类型。1：单聊；2：高级群；3：超大群。	是
sender_id	String	消息的发送者 ID。	是
receiver_id	String	消息的接收者 ID。	是
message_server_id	Long	消息的服务器 ID。	是
message_client_id	String	消息的客户端 ID。	是
create_time	Long	消息的发送时间。	是
error_code	Integer	错误码。	是
error_msg	String	错误信息。	是

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
    "success_list": [
        {
            "conversation_type": 1,
            "sender_id": "xx",
            "receiver_id": "xx",
            "message_server_id": 123,
            "message_client_id": "xxx",
            "create_time": 123,       
            "comments":[{
                "operator_id": "xx",
                "index": 2,
                "extension": "xxx",
                "time": 1112,
            }] 
        }
    ],
    "failed_list": [
        {
            "conversation_type": 1,
            "sender_id": "xx",
            "receiver_id": "xx",
            "message_server_id": 123,
            "message_client_id": "xxx",
            "create_time": 123,
            "error_code": 107348,
            "error_msg": "quick comment not exist"
        }
    ]
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
107326	快捷评论功能未开通	quick comment service disabled
108404	群组不存在	team not exist
500	服务器内部错误	internal server error