Group Type | Applicable |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as meeting groups (Meeting) in the new version. |
AVChatRoom | No |
Community | Yes |
https://xxxxxx/v4/group_open_http_svc/import_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/import_group_member | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is fixed to json . |
{"GroupId": "@TGS#2J4SZEAEL", // (Required) Target group"MemberList": [ // Up to 300 members can be added at a time.{"Member_Account": "tommy", // (Required) ID of the member to be added"Role":"Admin", // (Optional) Role of the group member to be imported. Currently, the only supported role is Admin."JoinTime":1448357837, // (Optional) Time when the group member to be imported joined the group"UnreadMsgNum":5 // (Optional) Unread message count of the member},{"Member_Account": "jared","JoinTime":1448357857,"UnreadMsgNum":2}]}
Field | Type | Required | Description |
GroupId | String | Yes | ID of the target group |
MemberList | Array | Yes | A list of the members to be added |
Member_Account | String | Yes | Group member accounts to be imported |
Role | String | No | Role of the group member to be imported. Currently, only Admin is supported. If this field is not specified, the value Member (ordinary user) is used. |
JoinTime | Integer | No | Time when the group member to be imported joined the group |
UnreadMsgNum | Integer | No | Unread message count of the group member to be imported |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"MemberList": [{"Member_Account": "tommy","Result": 1 // Result of the import. 0: Failed; 1: Succeeded; 2: Already a group member},{"Member_Account": "jared","Result": 1}]}
Field | Type | Description |
ActionStatus | String | Request result. OK : successful; FAIL : failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
MemberList | Array | The result of adding members |
Member_Account | String | Account of the group member |
Result | Integer | Result of the import. 0: Failed; 1: Succeeded; 2: Already a group member |
ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:Error Code | Description |
10002 | Internal server error. Try again. |
10003 | Invalid command word. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10005 | The request packet carries too many accounts. |
10006 | Reached the operation frequency limit. Please reduce the call rate. |
10007 | No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so. |
10010 | The group does not exist or has been disbanded. |
10015 | Invalid group ID. Use the correct group ID. |
Was this page helpful?