管理员发送聊天信息

更新时间：2023-12-21 14:35:02

接口描述

1、通过HTTP接口发送聊天文本内容，可指定发言者的头像、头衔、昵称，无需连接聊天室
2、接口支持https协议
3、文本消息和图片消息必传一个

接口URL

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

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	String	频道号
msg	false	String	发送的文本消息，文本消息和图片消息必传一个，最长为2000字符
imgUrl	false	String	发送的图片消息地址，url不支持带参数。文本消息和图片消息必传一个发送图片消息时，设置的昵称、头衔和头像暂不生效
pic	true	String	管理员头像，url不支持带参数。
nickName	true	String	昵称，最大为8个长度，超出会被截断
adminIndex	false	Integer	管理员索引，可以指定多个管理员发送消息，默认只有一个管理员
actor	false	String	头衔，最大为4个长度，超出会被截断，不传参数则表示无头衔
freeReview	false	String	当频道开启审核后消息是否需要经过审核，默认为N Y：不需要 N：需要
apiVersion	true	String	接口版本，目前可选版本(3.2)，不同的版本返回数据会有细微差异，详情查看响应示例

示例

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

表单参数：

msg=测试发送图文信息&actor=大管理员&apiVersion=3.2&nickName=西瓜籽&appId=frlr1zazn3&freeReview=&sign=03430C8D280F64B4FCF9848D6E3E3993&adminIndex=1&pic=https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132&channelId=2191569&timestamp=1616641479456

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	成功返回“发送成功”或者消息id，取决于请求参数apiVersion，具体见返回示例；错误返回空字符串

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChatMessageTest.class);
/**
 * 发送图文信息
 * @throws IOException
 */
@Test
public void testSendMessage() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/live/v3/channel/chat/send-admin-msg";
        String channelId = "2191569";
        Integer adminIndex = 1;
        String msg = "测试发送图文信息";
        String pic = "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132";
        String nickName = "西瓜籽";
        String actor = "大管理员";
        String freeReview = "";
        String apiVersion = "3.2";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("adminIndex",adminIndex.toString());
        requestMap.put("msg",msg);
        requestMap.put("pic",pic);
        requestMap.put("nickName",nickName);
        requestMap.put("actor",actor);
        requestMap.put("freeReview",freeReview);
        requestMap.put("apiVersion",apiVersion);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试发送聊天室消息接口返回值：{}",response);

}

响应示例

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

成功示例-当apiVersion没有设置时

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

成功示例-当apiVersion设置为3.1时

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "msgId":"a16610f0-852f-11eb-b491-81c8f28f8d72"
    }
}

异常示例

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

直播服务端 API