API List
This document lists the API interfaces, debugging tools, and considerations provided by the IM server.
tip
- The IM Server API is currently in v1, and all interfaces use the POST request method.
- If you are integrating the IM Server API for the first time, it is highly recommended to first understand the API Call Method.
API Default Behavior and Configuration
When integrating the IM Server API, please note the following default behaviors:
- The application server can call the IM Server API to send messages directly. If sending messages to a group or chatroom as a user, it is not required to have joined the group or chatroom.
- If the application has configured sensitive word filtering, message callback services, or third-party moderation, please note that messages sent via the Server API are not filtered by default. If needed, you can enable Server API Message Filtering for Sensitive Words on the [Basic Features] page in the Console.
- If the application has enabled post-messaging callback, please note that messages sent via the Server API are not routed by default. If needed, you can enable Real-time Routing for Server API Messages on the [Basic Features] page in the Console.
- Some interfaces of the Server API are provided for advanced, extended, or paid features of IM. These interfaces can only be used after the corresponding services are activated. You can find most service configuration switches on the [Basic Features] page and the [Chat pricing plans] page in the Console, or you can find specific details in the relevant API documentation.
User Management
tip
One of the main functions of the IM Server API is User Registration. You need to use the App's user ID to exchange for a Token, allowing App users to access the IM service.
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| User Registration | /user/getToken.json | 200/sec |
| Invalidate Token | /user/token/expire.json | 100/sec |
| Get User Information | /user/info.json | 100/sec |
| Modify User Information | /user/refresh.json | 100/sec |
| Deactivate User | /user/deactivate.json | 100 users/sec |
| Query Deactivated Users | /user/deactivate/query.json | 100/sec |
| Reactivate User ID | /user/reactivate.json | 100 users/sec |
| Block User | /user/block.json | 100/sec |
| Unblock User | /user/unblock.json | 100/sec |
| Query Blocked User List | /user/block/query.json | 100/sec |
| User Status | /user/checkOnline.json | 100/sec |
| Set User One-to-One Chat Mute | /user/chat/fb/set.json | 100/sec |
| Query Muted User List for One-to-One Chat | /user/chat/fb/querylist.json | 100/sec |
| Set User Tag | /user/tag/set.json | 100/sec |
| Batch Set User Tags | /user/tag/batch/set.json | 10/sec |
| Get User Tags | /user/tags/get.json | 100/sec |
User Blocklist/Allowlist Service
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| Add User to Blocklist | /user/blacklist/add.json | 100/sec |
| Remove User from Blocklist | /user/blacklist/remove.json | 100/sec |
| Query User Blocklist | /user/blacklist/query.json | 100/sec |
| Enable User Allowlist | /user/whitesetting/set.json | 100/sec |
| Query User Allowlist Service Status | /user/whitesetting/query.json | 100/sec |
| Add User to Allowlist | /user/whitelist/add.json | 100/sec |
| Remove User from Allowlist | /user/whitelist/remove.json | 100/sec |
| Query User Allowlist | /user/whitelist/query.json | 100/sec |
Message Management
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| Send One-to-One Chat Message | /message/private/publish.json | 6000 messages/min, calculated by the number of recipients |
| Send One-to-One Chat Template Message | /message/private/publish_template.json | 6000 messages/min, calculated by the number of recipients |
| Send One-to-One Chat Status Message | /statusmessage/private/publish.json | 6000 messages/min, calculated by the number of recipients |
| Send Group Chat Message | /message/group/publish.json | 20/sec, calculated by the number of target groups |
| Send Group Chat Status Message | /statusmessage/group/publish.json | 20/sec, calculated by the number of target groups |
| Send Chatroom Message | /message/chatroom/publish.json | 100/sec, calculated by the number of target chatrooms |
| Send Chatroom Broadcast Message | /message/chatroom/broadcast.json | 1/sec |
| Set One-to-One and Group Chat Message Extension | /message/expansion/set.json | 100/sec, with a maximum of 20 for group chat message extensions |
| Delete One-to-One and Group Chat Message Extension | /message/expansion/delete.json | 100/sec, with a maximum of 20 for group chat message extensions |
| Get One-to-One and Group Chat Message Extension | /message/expansion/query.json | 100/sec |
| Recall Message | /message/recall.json | 100/sec |
| Get Historical Message Log | /message/history.json | 100/sec |
| Delete Historical Message Log | /message/history/delete.json | 100/sec |
| Clear Messages | /conversation/message/history/clean.json | 100/sec |
Conversation Management
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| Pin Conversation | /conversation/top/set.json | 100/sec |
System Notifications
tip
Items marked as "shared" in the Rate Limit column of the table below use the /push.json interface and share its rate limit, which is 2/hour, 3/day.
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| Send System Notification Message | /message/system/publish.json | 100/sec, calculated by the number of recipients |
| Send System Notification Template Message | /message/system/publish_template.json | 100/sec, calculated by the number of recipients |
| Recall Single System Notification | /message/recall.json | 100/sec |
| Send Broadcast to All Users with Message-bearing Notification | /message/broadcast.json | 2/hour, 3/day |
| Send Broadcast to Online Users | /message/online/broadcast.json | 60/min |
| Send Broadcast to All Users with Push-only Notification | /push.json | 2/hour, 3/day (shared) |
| Send Notification to Tagged Users | /push.json | 2/hour, 3/day (shared) |
| Send Notification by Application Package Name | /push.json | 2/hour, 3/day (shared) |
| Recall Broadcast to All Users with Message-bearing Notification | /message/broadcast/recall.json | 2/hour, 3/day |
| Send Push-only Notification to Specified Users | /push/user.json | 100/sec, calculated by the number of recipients |
Group Management
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| Create Group | /group/create.json | 100/sec |
| Dismiss Group | /group/dismiss.json | 100/sec |
| Join Group | /group/join.json | 100/sec |
| Quit Group | /group/quit.json | 100/sec |
| Query Group Members | /group/user/query.json | 100/sec |
| Sync User's Groups | /group/sync.json | 100/sec |
| Query User's Groups | /user/group/query.json | 100/sec |
| Refresh Group Information | /group/refresh.json | 100/sec |
Group Mute Service
| Function/Document Page | API URL | Rate Limit |
|---|---|---|
| Mute Specified Group Member | /group/user/gag/add.json | 100/sec |
| Unmute Specified Group Member | /group/user/gag/rollback.json | 100/sec |
| Query Muted Group Member List | /group/user/gag/list.json | 100/sec |
| Set Group Mute All | /group/ban/add.json | 100/sec |
| Cancel Group Mute All | /group/ban/rollback.json | 100/sec |
| Query Group Mute All | /group/ban/query.json | 100/sec |
| Add to Group Mute All Allowlist | /group/user/ban/whitelist/add.json | 100/sec |
| Remove from Group Mute All Allowlist | /group/user/ban/whitelist/rollback.json | 100/sec |
| Query Group Mute All Allowlist | /group/user/ban/whitelist/query.json | 100/sec |
Chatroom Management
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Create chatroom | /chatroom/create_new.json | 100/sec |
| Set chatroom Destruction Type | /chatroom/destroy/set.json | 100/sec |
| Destroy chatroom | /chatroom/destroy.json | 100/sec |
| Query chatroom Info | /chatroom/get.json | 100/sec |
| Create chatroom (Deprecated) | /chatroom/create.json | 100/sec |
| Query chatroom Info (Deprecated) | /chatroom/query.json | 100/sec |
Chatroom Keepalive Services
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Keepalive Chatroom | /chatroom/keepalive/add.json | 100/sec |
| Remove Keepalive Chatroom | /chatroom/keepalive/remove.json | 100/sec |
| Query Keepalive Chatrooms | /chatroom/keepalive/query.json | 100/sec |
Chatroom User & Muting Management
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Get Chatroom Members | /chatroom/user/query.json | 100/sec |
| Check If User Is in Chatroom | /chatroom/user/exist.json | 100/sec |
| Batch Check If Users Are in Chatroom | /chatroom/users/exist.json | 100/sec |
| Gag Specified Chatroom User | /chatroom/user/gag/add.json | 100/sec |
| Ungag Specified Chatroom User | /chatroom/user/gag/rollback.json | 100/sec |
| Query Gagged Chatroom Users | /chatroom/user/gag/list.json | 100/sec |
| Set Chatroom Global Gag | /chatroom/ban/add.json | 100/sec |
| Remove Chatroom Global Gag | /chatroom/ban/rollback.json | 100/sec |
| Query Chatroom Global Gag List | /chatroom/ban/query.json | 100/sec |
| Check Chatroom Global Gag Status | /chatroom/ban/check.json | 100/sec |
| Add to Chatroom Global Gag Whitelist | /chatroom/user/ban/whitelist/add.json | 100/sec |
| Remove from Chatroom Global Gag Whitelist | /chatroom/user/ban/whitelist/rollback.json | 100/sec |
| Query Chatroom Global Gag Whitelist | /chatroom/user/ban/whitelist/query.json | 100/sec |
| Globally Gag User | /chatroom/user/ban/add.json | 100/sec |
| Remove Global Gag | /chatroom/user/ban/remove.json | 100/sec |
| Query Globally Gagged Users | /chatroom/user/ban/query.json | 100/sec |
| Block Chatroom User | /chatroom/user/block/add.json | 100/sec |
| Unblock Chatroom User | /chatroom/user/block/rollback.json | 100/sec |
| Query Blocked Chatroom Users | /chatroom/user/block/list.json | 100/sec |
Chatroom Properties (KV)
tip
For entries marked "Shared" in the Rate Limit column:
• The "Set Single Chatroom Property" and "Batch Set Chatroom Properties" APIs share a rate limit of 100 properties/sec.
• The "Delete Single Chatroom Property" and "Batch Delete Chatroom Properties" APIs share a rate limit of 100 properties/sec.
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Set Chatroom Property (KV) | /chatroom/entry/set.json | 100 properties/sec (Shared) |
| Batch Set Chatroom Properties (KV) | /chatroom/entry/batch/set.json | 100 properties/sec (Shared) |
| Delete Chatroom Property (KV) | /chatroom/entry/remove.json | 100 properties/sec (Shared) |
| Batch Delete Chatroom Properties (KV) | /chatroom/entry/batch/remove.json | 100 properties/sec (Shared) |
| Query Chatroom Property (KV) | /chatroom/entry/query.json | 100/sec |
Chatroom Message Priority Services
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Add Low-Priority Message Type | /chatroom/message/priority/add.json | 100/sec |
| Remove Low-Priority Message Type | /chatroom/message/priority/remove.json | 100/sec |
| Query Low-Priority Message Types | /chatroom/message/priority/query.json | 100/sec |
Chatroom Whitelist Services
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Add User to Chatroom Whitelist | /chatroom/user/whitelist/add.json | 100/sec |
| Remove User from Chatroom Whitelist | /chatroom/user/whitelist/remove.json | 100/sec |
| Query Chatroom User Whitelist | /chatroom/user/whitelist/query.json | 100/sec |
| Add Message to Chatroom Whitelist | /chatroom/whitelist/add.json | 100/sec |
| Remove Message from Chatroom Whitelist | /chatroom/whitelist/delete.json | 100/sec |
| Query Chatroom Message Whitelist | /chatroom/whitelist/query.json | 100/sec |
Content Moderation
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Add Sensitive Word | /sensitiveword/add.json | 100/sec |
| Batch Add Sensitive Words | /sensitiveword/batch/add.json | 100/sec |
| Remove Sensitive Word | /sensitiveword/delete.json | 100/sec |
| Batch Remove Sensitive Words | /sensitiveword/batch/delete.json | 100/sec |
| Query Sensitive Words | /sensitiveword/list.json | 100/sec |
Push & Notification Management
| Feature/Document Page | API URL | Rate Limit |
|---|---|---|
| Set Do Not Disturb for Specified Conversation | /conversation/notification/set.json | 100/sec |
| Query Do Not Disturb for Specified Conversation | /conversation/notification/get.json | 100/sec |
| Set Do Not Disturb for Specified Conversation Type | /conversation/type/notification/set.json | 100/sec |
| Query Do Not Disturb for Specified Conversation Type | /conversation/type/notification/get.json | 100/sec |
| Set User Do Not Disturb Period | /user/blockPushPeriod/set.json | 100/sec |
| Delete User Do Not Disturb Period | /user/blockPushPeriod/delete.json | 100/sec |
| Query User Do Not Disturb Period | /user/blockPushPeriod/get.json | 100/sec |
| Set User-Level Push Alias | /user/remarks/set.json | 100/sec |
| Delete User-Level Push Alias | /user/remarks/del.json | 100/sec |
| Query User-Level Push Alias | /user/remarks/get.json | 100/sec |
| Set Group Member Push Alias | /group/remarks/set.json | 100/sec |
| Delete Group Member Push Alias | /group/remarks/del.json | 100/sec |
| Query Group Member Push Alias | /group/remarks/get.json | 100/sec |