https://xxxxxx/v4/openconfigsvr/getnospeaking?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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 |
---|---|
https | The request protocol is HTTPS, and the request method is POST. |
xxxxxx | The country/region where your SDKAppID is located.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com |
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. |
contenttype | Request format. The value is always json . |
The maximum invocation frequency is 200 times per second.
{
"Get_Account": "lumotuwe"
}
Field | Type | Attribute | Description |
---|---|---|---|
Get_Account | String | Required | Specify the account for which muting information is queried. |
{
"ErrorCode": 0,
"ErrorInfo": "",
"C2CmsgNospeakingTime": 4294967295,
"GroupmsgNospeakingTime": 7196
}
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. |
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. |
Use the RESTful online commissioning tool for APIs to commission this API.
Enabling global muting (v4/openconfigsvr/setnospeaking)
Was this page helpful?