资源工坊

创建群聊 ​

用于创建群聊会话。

请求说明 ​

请求地址配置域名+/o/woa/api/v1/developer/app/chats
请求方法POST
签名方式wps-4
支持应用类型企业自建应用、第三方企业应用
权限要求管理会话及会话成员信息(kso.im.chat.manage)

请求头 ​

Header 名称是否必填说明
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值

请求体（Body） ​

名称类型是否必填说明
chat_namestring否群聊名称
company_idinteger是企业id
ownerinteger是群主 id（不支持机器人成为群主）
members[]integer否群成员 id 列表，上限 100 人
avatarstring否群聊头像 store_key
join_approveboolean否是否开启【群主所属企业的人员进群需审核】
change_info_constraintboolean否是否开启【仅群主和管理员可修改群信息】
mention_all_disableboolean否是否开启【仅群主和管理员可@所有人】
enable_nicknameboolean否是否开启【群昵称优先展示】

请求地址示例 ​

http
[POST] 配置域名+/o/woa/api/v1/developer/app/chats

请求体示例 ​

json
{
  "chat_name": "string",
  "owner": 123,
  "members": [123],
  "join_approve": true,
  "change_info_constraint": true,
  "mention_all_disable": true,
  "enable_nickname": true,
  "avatar": "string"
}

响应体 ​

名称类型说明
resultinteger状态码，非 0 表示失败，参照《状态码说明》
chatidinteger会话 id

响应体示例 ​

json
{
  "result": 0,
  "chatid": 123107
}