通过HTTP接口在聊天室发送消息

接口URL

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

接口说明

可指定发言者的头像、头衔、昵称,无需连接聊天室,通过HTTP接口发送聊天文本内容

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号
adminIndex int 管理员索引,可以指定多个管理员发送消息,默认只有一个管理员
msg string 发送的文本消息
pic string 管理员头像
nickName string 昵称,最大为8个长度,超出会被截断
actor string 头衔,最大为4个长度,超出会被截断,不传参数则表示无头衔

操作成功响应示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "发送成功"
}

操作失败响应示例

签名错误

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

缺少参数 channelId

{
    "code": 400,
    "status": "error"
    "message": "param should not be empty: channelId",
    "data": ""
}

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息

php请求示例

<?php
//引用config.php
include 'config.php';
$channelId = '123456';
$pic = 'http://xxxx.jpg';
$nickName = 'tom';
$msg = 'test';
$actor = 'admin';
$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => $channelId,
  'msg' => $msg,
  'pic' => $pic,
  'nickName' => $nickName,
  'actor' => $actor
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$url="http://api.polyv.net/live/v3/channel/chat/send-admin-msg?appId=$appId&timestamp=$timestamp&channelId=$channelId&sign=$sign&msg=$msg&pic=$pic&nickName=$nickName&actor=$actor";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$output = curl_exec ( $ch );
curl_close ( $ch );
print_r($output);
?>

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

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

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