查询快捷评论 - 即时通信

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

messages

array [object {6}]

必需

待查询的消息列表，单次最多查询 20 条。

conversation_type

integer

必需

会话类型。1：单聊；2：高级群；3：超大群。

sender_id

string

必需

消息的发送者 ID。

receiver_id

string

必需

消息的接收者 ID。

message_server_id

number

必需

消息的服务器 ID。

message_client_id

string

必需

消息的客户端 ID。

create_time

number

消息的发送时间。

必需

示例

{
    "messages": [
        {
            "conversation_type": 0,
            "sender_id": "string",
            "receiver_id": "string",
            "message_server_id": 0,
            "message_client_id": "string",
            "create_time": 0
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://open.yunxinapi.com/im/v2/messages/actions/quick_comment' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messages": [
        {
            "conversation_type": 0,
            "sender_id": "string",
            "receiver_id": "string",
            "message_server_id": 0,
            "message_client_id": "string",
            "create_time": 0
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

状态码，200 表示请求成功。

msg

string

必需

提示信息。请求失败时返回错误信息，请求成功时返回 "success"。

data

object

必需

返回的 JSON 数据对象，请求失败则返回空对象。

success_list

array [object {7}]

可选

查询成功的评论信息列表。

failed_list

array [object {8}]

必需

查询失败的消息列表。

示例

{
    "code": 0,
    "msg": "string",
    "data": {
        "success_list": [
            {
                "conversation_type": 0,
                "sender_id": "string",
                "receiver_id": "string",
                "message_server_id": 0,
                "message_client_id\t": "string",
                "create_time": 0,
                "comments": [
                    {
                        "operator_id": "string",
                        "index": 0,
                        "extension": "string",
                        "time": 0
                    }
                ]
            }
        ],
        "failed_list": [
            {
                "conversation_type": 0,
                "sender_id": "string",
                "receiver_id": "string",
                "message_server_id": 0,
                "message_client_id": "string",
                "create_time": 0,
                "error_code": 0,
                "error_msg": "string"
            }
        ]
    }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误