UIKit

Overview
- Product Introduction
- Features Overview
- Pricing
  - Billing Overview
  - Chat Monthly Package
  - Billing of Chat Out-of-Package Usage
Getting Started
- Run Demo
- Integration
  - React
  - Vue
- Secure authentication with UserSig
Features
- Calls integration to chat
- Reactions
- Read Receipt
- Typing Status
- User Online Status
- Message Search
- Quote Reply
- Translate Message
UI Components
- Conversation List
  - ConversationList
  - ConversationListContext
  - ConversationPreview
  - ConversationSearch
  - ConversationActions
Themes
- React
- Vue
  - Web
  - Mobile
Customization
- Customize Messages
- Customize Emoji and Stickers
Localization
- React
- Vue

Console Guide
- New Console Introduction
- Creating and Upgrading an Application
- Basic Configuration
- Feature Configuration
- Account Management
- Group Management
- Webhook Configuration
- Usage Statistics
- Real-Time Monitor
- Auxiliary Development Tools
Product Features
- Message Management
  - One-to-One Message
  - Message Storage
  - Offline Push
  - Group Message
  - Message Formats
- Account System
  - Login Authentication
  - Online Status Management
- Group Related
  - Group System
  - Group Management
- User Profile and Relationship Chain
  - Profile Management
  - Relationship Chain Management
Scenario-based Practice
- Live Streaming Room Construction
- How to Integrate Chat into Games
- AI Chatbot
- Super Large Entertainment and Collaboration Community
- Discord Implementation Guide
Push Service
- Overview
- Activate the Service
- Quick Start
- Manufacturer Channel
  - Manufacturer Configuration
    - Android
    - iOS
    - Flutter
    - React-Native
  - Quick Integration
    - Android
    - iOS
    - Flutter
    - React-Native
- Statistics
- Troubleshooting Tool
- Client APIs
  - Android
  - iOS
  - Flutter
  - React Native
- REST API
  - Pushing to All/Tagged Users
  - UserID-Targeted Push
  - Obtaining Application Attribute Names
  - Setting Application Attribute Names
  - Obtaining User Attributes
  - Setting User Attributes
  - Deleting User Attributes
  - Obtaining User Tags
  - Adding User Tags
  - Deleting User Tags
  - Deleting All User Tags
  - Recalling Push
- Push Callback
  - All Users / Tags / UserID Push Callback
  - Other Push Callbacks
- Advanced Features
  - Custom Definition Badge
  - Custom Definition Ringtone
  - Customized Icon
  - Custom Definition Click Redirect
  - Push Message Categorization
- Release Notes
  - Android
  - iOS
  - Flutter
  - React Native
- FAQS
Error Codes

Obtaining User Tags

Feature Overview
Retrieve User Tags (must be called with an admin account). You can only retrieve tags for a maximum of 100 users at a time.
Sample request URL
https://xxxxxx/v4/timpush/get_tag?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
Parameter
Description
https
The request protocol is: HTTPS
Request method: POST
xxxxxx
The dedicated domain corresponding to the country/region of your SDKAppID.
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
v4/timpush/get_tag
Request API
usersig
The Signature generated by the App admin account. For details, see Generating UserSig﻿
identifier
You must be an App admin account. For more details, see App Admins﻿
sdkappid
SdkAppid assigned by the Instant Messaging Console when an application is created
random
32-bit unsigned integer random number
contenttype
Fixed value: json
Call frequency limit
100 times per second.
Sample request packets
{
    "To_Account": [
        "xiaoming",
        "xiaohong"
    ]
}
Request packet fields
Field
Type
Attribute
Description
To_Account
Array
Required
Target User Account List
Sample response packets
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "UserTags": [
        {
            "To_Account": "xiaoming",
            "Tags": ["GoldMember", "WeekPassUser"]
        },
        {
            "To_Account": "xiaohong",
            "Tags": ["PlatinumMember", "MonthPassUser"]
        }
    ]
}
Response packet field description
Field
Type
Description
ActionStatus
String
Processed Request Result:
OK: Indicates successful processing
FAIL: Indicates failure
ErrorCode
Integer
Error code
ErrorInfo
String
Error message
UserTags
Array
User Tag Content List
To_Account
String
User Account
Tags
Array
Tag array: Each Tag must be a string type and the maximum length of a single Tag should not exceed 50 bytes
Error codes
Unless a network error occurs (e.g., 502 error), the HTTP return code of this interface is always 200.The actual error code and error message are indicated by ErrorCode and ErrorInfo in the response payload.. For public error codes (60000 to 79999), refer to the Error Codes documentation.
The private error codes for this API are as follows:
Error code
Description
90001
Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
90009
The request requires App Administrator permissions.
90018
The number of requested accounts exceeds the limit.
91000
Internal service error, please try again.
API Debugging Tool
Use the RESTful API Online Test tool to debug this interface.
Reference
﻿All-user/Tag Push﻿
﻿Single push with userID﻿
﻿Obtaining Application Attribute Names﻿
﻿Setting Application Attribute Names﻿
﻿Getting User Attributes﻿
﻿Setting User Attributes﻿
﻿Deleting User Attributes﻿
﻿Getting User Tags﻿
﻿Adding User Tags﻿
﻿Deleting User Tags﻿
﻿Clearing User Tags﻿
﻿Recall Push﻿
﻿

Feature Overview
Error codes
API Debugging Tool
Reference

Parameter	Description
https	The request protocol is: HTTPS Request method: POST
xxxxxx	The dedicated domain corresponding to the country/region of your SDKAppID. 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`
v4/timpush/get_tag	Request API
usersig	The Signature generated by the App admin account. For details, see Generating UserSig
identifier	You must be an App admin account. For more details, see App Admins
sdkappid	SdkAppid assigned by the Instant Messaging Console when an application is created
random	32-bit unsigned integer random number
contenttype	Fixed value: json

Field	Type	Attribute	Description
To_Account	Array	Required	Target User Account List

Error code	Description
90001	Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
90009	The request requires App Administrator permissions.
90018	The number of requested accounts exceeds the limit.
91000	Internal service error, please try again.

Obtaining User Tags

Feature Overview

Sample request URL

Request parameters

Call frequency limit

Sample request packets

Request packet fields

Sample response packets

Response packet field description

Error codes

API Debugging Tool

Reference

Ask the community

Get support in group