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

Webhook for Online and Offline Status of Audio-Video Group Members

Feature Overview
This webhook allows you to view the online and offline status (such as record logs) of an audio-video group in real time or synchronize the information to other systems on the app backend. 
Reminders
To use this webhook, you need to purchase the Premium edition and enable the List of online audio-video group members feature on the Group feature configuration page in the console. After the feature is enabled in the console, the list of the latest 1,000 online members of an audio-video group will be stored and the list can be pulled on clients. If the feature is disabled in the console, the list cannot be pulled on clients, and only the list of the 30 latest group members can be pulled.
To enable this webhook, you must configure a webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Webhook Configuration.
During this webhook event, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, see the Security Considerations section in Webhook Overview.
Webhook Triggering Scenarios
App users abnormally exit after entering the audio-video group, and the network is disconnected for over 20 seconds.
App users abnormally exit after entering the audio-video group and go online after the network is disconnected for over 20 seconds.
App users first join the audio-video group. When a user joins the same audio-video group from multiple App terminals, the callback is triggered only once.
App user's last active exit from the audio-video group. When a user has multiple App terminals in the audio-video group, the callback is triggered when the last terminal exits.
Webhook Triggering Timing
After a user enters the audio-video group, the Offline event is triggered due to heartbeat timeout caused by network disconnection, and the Online event is triggered when the user goes online 20s after the timeout. If the user logs in with multiple devices and joins the same audio-video group concurrently, the Offline event will be triggered when all the devices go offline concurrently. The Online event will be triggered when any device goes back online (only one Online event will be triggered even if multiple devices go back online).
API Calling Description
Sample request URL
In the following sample, the webhook URL configured in the app is https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json
Request parameters
Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Callback URL
SdkAppid
The SDKAppID assigned by the Chat console when the app is created
CallbackCommand
Fixed value: Group.CallbackOnMemberStateChange.
contenttype
Fixed value: JSON.
Sample request
{
    "CallbackCommand": "Group.CallbackOnMemberStateChange", // Webhook command
    "GroupId": "@TGS#2J4SZEAEL", // Group ID
    "EventType": "Offline", // Event type: Offline (disconnected); Online (reconnected)
    //Event Cause: HeartbeatInterrupt (Heartbeat Interruption), HeartbeatRecover (Heartbeat Recovery), Join (First Entry into Group), Quit (Last Exit from Group)
    "MemberList": [ // List of members who left the group
        {
            "Member_Account": "jared"
        },
        {
            "Member_Account": "tommy"
        }
    ]
}
Request fields
Field
Type
Description
CallbackCommand
String
Webhook command
GroupId
String
ID of the group that generates group messages
EventType
String
Event type: Offline (disconnected); Online (reconnected)
EventCause
String
Event cause: HeartbeatInterrupt (heartbeat interruption), HeartbeatRecover (heartbeat recovery), Join (first entry into group), Quit (last exit from group)
MemberList
Array
List of members triggering the event
Sample response
A response is returned after the app backend synchronizes the data.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // The value `0` indicates that the response result is ignored.
}
Response fields
Field
Type
Required
Description
ActionStatus
String
Yes
Request result. OK: Successful; FAIL: Failed
ErrorCode
Integer
Yes
Error code. The value 0 indicates that the response result is ignored.
ErrorInfo
String
Yes
Error information
References
Webhook Overview
After a User Joins a Group
After a User Leaves a Group

Feature Overview
Reminders
Webhook Triggering Scenarios
Webhook Triggering Timing
API Calling Description
References

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST.
www.example.com	Callback URL
SdkAppid	The `SDKAppID` assigned by the Chat console when the app is created
CallbackCommand	Fixed value: `Group.CallbackOnMemberStateChange`.
contenttype	Fixed value: `JSON`.

Field	Type	Description
CallbackCommand	String	Webhook command
GroupId	String	ID of the group that generates group messages
EventType	String	Event type: Offline (disconnected); Online (reconnected)
EventCause	String	Event cause: HeartbeatInterrupt (heartbeat interruption), HeartbeatRecover (heartbeat recovery), Join (first entry into group), Quit (last exit from group)
MemberList	Array	List of members triggering the event

Field	Type	Required	Description
ActionStatus	String	Yes	Request result. `OK`: Successful; `FAIL`: Failed
ErrorCode	Integer	Yes	Error code. The value `0` indicates that the response result is ignored.
ErrorInfo	String	Yes	Error information