更新群信息
请求方法
POST
请求地址
/sessions/{sessionId}/info
请求参数
参数 | 参数类型 | 数据类型 | 是否必须 | 描述 |
---|---|---|---|---|
sessionName | Body | String | 否【默认:空】 | 会话名称【限制:最大长度200,超出会截取前200作为名称】 |
iconId | Body | String | 否【默认:空】 | 群头像 |
isAllowEditSession | Body | boolean | 否【默认:false】 | 打开则仅允许管理员\群主编辑会话,关闭则允许所有人编辑 |
isPersistent | Body | boolean | 否【默认:false】 | 是否永久群聊 |
isPublic | Body | boolean | 否【默认:false】 | 是否是公开群聊(只有群组需要) |
isEntryCheck | Body | boolean | 否【默认:false】 | 是否是开启入群验(只有群组需要) |
isShowHistory | Body | boolean | 否【默认:true】 | 新成员可查看历史消息(只有群组需要) |
HTTP状态码
返回值 | 描述 |
---|---|
200 | 操作成功,详见响应参数 |
400 | 客户端传参异常 |
401 | 鉴权失败 |
500 | 服务端异常 |
请求消息示例
POST /open/api/v2/sessions/277258746492041884/info HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"sessionName": "测试群",
"isPersistent": false,
"isPublic": false
}
响应消息示例
{
}