tencent cloud

Feature Description

Through this API, the app admin can import groups without triggering callbacks or delivering notifications. When your app needs to be migrated to Instant Messaging (IM) from another instant messaging system, you can use this API to import existing group data.

API Calling Description

Applicable group types

IM provides the preceding five built-in group types. For details, see Group Systems.

AVChatRoom and BChatRoom groups do not support importing basic group data. If you attempt to import basic group data for these types of groups, error 10007 returns. To achieve the effect of importing basic group data, you can create a group and modify basic group data.

Request URL example

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

Request parameters

The following table lists and describes 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 examples

• Basic form
  Imports group data. In this example, the CreateTime parameter can be used to specify the group creation time.

  {
   "Owner_Account": "leckie", // Group owner’s UserId (optional)
   "Type": "Public", // Group type, which can be Private, Public, or ChatRoom (required)
   "Name": "TestGroup", // Group name (required)
   "CreateTime": 1448357837 // Group creation time (optional). If this parameter is not specified, the default creation time is the request time.
  }
  

• Specifying other optional fields
  You can specify optional fields such as Introduction and Notification. The request format is the same as that of a group creation request.

  {
  "Owner_Account": "leckie", // Group owner’s UserId (optional)
  "Type": "Public", // Group type, which can be private, public, or ChatRoom (required)
  "GroupId":"MyFirstGroup", // User-defined group ID for external display (optional)
  "Name": "TestGroup", // Group name (required)
  "Introduction": "This is group Introduction", // Group introduction (optional)
  "Notification": "This is group Notification", // Group announcement (optional)
  "FaceUrl": "http://this.is.face.url",
  "MaxMemberCount": 500, // Maximum number of group members (optional)
  "ApplyJoinOption": "FreeAccess", // Method for handling group requests (optional)
  "CreateTime": 1448357837, // Group creation time (optional). If this parameter is not specified, the default creation time is the request time.
  "AppDefinedData": [ // Custom fields of the group (optional)
      {
          "Key": "GroupTestData1", // Key of the app custom field
          "Value": "xxxxx" // Value of the custom field
      },
      {
          "Key": " GroupTestData2",
          "Value": "abc\u0000\u0001" // Custom field supports binary data
      }
  ]
  }
  

Request packet fields

Response packet examples

• Basic form

  {
   "ActionStatus": "OK",
   "ErrorInfo": "",
   "ErrorCode": 0,
   "GroupId": "@TGS#2J4SZEAEL"
  }
  

• Specifying other optional fields

  {
   "ActionStatus": "OK",
   "ErrorInfo": "",
   "ErrorCode": 0,
   "GroupId": "MyFirstGroup"
  }
  

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.

API Commissioning Tool

Use the online commissioning tool for RESTful APIs to commission this API.

References

• Setting unread message counts for members (v4/group_open_http_svc/set_unread_msg_num)
• Importing a group member v4/group_open_http_svc/import_group_member)
• Dismissing a group (v4/group_open_http_svc/destroy_group)