Group Type ID | RESTful API Support |
Private | No. Same as work groups (Work) in the new version. |
Public | No |
ChatRoom | No. Same as meeting groups (Meeting) in the new version. |
AVChatRoom | Yes. Messages are sent to all the audio-video groups. |
Community | No |
https://xxxxxx/v4/group_open_http_svc/send_broadcast_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/send_broadcast_msg | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is fixed to json . |
{"From_Account": "test", // Specify the 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": [{"MsgType": "TIMCustomElem", // Custom message"MsgContent": {"Data": "{ \\"type\\":1, \\"content\\":\\"hello world\\"}"}}],"CloudCustomData": "your cloud custom data"}
MsgBody
supports multiple message elements. If you need to call it more than once every second, the business can merge messages into one of up to 12,000 bytes.Field | Type | Required | Description |
From_Account | String | No | Message source account. If this field is not specified, the message sender is the app admin account used to call the API. Alternatively, apps can specify the message sender in this field to implement some special features. Note that if this field is specified, you must ensure that the account in this field exists. |
Random | Integer | Yes | A 32-bit unsigned integer. If the content and random numbers of two messages within five minutes are the same, the later message will be discarded as a repeated message. |
MsgBody | Array | Yes | |
CloudCustomData | String | No | Custom message data |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"MsgSeq": 1283}
Field | Type | Description |
ActionStatus | String | Request result. OK : successful; FAIL : failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
MsgSeq | Integer | Message sequence number, the unique identifier of a message |
ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:Error Code | Description |
10002 | Internal server error. Try again. |
10003 | Invalid command word. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10007 | Insufficient operation permissions. For example, the switch is not enabled in the console, or the operating account is not the root account. |
10023 | The frequency limit for message sending is reached. Try again later. |
Was this page helpful?