Skip to content

推送 websocket cmd 消息

用于三方应用通知消息到协作客户端,用于实现类似会议呼叫弹窗的场景。

接入流程

image.png

请求说明

请求地址配置域名+/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_idinteger企业id
contentstring自定义格式消息内容,业务方自行指定,最大 10kb
user_ids[]integer成员列表,支持向多人推送消息,每次上限为 100

请求体示例

json
{
  "company_id": 1,
  "content": "调用方自定义的通知内容",
  "user_ids": [123, 234]
}

响应体

名称类型说明
resultinteger状态码,非 0 表示失败,参照《状态码说明》

响应体示例

status code 200,表示请求成功。

json
{
    "msg": string,
    "result": integer
}