tencent cloud

Chat

News and Announcements
Release Notes
Announcements
Product Introduction
Overview
Basic Concepts
Scenarios
Features
Account System
User Profile and Relationship Chain
Message Management
Group Related
Official Account
Audio/Video Call
Use Limits
Purchase Guide
Billing Overview
Pricing
Purchase Instructions
Renewal Guide
Service Suspension Explanation
Refund Policy
Development Guidelines
Demo Zone
Activate Service
Free Demos
Quick Run
Download
SDK and Demo Source Code
Update Log
Chat Interaction (UI Included)
TUIKit Introduction
Getting Started
Full-feature Integration
Single-function Integration
Build with AI
Build Basic Interfaces
More Features
Customizing Appearance
Internationalization
Push Service
Overview
Noun explanation
Activate the Service
Quick Start
Manufacturer Channel
Statistics
Troubleshooting Tool
Client APIs
REST API
Push Callback
Advanced Features
Release Notes
Error Codes
FAQS
Desk
Overview
Quick Start
Integration Guide
Admin Operation Manual
Agent Manual
More Practices
Live Streaming Setup Guide
AI Chatbot
Super Large Entertainment and Collaboration Community
Discord Implementation Guide
How to Integrate Chat into Games
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
No UI Integration
Quick Start
SDK Integration
Initialization
Login and Logout
Message
Conversation
Group
Community Topic
User Profile and Relationship Chain
Offline Push
Cloud Search
Local Search
Official Channel Management
Client APIs
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
Server APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
Console Guide
New Console Introduction
Creating and Upgrading an Application
Basic Configuration
Feature Configuration
Account Management
Group Management
Official Channel Management
Webhook Configuration
Usage
Viewing Guide for Resource Packages
Real-Time Monitor
Auxiliary Development Tools
Access Management
Advanced Features
FAQs
uni-app FAQs
Purchase
SDK
Account Authentication
User Profile and Relationship Chain
Message
Group
Audio-Video Group
Nickname and Profile Photo
Security Compliance Certification
Service Level Agreement
Security Compliance Certification
Chat Policies
Privacy Policy
Data Privacy and Security Agreement
Migration
Migration Solutions
Migration Solutions Lite
Error Codes
Contact Us
DocumentationChatClient APIsiOS & macOS

iOS & macOS

PDF
Focus Mode
Font Size
Last updated: 2025-01-23 16:13:12
Note:
Do not use APIs of new and old versions at the same time.

Initialization and Login APIs

To use the Tencent Cloud Chat service, you need to initialize the SDK and log in.
API
Description
Initializes the SDK.
Uninitializes the SDK
Adds the Chat listener.
Removes the Chat listener.
Gets the version number.
Gets the server time.
Logs in.
Logs a user out
Gets the currently logged-in user.
Gets the login status

Simple Message APIs

Use the following APIs for the sending and receiving of text and signaling (custom buffer) messages.
API
Description
Sets an event listener for simple messages (text messages and custom messages).Do not use this API and addAdvancedMsgListener at the same time.
Removes the event listener for simple messages (text messages and custom messages)
Sends a one-to-one chat (C2C) text message
Sends a one-to-one chat (C2C) custom (signaling) message
Sends a group chat text message
Sends a group chat custom (signaling) message

Signaling APIs

API
Description
Adds a signaling listener.
Removes a signaling listener.
Invites a user.
Invites certain users in a group.
Cancels an invitation.
Accepts an invitation.
Rejects an invitation.
Gets the signaling information.
Adds invitation signaling (can be used for invitation signaling triggered by offline push messages for group invitations).
Modifies the invitation signaling.

Advanced Message APIs

If you need to send/receive rich media messages (such as image, video, and file messages) and use advanced features such as recalling messages, marking messages as read, and querying message history, use the following set of advanced message APIs. Do not use simple message APIs and advanced message APIs at the same time.
API
Description
Sets an event listener for advanced messages. Do not use this API and addSimpleMsgListener at the same time.
Removes the listener for advanced messages
Creates a text message
Creates an @ text message.
Creates a custom message
Creates an image message
Creates a voice message.
Creates a video message
Creates a file message.
Creates a location message
Creates an emoji message
Creates a combined forward message.
Creates a single forward message.
Creates a targeted group message.
Creates a group @ message.
Sends a message. The message object can be created using a createXXXMessage API.
Sets the Mute Notifications option for one-to-one messages.
Gets the Mute Notifications status for one-to-one messages.
Sets the Mute Notifications option for group messages.
Gets the one-to-one chat (C2C) message history
Gets the group chat message history
Gets the message history.
Recalls a message. The message object can be created using a createXXXMessage API.
Modifies a message.
Marks one-to-one chat (C2C) messages as read
Marks group messages as read
Marks all conversations as read.
Deletes a message from the local storage
Deletes messages from local storage and the cloud.
Clears chat history with a user from local storage and the cloud.
Clears chat history of a group from local storage and the cloud.
Inserts a message in a group chat.
Inserts a message in a one-to-one chat.
Finds local messages by msgID.
Search for local messages.
Search for cloud messages.
Sends message read receipts.
Gets message read receipts.
Gets the list of group members who have read group messages.
Sets message extensions.
Gets message extensions.
Deletes message extensions.
Adds message reaction.
Removes message reaction.
Gets message reactions.
Gets all user list of message reaction.
Translates a text message.
Sets group message pinning.
Gets pinned group message list.

