申请入群 | OpenIM Docs

跳到主要内容

申请入群

简要描述

用户申请加入群聊，当群设置为允许任何人加入时，会直接加入，否则需要群主或管理员同意。

请求方式

post

请求URL

{API_ADDRESS}/group/join_group

header名	示例值	选填	类型	说明
operationID	1646445464564	必填	string	用于全局链路追踪，建议使用时间戳，在每个请求中独立
token	eyJhbxxxx3Xs	必填	string	管理员 token

请求参数示例

{
 "groupID": "xadxwr24",
 "reqMessage": "req msg join group",
 "joinSource": 0,
 "inviterUserID": "4251711209"
}

字段名	选填	类型	说明
groupID	必填	string	群ID
reqMessage	选填	string	申请信息
joinSource	必填	int	加群来源，1：管理员邀请，2：被邀请，3：搜索加入，4：扫码加入
inviterUserID	必填	string	申请者ID
ex	选填	string	扩展字段

成功返回示例

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

成功返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，0表示成功
errMsg	string	错误简要信息，为空
errDlt	errDlt	错误详细信息，为空
data	object	通用数据对象，具体结构见下方

失败返回示例

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名	类型	说明
errCode	int	错误码，具体查看全局错误码文档
errMsg	string	错误简要信息
errDlt	errDlt	错误详细信息

申请入群