查询频道的菜单信息

接口URL

http://api.polyv.net/live/v3/channel/menu/list

接口说明

1、获取频道的菜单信息
2、接口支持https协议

支持格式

JSON

请求方式

 GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
channelId int 频道id
appId string 从API设置中获取,在直播系统登记的appId
sign string 签名,为32位大写的MD5值
timestamp string 当前13位毫秒级(兼容10位秒级)时间戳,3分钟内有效

响应成功JSON示例:

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "menuId": "521e4f5847",
      "menuType": "desc",
      "name": "直播介绍",
      "ordered": 1,
      "content": ""
    },
    {
      "menuId": "1b01bc166b",
      "menuType": "chat",
      "name": "互动聊天",
      "ordered": 2,
      "content": ""
    },
    {
      "menuId": "41d186c2ab",
      "menuType": "quiz",
      "name": "咨询提问",
      "ordered": 3,
      "content": ""
    },
    {
      "menuId": "c2f9e7d8f4",
      "menuType": "iframe",
      "name": "test",
      "ordered": 4,
      "content": null
    },
    {
      "menuId": "df8a32aaf7",
      "menuType": "text",
      "name": "1212",
      "ordered": 5,
      "content": "<p><br></p>"
    }
  ]
}

响应异常JSON示例:

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

字段说明

字段 说明
menuId 菜单Id
menuType 菜单类型, desc为直播介绍,chat为聊天室,quiz为咨询提问,iframe为推广外链,text为自定义图文菜单
name 菜单名称
ordered 排序
content 内容

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$channelId = "101385";
$timestamp = 1528708015437;
$appId = "test";

$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp,
    'channelId'=>$channelId
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "http://api.polyv.net/live/v3/channel/menu/list.do?appId=$appId&timestamp=$timestamp&channelId=$channelId&sign=$sign";

//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...