- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- Release Notes
- Product Introduction
- Purchase Guide
- Download
- Get Started
- Quick Integration Solution (Including UI Library) (Recommended)
- Self-implementing Integration Solution
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Recent Contacts
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Deleting Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Getting Custom Group Attributes
- Modifying Custom Group Attributes
- Clearing Custom Group Attributes
- Resetting Custom Group Attributes
- Global Mute Management
- Operations Management
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callbacks After Recalling Group Messages
- Callback Mutual Authentication Configuration Guide
- Use Cases
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
Account Management
| Feature | API |
|---|---|
| Imports a single account. | v4/im_open_login_svc/account_import |
| Imports multiple accounts. | v4/im_open_login_svc/multiaccount_import |
| Deletes accounts. | v4/im_open_login_svc/account_delete |
| Queries accounts. | v4/im_open_login_svc/account_check |
| Invalidates the login state of an account. | v4/im_open_login_svc/kick |
| Queries the login status of an account. | v4/openim/query_online_status |
One-to-One Message
| Feature | API |
|---|---|
| Sends one-to-one messages to one user. | v4/openim/sendmsg |
| Sends one-to-one messages to multiple users. | v4/openim/batchsendmsg |
| Imports one-to-one messages. | v4/openim/importmsg |
| Queries one-to-one messages. | v4/openim/admin_getroammsg |
| Recalls one-to-one messages. | v4/openim/admin_msgwithdraw |
| Marks one-to-one messages as read. | v4/openim/admin_set_msg_read |
| Queries the unread one-to-one message counts. | v4/openim/get_c2c_unread_msg_num |
Pushing to All Users
| Feature | API |
|---|---|
| Pushes to all users. | v4/all_member_push/im_push |
| Sets app attribute names. | v4/all_member_push/im_set_attr_name |
| Gets app attribute names. | v4/all_member_push/im_get_attr_name |
| Gets user attributes. | v4/all_member_push/im_get_attr |
| Sets user attributes. | v4/all_member_push/im_set_attr |
| Deletes user attributes. | v4/all_member_push/im_remove_attr |
| Gets user tags. | v4/all_member_push/im_get_tag |
| Adds user tags. | v4/all_member_push/im_add_tag |
| Deletes user tags. | v4/all_member_push/im_remove_tag |
| Deletes all tags of a user. | v4/all_member_push/im_remove_all_tags |
Profile Management
| Feature | API |
|---|---|
| Configures profiles. | v4/profile/portrait_set |
| Pulls profiles. | v4/profile/portrait_get |
Relationship Chain Management
| Feature | API |
|---|---|
| Adds friends. | v4/sns/friend_add |
| Imports friends. | v4/sns/friend_import |
| Updates friends. | v4/sns/friend_update |
| Deletes friends. | v4/sns/friend_delete |
| Deletes all friends. | v4/sns/friend_delete_all |
| Verifies friends. | v4/sns/friend_check |
| Pulls friends. | v4/sns/friend_get |
| Pulls specified friends. | v4/sns/friend_get_list |
| Blocklists users. | v4/sns/black_list_add |
| Unblocklists users. | v4/sns/black_list_delete |
| Pulls a blocklist. | v4/sns/black_list_get |
| Checks whether specified users are on a user’s blocklist and/or vice versa. | v4/sns/black_list_check |
| Adds lists. | v4/sns/group_add |
| Deletes lists. | v4/sns/group_delete |
| Pulls lists. | v4/sns/group_get |
Recent Contacts
| Feature | API |
|---|---|
| Pulls a conversation list. | v4/recentcontact/get_list |
| Deletes a conversation. | v4/recentcontact/delete |
Group Management
Global Mute Management
| Feature | API |
|---|---|
| Sets global mute. | v4/openconfigsvr/setnospeaking |
| Queries global mute. | v4/openconfigsvr/getnospeaking |
Operations Management
| Feature | API |
|---|---|
| Pulls operations data. | v4/openconfigsvr/getappinfo |
| Downloads recent messages. | v4/open_msg_svc/get_history |
| Gets server IP addresses. | v4/ConfigSvc/GetIPList |
Yes
No
Was this page helpful?