发送审核通过的聊天消息
接口描述
接口URL
请求方式
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
appId
true
String
channelId
true
String
频道ID
sign
true
String
timestamp
true
String
当前13位毫秒级时间戳,3分钟内有效
请求体参数描述
msgId
true
String
自定义的msgId,不超过32个字符
viewerId
true
String
观众id,不超过64个字符
nickName
true
String
观众昵称,不超过128个字符
content
true
String
消息内容content,不超过2000个字符
avatar
false
String
观众头像链接,不超过200个字符;若不传入该字段,viewerId对应观众在线时使用用户头像,否则使用默认头像
sessionId
false
String
场次id
viewerType
false
String
观众类型, viewer:观众,student: 学生,slice: 云课堂学员
示例
请求体json参数:
响应参数描述
code
Integer
状态码,与 http 状态码相同,用于确定基本的响应状态
data
Array
error
Object
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
是否成功响应
Data参数描述
id
String
保利威聊天室消息id
msg
String
错误或正常的提示,如:发送成功
msgId
String
外部消息Id,即请求参数中的msgId
status
Boolean
发言是否成功,true:成功,false:失败
Error参数描述
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
Last updated
Was this helpful?