tencent cloud

Feedback

Setting Global Mute

Last updated: 2024-07-16 11:29:54

    Background

    Global muting includes the global muting of one-to-one messages and that of group messages.
    If the global muting of one-to-one messages is enabled for an account, during the muting period, no one-to-one messages can be sent, the sender receives error code 20012 (for details, see Error Codes), and Before a One-to-One Message Is Sent webhook is not triggered. 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 one-to-one messages is disabled for accounts.
    If the global muting of group messages is enabled for an account, during the muting period, no group messages can be sent, the sender receives error code 10017 (for details, see Error Codes), and Before Group Message Is Sent webhook is not triggered. 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. By default, the global muting of group messages is disabled for accounts.

    Feature Description

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

    API Calling Description

    Sample request URL

    https://xxxxxx/v4/openconfigsvr/setnospeaking?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/setnospeaking
    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

    {
    "Set_Account": "lumotuwe",
    "C2CmsgNospeakingTime": 4294967295, // `C2CmsgNospeakingTime` and `GroupmsgNospeakingTime` are optional, but either of them must be specified.
    "GroupmsgNospeakingTime": 7200
    }

    Request fields

    Field
    Type
    Required
    Description
    Set_Account
    String
    Required
    Account for which muting will be enabled
    C2CmsgNospeakingTime
    Integer
    Optional
    Muting period (in seconds) of one-to-one messages. The value is a non-negative integer, and the maximum value is 4294967295 (0xFFFFFFFF in hexadecimal format).
    0: the account is unmuted
    4294967295: the account is permanently muted
    Other values: a specific muting period of the account
    GroupmsgNospeakingTime
    Integer
    Optional
    Muting period (in seconds) of group messages. The value is a non-negative integer, and the maximum value is 4294967295 (0xFFFFFFFF in hexadecimal format).
    0: the account is unmuted
    4294967295: the account is permanently muted
    Other values: a specific muting period of the account

    Sample response

    {
    "ErrorCode": 0,
    "ErrorInfo": "",
    }

    Response fields

    Field
    Type
    Description
    ErrorCode
    Integer
    Request error code. 0: Successful; other values: Failed
    ErrorInfo
    String
    Error information

    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 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 format. Check whether the JSON request meets JSON specifications.
    130004
    The JSON request does not contain the Set_Account field.
    130005
    The Set_Account field in the JSON request is invalid.
    130008
    Neither GroupmsgNospeakingTime nor C2CmsgNospeakingTime in the JSON request is specified.
    130014
    A system error occurred. Try again or contact technical support.

    API Debugging Tool

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

    References

    Querying global mute (v4/openconfigsvr/setnospeaking)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support