(可隐藏)发送图文信息

接口描述

1、通过聊天室API,发送图文信息
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"

接口URL

http://api.polyv.net/live/v1/channelSetting/{channelId}/send-chat

请求方式

POST

接口约束

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

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

userId

true

String

直播账号id

content/imgUrl

true

String

需要发送的图片或是文字,二者不能同时为空,可以同时提交, content需要进行base64编码,详见url安全的base64编码规则

url安全的base64编码规则

Java

public static String encodeBase64URLSafeString(String text) {
        byte[] data = org.apache.commons.codec.binary.Base64.encodeBase64URLSafe(text.getBytes(StandardCharsets.UTF_8));
        return new String(data, StandardCharsets.UTF_8);
}

php

function urlsafe_b64encode($string) {
        $data = base64_encode($string);
        $data = str_replace(array('+','/','='), array('-','_',''), $data);
        return $data;
}

示例

http://api.polyv.net/live/v1/channelSetting/2191569/send-chat

表单参数:

appId=frlr1zazn3&sign=47B9259E6E93CA2E15B33D532E813417&userId=1b448be323&content=5rWL6K-V77yI5Y-v6ZqQ6JeP77yJ5Y-R6YCB5Zu-5paH5L-h5oGv&timestamp=1616641094219

响应参数描述

参数名类型说明

status

String

响应状态文本信息

result

String

响应数据

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChatMessageTest.class);

// URL安全的字符串base64编码
public static String encodeBase64URLSafeString(String text) {
        byte[] data = org.apache.commons.codec.binary.Base64.encodeBase64URLSafe(text.getBytes(StandardCharsets.UTF_8));
        return new String(data, StandardCharsets.UTF_8);
}

/**
 * (可隐藏)发送图文信息
 * @throws IOException
 */
@Test
public void testSendHiddenMessage() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String userId = super.userId;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String url = "http://api.polyv.net/live/v1/channelSetting/"+channelId+"/send-chat";
        String content = encodeBase64URLSafeString("测试(可隐藏)发送图文信息");

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("content",content);
        requestMap.put("userId",userId);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试(可隐藏)发送图文信息接口返回值:{}",response);

}

响应示例

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

成功示例

{
  "status": "success",
  "result": ""
}

异常示例

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

Last updated