このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Chat/
サーバー API/
RESTful インターフェース/
全員発言禁止の管理/
全員発言禁止の照会/

全員発言禁止の照会

Background

Global muting includes the global muting of one-to-one messages and that of group messages.
By default, the global muting of one-to-one messages is disabled for accounts. If the global muting of one-to-one messages is enabled for an account, all one-to-one messages cannot be sent during the muting period. After the muting period expires, the Chat backend system automatically disables the global muting of one-to-one messages, and then all one-to-one messages can be sent normally. For the permanent global muting of one-to-one messages, the muting period never expires.
By default, the global muting of group messages is disabled for accounts. If the global muting of group messages is enabled for an account, all group messages cannot be sent during the muting period. After the muting period expires, the Chat backend system automatically disables the global muting of group messages, and then all group messages can be sent normally. For the permanent global muting of group messages, the muting period never expires.

Feature Description

This API is used to query the global muting of one-to-one messages for an account.
This API is used to query the global muting of group messages for an account.

API Calling Description

Sample request URL

https://xxxxxx/v4/openconfigsvr/getnospeaking?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/openconfigsvr/getnospeaking
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format. The value is fixed to json.

Maximum call frequency

200 calls per second

Sample request

{
    "Get_Account": "lumotuwe"
}

Request fields

Field
Type
Required
Description
Get_Account
String
Required
Account for which muting information is queried

Sample response

{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "C2CmsgNospeakingTime": 4294967295,
    "GroupmsgNospeakingTime": 7196
}

Response fields

Field
Type
Description
ErrorCode
Integer
Request error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information
C2CmsgNospeakingTime
Number
The muting period for one-to-one messages, in seconds. The value is a non-negative integer. The value 0 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 value 3600 indicates that the muting period of the account is one hour.
GroupmsgNospeakingTime
Number
The muting period for group messages, in seconds. The value is a non-negative integer. The value 0 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 value 3600 indicates that the muting period of the account is one hour.

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public 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 format. Check whether the JSON request meets JSON specifications.
130002
The JSON request does not contain the Get_Account field.
130003
The Get_Account field in the JSON request is invalid.
130014
A JSON system error occurred. Try again or contact technical support.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References

Setting global mute (v4/openconfigsvr/setnospeaking)