Group APIs

Tencent Cloud Chat SDK supports five preset group types, each of which pertains to different scenarios.
Work group (Work): users can join the group only after being invited by group members. This group type is the same as private group (Private) in earlier versions.
Public group (Public): Users can join a public group through requests, which need to be approved by the group owner or group admin.
Meeting group (Meeting): used together with TRTC to enable scenarios such as video conferencing and online education. Users can join and leave the group freely and view the message history before they join. Same as chat room (ChatRoom) in earlier versions.
Community: A user can join and leave a community freely. It is suitable for chat scenarios with a super large number of community members, such as knowledge sharing and game discussion. This feature is supported by a client with the SDK enhanced edition v5.8.1668 or later and the web SDK v2.17.0 or later. To use it, you need to purchase the Pro edition 、Pro Plus edition、Enterprise edition, and then enable it in Console, path: Applications > Your App > Chat > Configuration > Group Configuration > Community.
Audio-video group (AVChatRoom): An audio-video group allows users to join and leave freely and is suitable for scenarios such as live streaming and chat rooms with on-screen comments. There is no limit on the number of group members.
API
Description
Sets an event listener for groups. (This API is to be disused. Please use the addGroupListener and removeGroupListener APIs.)
Adds an event listener for groups.
Removes an event listener for groups.
(Simple API) Creates a group.
(Advanced API) Creates a group. The group information and the initial group members can be set during group creation.
Joins a group
Leaves a group.
Disbands a group. Only the group owner and group admin can disband a group.
Gets the list of groups the current user has joined, excluding audio-video groups.
Pulls the profiles of groups
Search for local group profiles
Search for cloud group profiles
Modifies the profile of a group
Initializes group attributes.
Sets group attributes.
Deletes group attributes.
Gets group attributes.
Gets the number of online group members.
Gets the group member list
Gets the profiles of specified group members
Search for local group members
Search for cloud group members
Modifies the profile of a specified group member
Mutes a group member.
Invites users to a group
Removes a member from a group.
Sets a role for a group member.
Marks group members.
Transfers the ownership of a group
Gets the list of applications to join a group
Accepts an application to join a group
Rejects a request to join a group.
Marks the application list as read
Gets the list of community groups the current user has joined.
Creates a topic.
Deletes a topic.
Modifies topic information.
Gets the message list.

Conversation List APIs

The conversation list is the list a user sees on the first screen after login. It includes elements such as conversation node, conversation name, group name, last message, and unread count.
API
Description
Sets a conversation listener. (This API is to be disused. Please use the addConversationListener and removeConversationListener APIs.)
Adds a conversation listener.
Removes a conversation listener.
Gets the conversation list
Gets a specified conversation.
Gets multiple conversations.
Gets the advanced conversation API to specify the conversation type, mark type, and group name.
Deletes a conversation
Sets a draft for a conversation
Sets custom conversation data.
Pins a conversation to the top.
Marks a conversation.
Gets the total unread message count.
Creates a conversation group.
Gets the list of conversation groups.
Deletes a conversation group.
Renames a conversation group.
Adds a conversation to a conversation group.
Deletes a conversation from a conversation group.

User Profile APIs

You can use the following APIs to query user profiles, modify your profile, and block messages from a specified user (that is, adding a specified user to the blocklist).
API
Description
Gets users’ profiles
Modifies one’s own user profile
Queries a user's status.
Sets one's own status.
Subscribes to a user's status.
Unsubscribes from a user's status.
Search cloud users
Blocks messages from a specified user, which means adding the user to the blocklist.
Unblocks messages from a specified user, which means removing the user from the blocklist.
Gets the blocklist

Offline Push APIs

Use the offline push service if you want your app to receive Chat service messages in real time when it is in the background.
API
Description
Sets an APNs listener.
Configures APNs Push info.
Configures VoIP Push info.

Friend Management APIs

Tencent Cloud Chat SDK does not check friend relationships by default when sending and receiving messages. To achieve the interactive experience of "add friends first, then send messages", you can log in to the Console to modify Relationship Check. When enabled, users can only send messages to their friends. When a user sends a message to a non-friend, SDK will report a 20009 error code. The configuration path is: Applications > Your App > Chat > Configuration > Login and Message > Relationship Check.
Use the following API to add or delete friends and manage friend lists.
API
Description
Sets a contacts and friend profile listener. (This API is to be disused. Please use the addFriendListener and removeFriendListener APIs.)
Adds a contacts listener.
Removes a contacts listener.
Gets the contacts.
Gets the profiles of specified friends
Sets the profile of a specified friend
Searches for friends.
Adds a friend
Deletes a friend
Checks relationship with specified users.
Gets the list of friend requests
Accepts a friend request
Rejects a friend request
Deletes a friend request
Marks a friend request as read.
Creates a friend list
Gets the information of friend lists
Deletes friend lists
Modifies the name of a friend list
Adds friends to a friend list
Removes friends from a friend list.

Previous Topic: AndroidNext Topic: Swift

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback