IM聊天室服务-创建会话 FunctionCode | SER-B006

简介

创建会话

接口说明

• 请求方式 POST
• Headers Content-Type: application/json
• Headers Authorization: Bearer ${access_token}

正式环境	测试环境
https://linkingcloud.cn/#/contact-us	https://api.linkingopen.com/test/service/im/eplustoolim/api/conversation/create

请求参数

名称	描述	类型	必填
conversationId	会话Id	string	是
creatorUserId	创建用户Id	string	是
name	会话名称，群聊时必传	string	否
type	会话类型(1:单聊，2:群聊)	int	是
accessMode	会话类型 (1-私密 2-公开 默认1)	int	是
userId	用户Id	string	是
userSig	用户签名	string	是
memberList	会话人员列表	list<object>	是

请求参数

名称	描述	类型	必填
userId	用户Id	string	是
userName	用户名称	string	是
avatar	头像（fileId）	string	否
role	角色(1-普通成员 2-管理员 3-群主)	int	否
status	状态(1-正常 2-已踢出 )	int	否
sex	状态(1-女 2-男 )	int	否

提示

无

返回参数

名称	描述	类型	必填
code	错误码(1标识成功)	int	是
data	返回数据。	string	是
message	错误消息	string	否

接口示例

参数示例

请求参数

{
  "conversationId": "123456",
  "creatorUserId": "123",
  "name": "测试群组",
  "type": 2,
  "accessMode": 1,
  "userId": "123",
  "userSig": "123",
  "memberList": [
    {
      "userId": "123",
      "userName": "用户1",
      "role": 1,
      "status": 1,
      "sex": 1
    },
    {
      "userId": "456",
      "userName": "用户2",
      "role": 3,
      "status": 1,
      "sex": 2
    }
  ]
}

返回参数

{
  "code": 1,
  "message": "操作成功",
  "requestId": null,
  "data": "fb4a90e4053a4fadb5a551ea7f98d519",
  "success": true
}