invite_user_to_group
Brief Description
- Invite users to a group.
Request Method
post
Request URL
http://x.x.x.x:10002/group/invite_user_to_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": "2759960147",
"invitedUserIDs": [
"1225441072",
"9906953281"
],
"reason": "your reason"
}
| Field Name | Optional | Type | Description |
|---|---|---|---|
| groupID | Required | string | Group ID |
| invitedUserIDs | Required | array | List of invited user IDs |
| reason | Optional | string | Reason for invitation |
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": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
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 |