Server APIs

Generating UserSig
RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
  - Send Message
    - Sending One-to-One Messages to One User
    - Sending One-to-One Messages to Multiple Users
    - Sending Ordinary Messages in a Group
    - Sending System Messages in a Group
    - Broadcast Message of Audio-Video Group
    - Importing One-to-One Messages
    - Importing Group Messages
  - Historical Message
    - Modifying Historical One-to-one Messages
    - Modifying Historical Group Messages
    - Pulling Historical One-to-one Messages
    - Pulling Historical Group Messages
  - Delete Message
    - Deleting Messages Sent by a Specified User
  - Withdraw Message
    - Recalling One-to-One Messages
    - Recalling Group Messages
  - Read Receipt
    - Marking One-to-One Messages as Read
    - Pulling Group Message Read Receipt Details
    - Pulling Read Receipts for Group Messages
  - Message Extension
    - Pulling the Message Extension of a One-to-One Message
    - Configuring Message Extension for a One-to-One Message
    - Pulling Message Extension of a Group Message
    - Configuring Message Extension for a Group Message
  - Pushing to All Users
    - API for Pushing to All Users
    - Pushing to All Users
    - Setting Application Attribute Names
    - Getting Application Attribute Names
    - Getting User Attributes
    - Setting User Attributes
    - Deleting User Attributes
    - Getting User Tags
    - Adding User Tags
    - Deleting User Tags
    - Deleting All Tags of a User
- Session Related
  - Conversation List
    - Pulling a conversation list
  - Session Unread Count
    - Setting the Unread Message Count of a Member
    - Querying Unread One-to-One Message Count
  - Delete Session
    - Deleting a conversation
  - Session Grouping Tag
    - Creating Conversation Group Data
    - Updating Conversation Group Data
    - Deleting Conversation Group Data
    - Creating or Updating Conversation Mark Data
    - Searching for Conversation Group Marks
    - Pulling Conversation Group Mark Data
- Group Related
  - Group Management
    - Getting All Groups in an App
    - Creating a Group
    - Disbanding a Group
    - Getting the Groups a User Has Joined
  - Group Information
    - Getting Group Profiles
    - Modifying the Profile of a Group
    - Importing a Group Profile
  - Group Member Management
    - Adding Group Members
    - Deleting Group Members
    - Banning Group Members
    - Unbanning Group Members
    - Bulk Muting and Unmuting
    - Getting the List of Muted Group Members
    - Changing Group Owner
    - Querying the Roles of Users in a Group
    - Importing Group Members
  - Group Member Information
    - Getting Group Member Profiles
    - Modifying the Profile of a Group Member
  - Group Custom Attributes
    - Getting Group Custom Attributes
    - Modifying Group Custom Attributes
    - Clearing Group Custom Attributes
    - Resetting Group Custom Attributes
    - Deleting Group Custom Attributes
  - Live Group Management
    - Getting the Number of Online Users in an Audio-Video Group
    - Getting the List of Online Members in Audio-Video Group
    - Setting Audio-Video Group Member Marks
    - Getting the List of Banned Group Members.
  - Community Management
    - Creating Topic
    - Deleting Topic
    - Getting Topic Profile
    - Modifying Topic Profile
    - Importing Topic Profiles
  - Group Counter
    - Getting Group Counters
    - Updating Group Counters
    - Deleting Group Counters
- User Management
  - Account Management
    - Importing a Single Account
    - Importing Multiple Accounts
    - Deleting Accounts
    - Querying Accounts
  - User Information
    - Setting Profiles
    - Pulling Profiles
  - User Status
    - Invalidating Account Login States
    - Querying Account Online Status
  - Friend Management
    - Adding Friends
    - Importing Friends
    - Updating Friends
    - Deleting Friends
    - Deleting All Friends
    - Verifying Friends
    - Pulling Friends
    - Pulling Specified Friends
  - Friend Lists
    - Adding Lists
    - Deleting Lists
    - Pulling Lists
  - Blocklist
    - Blocklisting Users
    - Unblocklisting Users
    - Pulling a Blacklist
    - Verifying Users on a Blocklist
- Global Mute Management
  - Setting Global Mute
  - Querying Global Mute
- Operations Management
  - Pulling Operations Data
  - Downloading Recent Messages
  - Getting Server IP Addresses
