向指定客户端发送消息 - 齐成云·IM消息服务

向指定的客户端ID列表发送消息

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer QC2b8fd0ca342c72f857f5f96

Appid

string

可选

默认值:

1001

ClientId

string

可选

默认值:

131231231223

TimeStamp

string

可选

默认值:

Client-Type

string

可选

默认值:

EnterpriseCenterWEB

Body 参数application/json

clientIds

array[string]

客户端ID列表

必需

>= 1 items<= 100 items

示例值:

["client_web_001","client_mobile_002"]

eventType

string

事件类型

必需

>= 1 字符<= 50 字符

示例值:

notification

message

消息内容

必需

示例值:

{"type":"text","content":"系统通知消息","timestamp":1697548800000}

options

object

发送选项

可选

priority

enum<string>

可选

枚举值:

lownormalhigh

默认值:

normal

persistent

boolean

可选

默认值:

false

示例

{
    "clientIds": [
        "client_web_001",
        "client_mobile_002"
    ],
    "eventType": "notification",
    "message": {
        "type": "text",
        "content": "系统通知消息",
        "timestamp": 1697548800000
    },
    "options": {
        "priority": "normal",
        "persistent": false
    }
}

返回响应

🟢200成功

application/json

发送完成

Body

object {0}

示例

部分发送成功全部发送成功

{
    "code": 1,
    "message": "操作成功",
    "language": "zh-CN",
    "timestamp": 1697548800000,
    "data": {
        "sentToClients": [
            "client_web_001"
        ],
        "totalSent": 1
    }
}

🟠400请求有误

🔴500服务器错误