(Hidden) Send Message as Administrator

Updated: 2022-09-02 18:08:07

API Description

1、通过管理员，发送聊天消息
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/chat/send

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID
content	true	String	Chat message content
role	true	String	Sender role (currently only administrator role is supported, value is "ADMIN")

Example

http://api.polyv.net/live/v3/channel/chat/send

Form parameters:

role=ADMIN&appId=frlr1zazn3&sign=216F6344B9BC30B04F7C726AA8FF9F9D&channelId=2191569&content=（可隐藏）以管理员身份发送信息&timestamp=1616641619171

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	String	Returns "The message send success!" on success, empty string on error

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java from the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChatMessageTest.class);

/**
 * （可隐藏）以管理员身份发送信息
 * @throws IOException
 */
@Test
public void testSendHiddenMessageByAdmin() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/live/v3/channel/chat/send";
        String channelId = "2191569";
        String content = "（可隐藏）以管理员身份发送信息";
        String role = "ADMIN";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("content",content);
        requestMap.put("role",role);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试（可隐藏）以管理员身份发送信息接口返回值：{}",response);

}

Response Example

See Global Error Description for system-wide error explanations.

Success example

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "The message send success!"
}

Error example

{
  "code": 400,
  "status": "error",
  "message": "invalid signature.",
  "data": ""
}

Live Streaming Server API