直播关联自定义场次id
更新时间：2022-09-02 18:08:07
接口URL
https://api.polyv.net/live/v3/channel/session/relevance
接口说明
1、接口用于
2、接口支持https
支持格式
JSON
请求方式
POST
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 13位当前时间戳 |
| sign | 是 | String | 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | 是 | int | 频道号 |
| externalSessionId | 是 | string | 自定义直播场次UUID，32位长度 |
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": "success"
}
响应失败JSON示例：
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 响应代码，成功为200，失败为400，签名错误为401，异常错误500 |
| status | 成功为success，失败为error |
| message | 错误时为错误提示消息 |
| data | 修改成功过时为success |
php请求示例
<?php
//引用config.php
include '/srv/http/config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => '206204',
'externalSessionId' => '自定义直播场次UUID，32位长度');
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "http://api.polyv.net/live/v3/channel/relevance-session?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
