Feature Description

This API is used by the app admin to send notifications 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.

Non-livestreaming groups support sending system notifications to a specified set of group members, but AVChatRooms (livestreaming groups) only support sending system notifications to all group members.

Sample request URL

https://console.tim.qq.com/v4/group_open_http_svc/send_group_system_notification?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
  Send notifications to all members of a group.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "Content": "Hello World" // Content of the system notification
  }

• Specify group members to receive the message
  To specify who can receive the system notification, set the recipients in ToMembers_Account. AVChatRooms (livestreaming groups) do not support specifying group members to receive messages.

  {
    "GroupId": "@TGS#2C5SZEAEF",
    "ToMembers_Account": [ // List of recipients. Leave this field empty to send notifications to all members.
        "peter",
        "leckie"
    ],
    "Content": "Hello World" // Content of the system notification
  }

Request packet fields

Sample response packet body

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

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 ordinary messages in a group (v4/group_open_http_svc/send_group_msg)