创建会话
更新时间:2025-01-28 06:34:02

创建会话

请求方法

POST

请求地址

/sessions

请求参数

参数 参数类型 数据类型 是否必须 描述
sessionType Body string 会话类型, 群聊:group
sessionName Body String 会话名称【限制:最大长度200,超出会截取前200作为名称】
iconId Body String 否【默认:空】 群头像
managerIds Body list 否【默认:空】 群管理员id集合(用户或者机器人)
members Body list 否【默认:空】 会话成员ID集合:最多支持100人(暂定),默认包含创建群聊的授权用户(若为授权用户创建,不需重复填写)
robotIds Body list 否【默认:空】 群机器人ID列表
isAllowEditSession Body boolean 否【默认:false】 打开则仅允许管理员\群主编辑会话,关闭则允许所有人编辑
isPersistent Body boolean 否【默认:false】 是否永久群聊
isPublic Body boolean 否【默认:false】 是否是公开群聊
isEntryCheck Body boolean 否【默认:false】 是否是开启入群验
isShowHistory Body boolean 否【默认:false】 新成员可查看历史消息

HTTP状态码

返回值 描述
200 操作成功,详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
sessionId Long 会话id
partyId String 企业id
memberNum Integer 成员数量
creatorId String 创建者id
version Long 会话信息版本号
isOutside Long 外部会话
sessionName String 会话名称
sessionType String 会话类型

请求消息示例

POST /open/api/v2/sessions HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
        "sessionType": "group", 
        "sessionName": "测试群", 
        "isPersistent": false, 
        "isPublic": false, 
        "members": ["001","002","003","004","005"] 
}

响应消息示例


{
                "sessionId": 277258746492041884,
                "sessionType": "group", 
                "isOutside": false, 
                "memberNum": 6,
                "creatorId": "0023cff55b1a47ee937e8da963ca92f4", 
                "partyId": "f4a4a4ee02ac4bb8875bbd08e03d4de0",
                "sessionName": "测试群",
                "version": 508576373011382272 

}
本页目录