Get the sign required to call the chat room API
Updated: 2022-09-02 18:08:07
API URL
https://api.polyv.net/live/v3/channel/monitor/get-room-sign
API Description
1. Purpose: Used to obtain the sign required to call the chat room API.
2. The API supports the HTTPS protocol.
Supported Format
JSON
Request Method
GET
Request Limit
TRUE
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | Obtained from API settings, the appId registered in the live streaming system. |
| timestamp | Yes | string | Current time in seconds (13-digit timestamp). |
| sign | Yes | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data. For details, see Signature Generation Rules. |
| channelId | Yes | int | Channel ID. |
Example of Successful Response
{
"code": 200,
"message": "",
"status": "success",
"data": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Example of Failed Response
Signature error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Response Field Description
| Name | Type | Description |
|---|---|---|
| code | string | Response code: 200 for success, 400 for failure, 403 for signature error, 500 for server error. |
| status | string | "success" for success, "error" for failure. |
| message | string | Error message when an error occurs. |
| data | string | Returns the sign required for the chat room API on success. |
PHP Request Example
<?php
//引用config.php
include 'config.php';
$params = array(
'appId'=>$appId,
'channelId'=>$channelId,
'timestamp'=>$timestamp
);
//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="https://api.polyv.net/live/v3/channel/monitor/get-room-sign?".http_build_query($params);
echo "<script>window.location.href='$url'</script>";
?>