- Chatbots
  - Pulling Chatbot Accounts
  - Creating Chatbot Accounts
  - Deleting Chatbot Accounts
Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
  - API Overclocking Alarm Callbacks
- Online Status Webhooks
  - Status Change Webhooks
- Relationship Chain Webhooks
  - After a Profile Is Updated
  - Before a Friend Is Added
  - Before a Friend Request Is Responded
  - After a Friend Is Added
  - After a Friend Is Deleted
  - After a User Is Added to Blocklist
  - After a User Is Removed from Blocklist
- One-to-One Message Webhooks
  - Before a One-to-One Message Is Sent
  - After a One-to-One Message Is Sent
  - After a One-to-One message Is Marked as Read
  - After A One-to-One Message Is Recalled
- Group Webhooks
  - Before a Group Is Created
  - After a Group Is Created
  - Before Applying to Join a Group
  - Before Inviting a User to a Group
  - After a User Joins a Group
  - After a User Leaves a Group
  - Before Group Message Is Sent
  - After a Group Message Is Sent
  - After a Group Is Full
  - After a Group Is Disbanded
  - After Group Profile Is Modified
  - Callback After Recalling Group Messages
  - Webhook for Online and Offline Status of Audio-Video Group Members
  - Webhook for Exceptions When Group Messages Are Sent
  - Before a Topic Is Created
  - After a Topic Is Created
  - After a Topic Is Deleted
  - Topic Profile Change Webhook
  - Callback After Group Member Profile Changed
  - Callback After Group Attribute Changed
  - Callback After Read Receipt
  - Callback After the Group Owner Changed
- Webhook Mutual Authentication Configuration Guide
  - Apache Mutual Authentication Configuration
  - Nginx Mutual Authentication Configuration
- Chatbot webhooks
  - Chatbot Passthrough Message Callback

Importing a Group Profile

Feature Overview
This API allows the app admin to import group data without triggering callbacks or delivering notifications. When your app needs to be migrated to Chat from another instant messaging system, you can use this API to import existing group data.
API Calling Description
Applicable group types
Group Type
Support for This RESTful API
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
Above are the built-in group types of the Chat service. For more information, see Group System.
Note
AVChatRoom groups do not support importing basic group data. If you attempt to import basic group data for AVChatRoom groups, error 10007 is returned. To achieve the effect of importing basic group data, you can create a group and modify basic group data.
Sample request URL
https://xxxxxx/v4/group_open_http_svc/import_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
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
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format. The value is fixed to json.
Maximum call frequency
200 calls per second
Sample request
Basic format
Import a group. You can use CreateTime to specify the group creation time.
{
  "Owner_Account": "leckie", // User ID of the group owner (optional)
  "Type": "Public", // Group type: Private, Public, ChatRoom, or Community (required)
  "Name": "TestGroup", // Group name (required)
  "CreateTime": 1448357837 // Group creation time (optional). If this field is not specified, the default creation time is the request time.
}
Containing only the topic-enabled parameter format
Import a group and specify its type as a topic-enabled community group.
{
  "Type": "Community", // Group type (required)
  "Name": "test_import_group",  // Group name (required)
  "SupportTopic": 1// Whether the topic option is supported. Valid values: `1`: yes; `0`: no.
}
Specifying other optional fields
You can specify optional fields such as Introduction and Notice. The request format is the same as that of a group creation request.
{
  "Owner_Account": "leckie", // User ID of the group owner (optional)
  "Type": "Public", // Group type: Private, Public, ChatRoom, or Community (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 notice (optional)
  "FaceUrl": "http://this.is.face.url",
  "MaxMemberCount": 500, // Maximum number of group members (optional)
  "ApplyJoinOption": "FreeAccess", // Method for handling requests to join the group (optional)
  "CreateTime": 1448357837, // Group creation time (optional). If this field is not specified, the default creation time is the request time.
  "AppDefinedData": [ // Group custom field (optional)
      {
          "Key": "GroupTestData1", // Key of the app custom field
          "Value": "xxxxx" // Value of the custom field
      },
      {
          "Key": " GroupTestData2",
          "Value": "abc\u0000\u0001" // The custom field supports binary data.
      }
  ]
}
Request fields
Field
Type
Required
Description
Owner_Account
String
Optional
Group owner ID, which will be automatically added to group members. If this field is not specified, the group will have no group owner.
Type
String
Required
Group type, which can be Public, Private (Work), ChatRoom, or Community.
GroupId
String
Optional
To simplify group IDs and make them easy to remember, Tencent Cloud allows apps to customize group IDs during group creation through RESTful APIs. For details, see Group Systems.
Name
String
Required
Group name, whose maximum length is 30 bytes.
Introduction
String
Optional
Group introduction, whose maximum length is 240 bytes.
Notification
String
Optional
Group notice, whose maximum length is 300 bytes.
FaceUrl
String
Optional
URL of the group profile photo, whose maximum length is 100 bytes.
MaxMemberCount
Integer
Optional
Maximum number of group members, which is 6,000 at the maximum. The default value is 2,000. Currently, a community group supports up to 100,000 group members.
ApplyJoinOption
String
Optional
Method for handling requests to join the group. Valid values: FreeAccess, NeedPermission (default), and DisableApply. This field is not supported by community groups.
AppDefinedData
Array
Optional
Group custom field. By default, this field is unavailable and needs to be enabled before use. For details, see Group Systems.
CreateTime
Integer
Optional
Group creation time
SupportTopic
Integer
No
Whether the topic option is supported. This field is valid only for communities.
Sample response
Basic format
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "GroupId": "@TGS#2J4SZEAEL"
}
Containing only the topic-enabled parameter format
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "GroupId": "@TGS#_@TGS#c4YHCIIM62CX"
}
Specifying other optional fields
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "GroupId": "MyFirstGroup"
}
Response fields
Field
Type
Description
ActionStatus
String
Request result. OK: successful; FAIL: failed
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information
GroupId
String
Group ID after successful creation, which is assigned by the Chat backend or specified by users.
Error Codes
The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields 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.
10007
No operation permissions. This error occurs when, for example, a member in a public group tries to remove other users from the group (only the app admin can perform this operation).
10021
The group ID is already in use. Specify another group ID.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
Setting the unread message count of a member (v4/group_open_http_svc/set_unread_msg_num)
Importing group members (v4/group_open_http_svc/import_group_member)
Disbanding a group (v4/group_open_http_svc/destroy_group)

