查询广播消息 - 即时通信

请求参数

Path 参数

broadcast_id

string

必需

需要查询的广播消息 ID。

示例值:

11111

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open.yunxinapi.com/im/v2/broadcast_notification/11111' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

content

string

必需

广播消息内容，长度上限 4096 个字符。

from_account_id

string

可选

广播消息发送者的云信账号 ID。

offline_enabled

boolean

可选

广播消息是否存离线。默认为 false（不存）。

ttl

integer

必需

存离线的有效时间，单位为小时，默认为 168 小时，即 7 天。只有 offline_enabled = true 时，该参数才有效。

target_os

string

可选

接收广播消息的目标客户端，默认为所有客户端。JSONArray 格式，例如： ["ios","aos","pc","web","mac"]

broadcast_id

string

广播消息的 ID。

必需

create_time

number

必需

广播消息发送时间戳。

expire_time

number

必需

广播消息过期时间戳。

client_broadcast_id

string

必需

聊天室全服广播消息 ID。使用 uuid 等随机串，客户端会通过该 ID 进行消息去重。

sender_id

string

必需

聊天室广播消息发送者的云信账号 ID。

extension

string

可选

开发者扩展字段，长度上限 4096 位字符。

resend_flag

integer

必需

是否为重发消息。0（默认）：非重发消息；1：重发消息（会根据 client_broadcast_id 检查去重逻辑）。

>= 0<= 1

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "content": "string",
    "from_account_id": "string",
    "offline_enabled": true,
    "ttl": 0,
    "target_os": "string",
    "broadcast_id": "string",
    "create_time": 0,
    "expire_time": 0,
    "client_broadcast_id": "string",
    "sender_id": "string",
    "extension": "string",
    "resend_flag": 0
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误