推送 websocket cmd 消息
用于三方应用通知消息到协作客户端,用于实现类似会议呼叫弹窗的场景。
接入流程

请求说明
| 请求地址 | 配置域名+/o/woa/api/v1/developer/push/cmd_msg |
|---|---|
| 请求方法 | POST |
| 签名方式 | wps-4 |
| 支持应用类型 | 企业自建应用 |
| 权限要求 | 使用websocket推送(kso.im.websocket.write) |
请求头
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权token,格式:Bearer ${access_token},${access_token}需替换为从授权接口获取的access_token值 |
请求地址示例
http
[POST] 配置域名+/o/woa/api/v1/developer/push/cmd_msg请求体(Body)
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| company_id | integer | 是 | 企业id |
| content | string | 是 | 自定义格式消息内容,业务方自行指定,最大 10kb |
| user_ids | []integer | 是 | 成员列表,支持向多人推送消息,每次上限为 100 |
请求体示例
json
{
"company_id": 1,
"content": "调用方自定义的通知内容",
"user_ids": [123, 234]
}响应体
| 名称 | 类型 | 说明 |
|---|---|---|
| result | integer | 状态码,非 0 表示失败,参照《状态码说明》 |
响应体示例
status code 200,表示请求成功。
json
{
"msg": string,
"result": integer
}