设置聊天室管理员信息

接口URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-chat-admin

接口说明

1、设置聊天室管理员信息,提交参数都不能为空。
2、头像要求:只能为jpg、jpeg、png三种格式,大小不能超过2Mb。
3、接口支持https协议
4、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
nickname string 管理员昵称,长度不能超过8
actor string 管理员头衔,长度不能超过4
avatar MultipartFile 管理员头像,支持jpg、jpeg、png三种格式,大小不能超过2Mb
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值

响应成功JSON示例:

设置引导页,未上传图片

{
    code: 200,
    status: "success",
    message: "",
    data: "修改成功"
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId not found.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

频道号错误

{
    "code": 400,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

签名错误

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

没有输入nickname

{
    "code": 400,
    "status": "error",
    "message": "nickname is required.",
    "data": ""
}

nickname长度不合法

{
    "code": 400,
    "status": "error",
    "message": "昵称长度不能大于 8.",
    "data": ""
}

图片大于2Mb

{
    "code": 400,
    "status": "error",
    "message": "image oversize error.",
    "data": ""
}

图片格式错误

{
    "code": 400,
    "status": "error",
    "message": "image format error.",
    "data": ""
}

其他错误

{
    "code": 400,
    "status": "error",
    "message": "修改失败",
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空,错误时错误信息
data 成功请求时为"success",如果上传图片则为图片url

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "137720";
$nickname = "管理员昵称";
$actor = "这是头衔";
$avatar = 'C:\Users\polyv\Desktop\avatar_test.png';

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

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$data = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'nickname' => $nickname,
    'actor' => $actor,
    'sign' => $sign,
    'avatar' => new CURLFile(realpath($avatar))
);
$url = "http://api.polyv.net/live/v2/channelSetting/$channelId/set-chat-admin";
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $data);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$reponse = curl_exec ( $ch );
curl_close ( $ch );
print_r($reponse);

?>

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

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

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