join_group
Brief Description
- Users apply to join a group chat. If the group is set to allow anyone to join, they will join directly; otherwise, group owner or admin approval is required.
Request Method
post
Request URL
http://x.x.x.x:10002/group/join_group
Header
| Header Name | Example Value | Optional | Type | Description |
|---|---|---|---|---|
| operationID | 1646445464564 | Required | string | operationID used for global link tracking |
| token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameter Example
{
"groupID": "xadxwr24",
"reqMessage": "req msg join group",
"joinSource": 0,
"inviterUserID": "4251711209",
"ex":"ex"
}
| Field Name | Optional | Type | Description |
|---|---|---|---|
| groupID | Required | string | Group ID |
| reqMessage | Optional | string | Application message |
| joinSource | Required | int | Join group source; 1: Admin invite, 2: Invited, 3: Join by search, 4: Join by scanning QR code |
| inviterUserID | Required | string | Applicant's ID |
| ex | Optional | string | Extension field |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Successful Response Parameter Description
| Parameter Name | Type | Description |
|---|---|---|
| errCode | int | Error code, 0 indicates success |
| errMsg | string | Brief error message, empty when no error |
| errDlt | errDlt | Detailed error message |
| data | object | Generic data object, specific structure seen below |
Failed Response Example
{
"errCode": 1003,
"errMsg": "DuplicateKeyError",
"errDlt": "==> github.com/OpenIMSDK/Open-IM-Server/pkg/common/db/relation.(*GroupRequestGorm).Create()@27: Create: Error 1062: Duplicate entry 'openIMAdmin-xadxwr24' for key 'PRIMARY'"
}
Failed Response Parameter Description
| Parameter Name | Type | Description |
|---|---|---|
| errCode | int | Error code, refer to the global error code documentation for specifics |
| errMsg | string | Brief error message |
| errDlt | errDlt | Detailed error message |