发送自定义消息

更新时间：2023-02-16 23:29:52

接口描述

1、发送聊天室自定义消息
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/chat/send-custom-message/encode

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、需要发送的文字内容（content）或者图片（imgUrl）不能同时为空，可以同时提交

3、需要发送的文字内容（content）需要进行URL安全的base64编码

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	String	频道号
content	false	String	发送文字内容，需要进行URL安全的base64编码，编码后最大长度1500个字符
imgUrl	false	String	发送的图片url地址
joinHistoryList	false	Integer	是否加入聊天历史数据，默认为1 1：加入到聊天历史数据 0：不加入
watchType	false	Integer	此消息面向何种角色发送（默认为1） 1：面向频道所有角色 2：仅面向频道内观众角色 3：仅面向特殊角色（讲师、嘉宾、助教、管理员）

示例

http://api.polyv.net/live/v4/chat/send-custom-message/encode?joinHistoryList=0&appId=frlr1zazn3&sign=94CAD8CB13062C904F193ED3958CE7DB&channelId=2272655&timestamp=1676561050174

表单参数：

content=5ZCM5a2m5Lus77yM5pma5LiK5aW977yB6L-Z5piv5oiR5Lus55qE56ys5LiA5aCC6K--77yB

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	成功响应时返回null

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 发送聊天室自定义消息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void sendCustomMessageEncodeTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/chat/send-custom-message/encode";
    String channelId = "2272655";
    String content = "同学们，晚上好！这是我们的第一堂课！";
    String joinHistoryList = "0";
        
    content = new String(
    org.apache.commons.codec.binary.Base64.encodeBase64URLSafe(content.getBytes(StandardCharsets.UTF_8)));
        
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("joinHistoryList", joinHistoryList);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    
    Map<String, String> paramMap = new HashMap<>();
    paramMap.put("content", content);
    
    String response = HttpUtil.postFormBody(url, paramMap);
    
    log.info("测试发送聊天室自定义消息成功：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "8cdf6088d1dc42abbe8727f402d502ac.73.16765610518450895",
    "data": null,
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

直播服务端 API