Feature Description

This API is used by app admins to push system notifications to group chats.

API Call Description

Applicable group types

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

Note：

A non-audio-video group supports sending system notifications to specified group members, but an audio-video group (AVChatRoom) only supports sending system notifications to all group members.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/send_group_system_notification?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 Introduction.

Maximum call frequency

200 calls per second

Sample request packets

• To all members
  This example pushes a system notification to all members in a group.

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

• To specific members
  To specify who can receive the system notification, set the recipients in ToMembers_Account. Audio-video groups (AVChatRoom) only support sending system notifications to all group members, but not specified group members.

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

Request packet fields

Sample response packet

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

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

Reference

Sending ordinary messages in a group (v4/group_open_http_svc/send_group_msg)