Feature Description

• This API is used to import group members without triggering callbacks or delivering notifications.
• When your app needs to be migrated to IM from another instant messaging system, you can use this protocol to import existing group member data.

API Calling Description

Applicable group types

IM comes with the preceding four group types. For more information, see Group System.

Note：

Generally, importing group members is not required for AVChatRoom, so AVChatRoom does not support this API. If you attempt to use API on AVChatRoom, error 10007 will be returned.

Request URL example

https://xxxxxx/v4/group_open_http_svc/import_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table lists only the parameters to be modified when this API is called. For details on other parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 times per second.

Request packet example

Request packets are used to import group members. A single request supports the import of a maximum of 300 members. If the unread message count specified by this API is greater than the current number of messages of the group, the unread message count is set to the current number of messages of the group.

Note：

Ensure that the join time of the member to be imported is later than the group creation time and earlier than the current time. Otherwise, the member cannot be imported.

{
  "GroupId": "@TGS#2J4SZEAEL", // Target group (required)
  "MemberList": [ // A maximum of 300 members can be added at a time.
  {
      "Member_Account": "tommy" // ID of the group member to be added (required)
      "Role":"Admin", // Role of the group member to be imported. Currently, the only supported role is Admin (optional).
      "JoinTime":1448357837, // Time when the group member to be imported joined the group (optional)
      "UnreadMsgNum":5 // Unread message count of this member (optional)
   },
  {
      "Member_Account": "jared",
      "JoinTime":1448357857,
      "UnreadMsgNum":2
  }]
}

Request packet fields

Response packet example

{
  "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
  }]
}

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code of this API is always 200. The actual error code and error information are represented by ErrorCode and ErrorInfo in the response packet, respectively.
For common error codes (60000 to 79999), see Error Codes.
The private error codes for this API are as follows:

API Debugging Tools

Use the online debugging tool for RESTful APIs to debug this API.

Reference

Deleting group members v4/group_open_http_svc/delete_group_member)