Deleting Live Streaming Group Robots
Feature Overview
App administrators and group owners can delete previously added robot accounts from the live streaming group's online member list. This API essentially removes the special tag (500) for the robot account. For details, refer to the API Setting Live Streaming Group Member Tags. This feature requires the Premium Edition, and the live streaming group online member list feature must have been enabled under group feature configuration in the Chat console. Calling this API will return a failure for other package editions.
API Call Description
Applicable Group Types
Group Type ID | REST API Support |
Private | No. It is similar to Work (friend work group) in the new version. |
Public | No. |
ChatRoom | No. It is similar to Meeting (temporary meeting group) in the new version. |
AVChatRoom | Yes. |
Community | No. |
Note
This feature requires the Premium Edition Package, and the live streaming group online member list feature must have been enabled (under group feature configuration in the console).
Calling this API will return a failure for other package editions.
This API essentially removes the special tag (500) for the robot account. For details, refer to the API Setting Live Streaming Group Member Tags.
Sample Request URL
https://xxxxxx/v4/group_open_avchatroom_http_svc/del_robots?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table only lists the parameters involved when this API is called and their descriptions. For details on other parameters, see REST API Overview.
Parameter | Description |
xxxxxx | The dedicated domain name corresponding to the country/region of the SDKAppID: 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_avchatroom_http_svc/del_robots | Request API. |
sdkappid | The SDKAppID assigned by the Chat console when an application is created. |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | The request format is fixed to json . |
Maximum Call Frequency
200 times/second
Sample Request Packets
Delete bots bot1 and bot2 from a live streaming group:
{"GroupId": "@TGS#a6I4ZUUGO","Member_Account": ["bot1", "bot2"]}
Request Packet Fields
Field | Type | Attribute | Description |
GroupId | String | Required | ID of the operated group. |
Member_Account | Array | Required | List of robot accounts to be deleted. |
Sample Response Packets
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": ""}
Response Packet Fields
Field | Type | Description |
ActionStatus | String | Processing results: OK: succeeded. FAIL: failed. |
ErrorCode | Integer | Error code: 0: succeeded. Other values: failed. |
ErrorInfo | String | Error message. |
Error Codes
Unless a network error occurs (such as a 502 error), the HTTP return code for this API is always 200. The real error code and error message are indicated by ErrorCode and ErrorInfo in the response packets.
Common error codes (60000 to 79999) can be found in Error Codes.
The private error codes for this API are as follows:
Error Code | Description |
10001 | The user does not log in. Please check whether the admin account and usersig are correct. |
10002 | System error. Please try again or contact technical support. |
10003 | Invalid request command. Please try again or contact technical support. |
10004 | Invalid parameters. Please check whether the required fields are filled in or whether the field fillings meet the protocol requirements based on the ErrorInfo field in the response packets. |
10007 | Insufficient permissions. This API must be called by an app administrator or group owner. |
10010 | The group does not exist, or it once existed but has now been dissolved. |
10015 | Invalid group ID. Please check whether the group ID is filled in correctly. |