Sending Ordinary Messages in a Group

Feature Description

Through this API, the app admin can send common messages in a group.

API Invocation Description

Applicable group types

IM provides the preceding five built-in group types. For details, see Group Systems.

Request URL example

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 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.

Maximum invocation frequency

The maximum invocation frequency is 200 times per second.

Request packet examples

• Basic form
  The app admin sends common group messages.

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

• Specifying 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 find that the message is sent from the group member specified by the app admin.

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

• Specifying the message priority
  You can specify the message priority, which defaults to Normal.
  There are four priorities, which are the following in descending order: High, Normal, Low, and Lowest. Note that these priorities are case-sensitive.

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

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

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

• Forbidding offline storage and roaming for a specified message
  If OnlineOnlyFlag in the message body is set to a value greater than 0, the message will only be delivered online but not stored offline or roamed. Note that this feature is unavailable for AVChatRoom and BChatRoom groups.

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

Request packet fields

Response packet example

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

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for 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.

API Commissioning Tool

Use the online commissioning tool for RESTful APIs to commission this API.

References

• Sending system notifications in a group (v4/group_open_http_svc/send_group_system_notification)
• Sending a one-to-one chat message (v4/openim/sendmsg)
• Sending one-to-one chat messages in batches (v4/openim/batchsendmsg)
• Message format description

Callback That May Be Triggered

Callback before delivering group messages