Feature Overview
API Calling Description
Error Codes
API Debugging Tool
References

Group Type	Support for This RESTful API
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

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	Request API
sdkappid	SDKAppID assigned by the Chat console when an app is created
identifier	App admin account. For more information, see the App Admin section in Login Authentication.
usersig	Signature generated by the app admin account. For details, see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Request format. The value is fixed to `json`.

Field	Type	Required	Description
Owner_Account	String	Optional	Group owner ID, which will be automatically added to group members. If this field is not specified, the group will have no group owner.
Type	String	Required	Group type, which can be Public, Private (Work), ChatRoom, or Community.
GroupId	String	Optional	To simplify group IDs and make them easy to remember, Tencent Cloud allows apps to customize group IDs during group creation through RESTful APIs. For details, see Group Systems.
Name	String	Required	Group name, whose maximum length is 30 bytes.
Introduction	String	Optional	Group introduction, whose maximum length is 240 bytes.
Notification	String	Optional	Group notice, whose maximum length is 300 bytes.
FaceUrl	String	Optional	URL of the group profile photo, whose maximum length is 100 bytes.
MaxMemberCount	Integer	Optional	Maximum number of group members, which is 6,000 at the maximum. The default value is 2,000. Currently, a community group supports up to 100,000 group members.
ApplyJoinOption	String	Optional	Method for handling requests to join the group. Valid values: `FreeAccess`, `NeedPermission` (default), and `DisableApply`. This field is not supported by community groups.
AppDefinedData	Array	Optional	Group custom field. By default, this field is unavailable and needs to be enabled before use. For details, see Group Systems.
CreateTime	Integer	Optional	Group creation time
SupportTopic	Integer	No	Whether the topic option is supported. This field is valid only for communities.

Error Code	Description
10002	Internal server error. Try again.
10003	Invalid command word.
10004	Invalid parameter. Check the error description and troubleshoot the issue.
10007	No operation permissions. This error occurs when, for example, a member in a public group tries to remove other users from the group (only the app admin can perform this operation).
10021	The group ID is already in use. Specify another group ID.