Feature Description

This API is used by app admins to send ordinary messages in a group.

API Calling Description

Applicable group types

These are the 4 built-in group types in IM. For detailed information, see the Group System.

Sample request URL

https://console.tim.qq.com/v4/group_open_http_svc/send_group_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

• Basic form
  The app admin sends ordinary group messages.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Random": 8912345, // A random number. If the random numbers of two messages within five minutes are the same, the two messages are considered to be the same message.
    "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text message
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji message
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ],
    "OfflinePushInfo": {
        "PushFlag": 0, // Normal push
        "Desc": "The content that is pushed offline",
        "Ext": "This is the passthrough content",
        "AndroidInfo": {
            "Sound": "android.mp3"
        },
        "ApnsInfo": {
            "Sound": "apns.mp3",
            "BadgeMode": 1, // If this parameter is not specified or is set to 0, the message is counted. If this parameter is set to 1, the message is not counted, that is, the number in the upper-right corner of the icon does not increase.
            "Title":"apns title", // apns title
            "SubTitle":"apns subtitle", // apns subtitle
            "Image":"www.image.com" // image url
        }
    }
  }

• Specify the message sender
  The app admin can specify a group member as the message sender in From_Account.
  After receiving the message, other members will see that the message is sent from the group member specified by the app admin.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "From_Account": "leckie", // Message sender (optional)
    "Random": 8912345, // A random number. If the random numbers of two messages within five minutes are the same, the two messages are considered to be the same message.
    "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text message
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji message
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ]
  }

• Specify the message priority
  You can specify the message priority. The default priority is Normal.
  The four priority options in descending order are High, Normal, Low, and Lowest. They are case-sensitive.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Random": 8912345, // A random number. If the random numbers of two messages within five minutes are the same, the two messages are considered to be the same message.
    "MsgPriority": "High", // Message priority
    "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text message
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji message
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ]
  }

• Disable callback for a specified message
  When callback is toggled on, users can specify ForbidCallbackControl to control whether to initiate callback for a single message. By default, callback is initiated.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Random": 8912345, // A random number. If the random numbers of two messages within five minutes are the same, the two messages are considered to be the same message.
    "ForbidCallbackControl":[
            "ForbidBeforeSendMsgCallback",
            "ForbidAfterSendMsgCallback"], // Option to control whether to disable callback
    "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text message
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji message
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ]
  }

• Specify messages for online delivery without offline or roaming retention
  If OnlineOnlyFlag in the message body is set to a value greater than 0, the message is for online delivery only, not for offline or roaming retention (this feature is not supported by AVChatRooms and BChatRooms).

    {
        "GroupId": "@TGS#2C5SZEAEF",
        "Random": 8912345, // A random number. If the random numbers of two messages within five minutes are the same, the two messages are considered to be the same message.
        "OnlineOnlyFlag": 1, // This indicates that the message is for online delivery only (only online group members will receive the message), not for offline or roaming retention.
        "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
            {
                "MsgType": "TIMTextElem", // Text message
                "MsgContent": {
                    "Text": "red packet"
                }
            },
            {
                "MsgType": "TIMFaceElem", // Emoji message
                "MsgContent": {
                    "Index": 6,
                    "Data": "abc\u0000\u0001"
                }
            }
        ]
    }

Request packet fields

Sample response packet body

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MsgTime": 1497249503,
    "MsgSeq": 1
}

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:

API Debugging Tool

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

Reference

• Sending system messages in a group (v4/group_open_http_svc/send_group_system_notification)
• Sending a one-to-one chat message (v4/openim/sendmsg)
• Batch sending one-to-one messages (v4/openim/batchsendmsg)
• Message Format Description

Possible Callbacks

Callback Before Delivering Group Messages