- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Legacy API Tutorials
- Client APIs
- 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
- 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
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Global Mute Management
- Operations Management
- Online States
- 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
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Legacy API Tutorials
- Client APIs
- 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
- 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
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Global Mute Management
- Operations Management
- Online States
- 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
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
Background
- Global muting includes the global muting of one-to-one chat messages and that of group chat messages.
- By default, the global muting of one-to-one chat messages is disabled for accounts. If the global muting of one-to-one chat messages is enabled for an account, all one-to-one chat messages fail to be sent during the muting period. After the muting period expires, the IM backend system automatically disables the global muting of one-to-one chat messages, and then all one-to-one chat messages can be sent normally. For the permanent global muting of one-to-one chat messages, the muting period never expires.
- By default, the global muting of group chat messages is disabled for accounts. If the global muting of group chat messages is enabled for an account, all group chat messages fail to be sent during the muting period. After the muting period expires, the IM backend system automatically disables the global muting of group chat messages, and then all group chat messages can be sent normally. For the permanent global muting of group chat messages, the muting period never expires.
Feature Description
- Query the account’s setting of global muting of one-to-one chat messages.
- Query the account’s setting of global muting of group chat messages.
API Invocation Description
Request URL example
https://console.tim.qq.com/v4/openconfigsvr/getnospeaking?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=jsonRequest parameters
The following table lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.
| Parameter | Description |
|---|---|
| v4/openconfigsvr/getnospeaking | The request API. |
| sdkappid | The SDKAppID assigned by the IM console when an app is created. |
| identifier | This must be the app admin account. For details, see App Admins. |
| usersig | The signature generated by the app admin account. For details, see Generating UserSig. |
| random | Enter a random 32-bit unsigned integer ranging from 0 to 4294967295. |
Maximum invocation frequency
The maximum invocation frequency is 200 times per second.
Request packet example
{
"Get_Account": "lumotuwe"
}Request packet fields
| Field | Type | Attribute | Description |
|---|---|---|---|
| Get_Account | String | Required | Specify the account for which muting information is queried. |
Response packet example
{
"ErrorCode": 0,
"ErrorInfo": "",
"C2CmsgNospeakingTime": 4294967295,
"GroupmsgNospeakingTime": 7196
}Response packet fields
| Field | Type | Description |
|---|---|---|
| ErrorCode | Integer | The request error code. 0: succeeded. Others: failed. |
| ErrorInfo | String | Error information. |
| C2CmsgNospeakingTime | Number | The muting period for one-to-one chat messages, in seconds. The value is a non-negative integer. The 0 value indicates that message muting is disabled. The maximum value 4294967295 (or 0xFFFFFFFF in hexadecimal) indicates that permanent muting is enabled for the account. Other values indicate the specific muting period of the account. For example, the 3600 value indicates that the muting period of the account is 1 hour. |
| GroupmsgNospeakingTime | Number | The muting period for group chat messages, in seconds. The value is a non-negative integer. The 0 value indicates that message muting is disabled. The maximum value 4294967295 (or 0xFFFFFFFF in hexadecimal) indicates that permanent muting is enabled for the account. Other values indicate the specific muting period of the account. For example, the 3600 value indicates that the muting period of the account is 1 hour. |
Error Codes
Unless a network error (such as error 502) occurs, the HTTP return code of this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.
| Error Code | Description |
|---|---|
| 130001 | Failed to parse the JSON request packet. In this case, check whether the request packet meets JSON specifications. |
| 130002 | The JSON request packet does not include the Get_Account field. |
| 130003 | The Get_Account field in the JSON request packet is invalid. |
| 130014 | A JSON system error occurred. In this case, try again or contact our technical support service. |
API Commissioning Tool
Use the RESTful online commissioning tool for APIs to commission this API.
References
Enabling global muting (v4/openconfigsvr/setnospeaking)
Yes
No
Was this page helpful?