即时通信

发送高级群已读回执

POST

/im/v2/messages/actions/team_read_receipt

请求参数

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

from_account_id

string

必需

已读回执发送方（即消息接收方）的云信账号 ID。

team_id

string

必需

接收已读回执的高级群 ID。

message_server_ids

array[integer <long>]

必需

需要标记为已读的服务端消息 ID。最多传入 50 条高级群消息。

示例

{
  "from_account_id": "apifoxtest31",
  "team_id": "18358256847",
  "message_server_ids": [
    1232001762022391800
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.yunxinapi.com/im/v2/messages/actions/team_read_receipt' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "from_account_id": "apifoxtest31",
    "team_id": "18358256847",
    "message_server_ids": [
        1232001762022391810
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

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

success_list

array[integer <long>]

可选

发送已读回执成功的消息 ID 列表。

failed_list

array[integer <long>]

可选

发送已读回执失败的消息 ID 列表。

示例

{
  "code": 200,
  "msg": "success",
  "success_list": [
    1623412231
  ],
  "failed_list": [
    1623112231
  ]
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-26 02:26:05

发送单聊已读回执

查询群消息已读未读详情