Feature Description

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

API Call Description

Applicable group types

Above are the IM built-in groups. For more information, see 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 following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Overview.

Maximum call frequency

200 calls per second

Sample request packets

• Basic Format
  The app admin sends ordinary group messages, and the sender is the app admin.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "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": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ],
    "OfflinePushInfo": {
        "PushFlag": 0, // Normal push
        "Desc": "The content that is pushed offline",
        "Ext": "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 icon number in the upper-right corner does not increase by 1.
            "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 see that the message is sent from the group member specified by the app admin.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "From_Account": "leckie", // The specified 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": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "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. The default priority is Normal.
  There are four priority options in descending order: High, Normal, Low, and Lowest. They are case-sensitive.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "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.
    "MsgPriority": "High", // Message priority
    "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ]
  }

• Forbidding Callback for a Message
  When the callback switch is turned 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 are the same within five minutes, they are considered to be the same message.
    "ForbidCallbackControl":[
            "ForbidBeforeSendMsgCallback",
            "ForbidAfterSendMsgCallback"], // Callback forbidding control options
    "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
        {
            "MsgType": "TIMTextElem", // Text
            "MsgContent": {
                "Text": "red packet"
            }
        },
        {
            "MsgType": "TIMFaceElem", // Emoji
            "MsgContent": {
                "Index": 6,
                "Data": "abc\u0000\u0001"
            }
        }
    ]
  }

• Sending group @ messages
  The target @ users set in the GroupAtInfo field have a one-to-one and sequential correspondence to the target @ users in the message body.

      {
          "GroupId": "@TGS#2C5SZEAEF",
          "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": [ // Message body, which consists of an element array. For details, see the field description.
              {
                  "MsgType": "TIMTextElem", // Text
                  "MsgContent": {
                      "Text": "red @all @tommy @brennanli packet"
                  }
              }
          ],
          //It corresponds to @all @tommy @brennanli in the text information.
          "GroupAtInfo":[
          {
              "GroupAtAllFlag":1 //1: @all. 0: @ a certain group member
          },
          {
              "GroupAtAllFlag":0,
              "GroupAt_Account":"tommy" // @ a specific group member
          },
          {
              "GroupAtAllFlag":0,
              "GroupAt_Account":"brennanli"
          }
       ]    
      }

• Specifying Messages for Online Delivery Without Offline or Roaming Retention
  If OnlineOnlyFlag in the message body is set to a value greater than 0, it indicates that the message is for online delivery only, not for offline or roaming retention (AVChatRooms and BChatRooms do not allow this use).

    {
        "GroupId": "@TGS#2C5SZEAEF",
        "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.
        "OnlineOnlyFlag": 1, // It indicates that the message is for online delivery only (only online group members will receive it), not for offline or roaming retention.
        "MsgBody": [ // Message body, which consists of an element array. For details, see the field description.
            {
                "MsgType": "TIMTextElem", // Text
                "MsgContent": {
                    "Text": "red packet"
                }
            },
            {
                "MsgType": "TIMFaceElem", // Emoji
                "MsgContent": {
                    "Index": 6,
                    "Data": "abc\u0000\u0001"
                }
            }
        ]
    }

Request packet fields

Sample response packet

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

Response packet fields

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, please see Error Codes.
The following table describes the error codes specific to this API.

API Debugging Tool

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

References

• Sending System Messages in a Group (v4/group_open_http_svc/send_group_system_notification)
• Sending a One-to-One Messages to One User (v4/openim/sendmsg)
• Sending One-to-One Messages to Multiple Users (v4/openim/batchsendmsg)
• Message Format Description

Possible Callback

Callback before delivering group message