tencent cloud

Feedback

Broadcast Message of Audio-Video Group

Last updated: 2024-07-16 10:41:26

    Feature Overview

    This API is used to deliver broadcast messages to all the audio-video groups.
    Note
    This feature is supported by the SDK of the Enhanced edition on v6.5.2803 or later and the SDK for web on v2.21.0 or later. To use it, you need to purchase the Premium edition, go to the console, select Feature configuration > Group configuration > Group feature configuration, and enable Broadcast messaging of audio-video group.

    API Calling Description

    Applicable group types

    Group Type ID
    RESTful API Support
    Private
    No. Same as work groups (Work) in the new version.
    Public
    No
    ChatRoom
    No. Same as meeting groups (Meeting) in the new version.
    AVChatRoom
    Yes. Messages are sent to all the audio-video groups.
    Community
    No
    These are the preset group types in Chat. For more information, see Group System.

    Sample request URL

    https://xxxxxx/v4/group_open_http_svc/send_broadcast_msg?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/group_open_http_svc/send_broadcast_msg
    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

    1 times/second

    Sample request

    Basic format
    It is used to deliver broadcast messages to all the audio-video groups.
    {
    "From_Account": "test", // Specify the message sender (optional)
    "Random": 8912345, // A random number. If the random numbers of two messages are the same within five minutes, they are considered to be the same message.
    "MsgBody": [
    {
    "MsgType": "TIMCustomElem", // Custom message
    "MsgContent": {
    "Data": "{ \\"type\\":1, \\"content\\":\\"hello world\\"}"
    }
    }
    ],
    "CloudCustomData": "your cloud custom data"
    }
    Caution
    MsgBody supports multiple message elements. If you need to call it more than once every second, the business can merge messages into one of up to 12,000 bytes.

    Request fields

    Field
    Type
    Required
    Description
    From_Account
    String
    No
    Message source account. If this field is not specified, the message sender is the app admin account used to call the API. Alternatively, apps can specify the message sender in this field to implement some special features. Note that if this field is specified, you must ensure that the account in this field exists.
    Random
    Integer
    Yes
    A 32-bit unsigned integer. If the content and random numbers of two messages within five minutes are the same, the later message will be discarded as a repeated message.
    MsgBody
    Array
    Yes
    Message body. For more information, see Message Formats.
    CloudCustomData
    String
    No
    Custom message data

    Sample response

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MsgSeq": 1283
    }

    Response fields

    Field
    Type
    Description
    ActionStatus
    String
    Request result. OK: successful; FAIL: failed
    ErrorCode
    Integer
    Error code. 0: Successful; other values: Failed
    ErrorInfo
    String
    Error information
    MsgSeq
    Integer
    Message sequence number, the unique identifier of a message

    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
    10002
    Internal server error. Try again.
    10003
    Invalid command word.
    10004
    Invalid parameter. Check the error description and troubleshoot the issue.
    10007
    Insufficient operation permissions. For example, the switch is not enabled in the console, or the operating account is not the root account.
    10023
    The frequency limit for message sending is reached. Try again later.

    API Debugging Tool

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

    References

    Sending Ordinary Messages in a Group (v4/group_open_http_svc/send_group_msg)
    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