tencent cloud

Overview

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

API Calling Description

Applicable group types

These are the preset group types in IM. For more information, see Group System.

Sample request URL

https://xxxxxx/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

• 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"
           }
       }
   ],
   "CloudCustomData": "your cloud custom data",
   "OfflinePushInfo": {
       "PushFlag": 0, // Normal push
       "Desc": "Content to push offline",
       "Ext": "Passthrough content",
       "AndroidInfo": {
           "Sound": "android.mp3"
       },
       "ApnsInfo": {
           "Sound": "apns.mp3",
           "BadgeMode": 1, // If this field is left as default or is set to `0`, the message is counted. If this field is set to `1`, the message is not counted, that is, the icon number in the upper-right corner does not increase.
           "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", // 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 recipient
  If To_Account is added to the message body, and a message recipient is specified in it, the message will be sent only to the specified recipient, and the message is excluded from the unread count. (Supported group types: Private, Public, ChatRoom)

  Note：

  This feature is supported only in the Flagship Edition.

  {
   "GroupId":"@TGS#12DEVUDHQ",
   "Random":2784275388,
   "MsgBody":[
       {
           "MsgType":"TIMCustomElem",
           "MsgContent":{
               "Data":"1cddddddddq1"
           }
       }
   ],
   "To_Account":["brennanli2", "brennanli3"] // Specify the message recipient (up to 50 recipients can be specified). If this field is used, the message is excluded from the unread count.
  }
  

• Specifying that messages do not trigger conversation update
  If the value of SendMsgControl includes NoLastMsg, the message does not trigger conversation update; if it includes NoUnread, the message is not included in the unread count. The setting takes effect only for the current message. The parameter is not available for AVChatRoom.

  {
    "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.
    "SendMsgControl":["NoLastMsg"],// Do not trigger conversation update.
    "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 three priority options in descending order: High, Normal, and Low. 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 option
   "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.

  • Community and AVChatRoom groups do not support the @all feature.

    {
      "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, the message is for online delivery only, not for offline or roaming retention (not available for AVChatRoom or BChatRoom).

     {
       "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, // 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 fields

Sample responses

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

Response 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 RESTful API online debugging tool to debug this API.

References

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

Possible Callbacks

Callback After Sending a Group Message