接口URL
http://api.polyv.net/live/v3/channel/menu/add
接口说明
1、作用：添加一个频道菜单
2、接口支持https协议
支持格式
JSON
请求方式
POST
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | string | 当前时间的秒级时间戳（13位） |
| sign | 是 | string | 签名，为32位大写的MD5值 |
| channelId | 是 | int | 频道号 |
| name | 是 | string | 菜单名称 |
| type | 是 | string | 菜单类型 desc 直播介绍 chat 互动聊天 quiz 咨询提问 text 图文菜单 iframe推广外链 |
| content | 是 | string | 菜单内容。 当菜单类型为直播介绍、图文菜单时，该值为菜单的内容。 当菜单类型为外链推广时，该值为外链链接地址。 |
操作成功响应示例
{
"code": 200,
"message": "",
"data": {
"menuId": "3b650cf438",
"menuType": "iframe",
"name": "推广菜单",
"ordered": 6,
"content": "http://polyv.net"
}
}
操作失败响应示例
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
缺少参数
{
"code": 400,
"status": "error"
"message": "param should not be empty: name",
"data": ""
}
参数长度过长
{
"code": 400,
"status": "error"
"message": "param length is incorrect: name",
"data": ""
}
菜单类型错误
{
"code": 400,
"status": "error"
"message": "invalid menu type",
"data": ""
}
已存在该类型的菜单（除 text、iframe 类型外，其他菜单都具有唯一性，重复添加相同类型时会返回错误）
{
"code": 400,
"status": "error"
"message": "menu already exist",
"data": ""
}
菜单数已达到上限（“咨询提问”之外，最多可以有6个菜单）
{
"code": 400,
"status": "error"
"message": "menu count reached the limit",
"data": ""
}
响应字段说明
| 名称 | 类型 | 说明 |
|---|---|---|
| code | string | 响应代码，成功为200，失败为400，签名错误为401，异常错误500 |
| status | string | 成功为success，失败为error |
| message | string | 错误时为错误提示消息 |
| menuId | string | 菜单ID |
| menuType | string | 菜单类型 desc 直播介绍 chat 互动聊天 quiz 咨询提问 text 图文菜单 iframe推广外链 |
| name | string | 菜单名称 |
| ordered | string | 菜单顺序，值越小，越靠前。新添加的菜单默认位于最后。 |
| content | string | 菜单内容 |
php请求示例
<?php
//引用config.php
include 'config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => '123456',
'name' => '菜单名称',
'type' => 'text',
'content' => '菜单内容'
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params["sign"] = $sign;
$url="http://api.polyv.net/live/v3/channel/menu/add?".http_build_query($params);
function post($url, $post_data = '', $timeout = 5){
$ch = curl_init();
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_POST, 1);
if($post_data != ''){
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
}
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Content-Length: ' . strlen($post_data)));
$file_contents = curl_exec($ch);
curl_close($ch);
return $file_contents;
}
echo post($url);
?>
java请求示例
package com.live;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.http.HttpEntity;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import com.live.util.EncryptionUtils;
public class Demo {
private static RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(15000).setConnectTimeout(15000)
.setConnectionRequestTimeout(15000).build();
public static void main(String[] args) {
String url = "http://api.polyv.net/live/v3/channel/menu/add";
String appId = "appId";
String key = "secretKey";
Map<String, String> map = new HashMap<>();
map.put("appId", appId);
map.put("timestamp", String.valueOf(System.currentTimeMillis()));
map.put("channelId", "123456");
map.put("name", "菜单名称");
map.put("type", "text");
map.put("content", "菜单内容");
String sign = getSign(map, key);
map.put("sign", sign);
String body = "";
String content = sendHttpPost(url, map, body);
System.out.println(content);
}
/**
* 发送 post请求
* @param httpUrl 地址
* @param maps 参数
*/
public static String sendHttpPost(String httpUrl, Map<String, String> maps, String body) {
StringBuilder url = new StringBuilder();
url.append(httpUrl).append("?");
for (Map.Entry<String, String> map : maps.entrySet()) {
url.append(map.getKey()).append("=").append(map.getValue()).append("&");
}
String urlStr = url.toString().substring(0, url.length() - 1);
System.out.println(urlStr);
// 创建httpPost
HttpPost httpPost = new HttpPost(urlStr);
try {
StringEntity entity = new StringEntity(body, Charset.forName("UTF-8"));
httpPost.setEntity(entity);
} catch (Exception e) {
// ...
}
return sendHttpPost(httpPost);
}
/**
* 发送Post请求
* @param httpPost
* @return
*/
private static String sendHttpPost(HttpPost httpPost) {
CloseableHttpClient httpClient = null;
CloseableHttpResponse response = null;
HttpEntity entity;
String responseContent = null;
try {
// 创建默认的httpClient实例.
httpClient = HttpClients.createDefault();
httpPost.setConfig(requestConfig);
// 执行请求
response = httpClient.execute(httpPost);
entity = response.getEntity();
responseContent = EntityUtils.toString(entity, "UTF-8");
} catch (Exception e) {
// ...
} finally {
try {
// 关闭连接,释放资源
if (response != null) {
response.close();
}
if (null != httpPost) {
httpPost.releaseConnection();
}
if (httpClient != null) {
httpClient.close();
}
} catch (IOException e) {
// ...
}
}
return responseContent;
}
/**
* 根据map里的参数构建加密串
* @param map
* @param secretKey
* @return
*/
protected static String getSign(Map<String, String> map, String secretKey) {
Map<String, String> params = paraFilter(map);
// 处理参数，计算MD5哈希值
String concatedStr = concatParams(params);
String plain = secretKey + concatedStr + secretKey;
String encrypted = EncryptionUtils.md5Hex(plain);
// 32位大写MD5值
return encrypted.toUpperCase();
}
/**
* 对params根据key来排序并且以key1=value1&key2=value2的形式拼接起来
* @param params
* @return
*/
private static String concatParams(Map<String, String> params) {
List<String> keys = new ArrayList<>(params.keySet());
Collections.sort(keys);
StringBuilder sb = new StringBuilder();
for (int i = 0; i < keys.size(); i++) {
String key = keys.get(i);
String value = params.get(key);
sb.append(key).append(value);
}
return sb.toString();
}
/**
* 除去数组中的空值和签名参数
* @param sArray 签名参数组
* @return 去掉空值与签名参数后的新签名参数组
*/
private static Map<String, String> paraFilter(Map<String, String> sArray) {
Map<String, String> result = new HashMap<>();
if (sArray == null || sArray.size() <= 0) {
return result;
}
for (String key : sArray.keySet()) {
String value = sArray.get(key);
if (value == null || value.equals("") || key.equalsIgnoreCase("sign")
|| key.equalsIgnoreCase("sign_type")) {
continue;
}
result.put(key, value);
}
return result;
}
}
Loading...