聊天API

频道管理

创建频道

API 地址

api.vhallyun.com/api/v2/channel/create

描述

频道为消息的载体,所有需要发送消息的SDK(流开始、关闭信息除外),都需要传入频道作为消息的传输通道

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义

出参

参数 类型 是否必选 含义
channel_id string 频道ID

错误码

错误码 类型 含义

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "channel_id": "ch_e5fa35b2"
    }
}

删除频道

API 地址

api.vhallyun.com/api/v2/channel/delete

描述

删除频道,和创建频道对应

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID

出参

参数 类型 是否必选 含义
delete_channel_id string 频道ID

错误码

错误码 类型 含义
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40002 int 消息类型不正确
40006 int 频道类型不正确
40055 int 智能审核no_audit参数不正确
50015 int 删除频道失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "delete_channel_id": "ch_e5fa35b2"
    }
}

消息管理

发送消息

API 地址

api.vhallyun.com/api/v2/message/send

描述

通过频道作为载体,可根据类型发送消息

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID
type string 消息类型
body string 消息体(编码:utf8),默认为空
client string 客户端
room_id string 直播房间ID
third_party_user_id string 第三方用户ID,type为service_im时必填
no_audit int 是否经过智能审核,0经过,1不经过,默认为0
context json String 自定义内容,须包含nick_name及avatar字段

type枚举值列表

枚举值 说明
service_im 聊天消息
service_custom 自定义消息

client枚举值列表

当type为service_im时必填

枚举值 说明
pc_browser PC网页浏览器
h5_browser h5网页浏览器
android 安卓手机应用
ios 苹果手机应用
desktop 桌面客户端
wechat_browser 微信内置浏览器
wechat_applet 微信小程序

出参

参数 类型 是否必选 含义

错误码

错误码 类型 含义
10006 int 第三方用户ID不能为空
10010 int 消息类型不能为空
10016 int 频道ID不能为空
20002 int 房间查询为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
30011 int 当前自定义广播过量,无法继续发送
40004 int 消息体过长,最长为1000
40013 int 客户端类型不能为空
40014 int 客户端类型错误
50002 int 消息发送失败
50028 int 消息发送失败,频道已被禁言!
50029 int 消息发送失败,用户已被禁言!

响应格式

{
    "code": 200,
    "msg": null,
    "data": []
}

查看消息&过滤数量

API 地址

api.vhallyun.com/api/v2/message/get-message-num

描述

按当前公共参数传入app_id对应的应用,查询消息数量和智能过滤消息的数量

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
start_time date 查询开始时间,格式:2017/01/01
end_time date 查询结束时间 ,默认为当前时间。格式:2017/01/01

出参

参数 类型 是否必选 含义
msg_count int 消息数量
msg_filter_count int 过滤消息数量

错误码

错误码 类型 含义
10020 int 开始时间不能为空
40004 int 时间类型不正确
40040 int 开始时间不能大于结束时间
50012 int 查询失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "2017-12-12": {
            "msg_count": 2,
            "msg_filter_count": 4
        },
        "2017-12-13": {
            "msg_count": 4,
            "msg_filter_count": 8
        },
        "2017-12-14": {
            "msg_count": 0,
            "msg_filter_count": 0
        }
    }
}

删除消息

API 地址

api.vhallyun.com/api/v2/message/delete

描述

通过聊天服务内获取的msg_id,执行删除对应消息记录的操作

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
msg_id string 消息id
channel_id string 频道id

出参

参数 类型 是否必选 含义

错误码

错误码 类型 含义
10037 int 消息id不能为空
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
50011 int 删除消息失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": []
}

历史消息查询

API 地址

api.vhallyun.com/api/v2/message/lists

描述

根据频道ID,获取消息列表

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道id
type int 查询类型 ,1 聊天列表( 默认),2 自定义聊天列表
curr_page int 当前页,默认为1
page_size int 每页大小,默认为10,最大值为1000
filter_status int 过滤类型 , 0 可查看( 默认),1 不可查看
start_time date 查询开始时间,格式为:2017/01/01
end_time date 查询结束时间,默认为当前时间,格式为:2017/01/01
order_by string 排序方式,asc按照时间升序,desc按照时间倒序,默认desc
audit_status string 消息审核状态,默认("0,1,3"【人工审核通过及系统自动审核通过】,可选值:0【未经过消息审核服务】、1【人工审核通过】、2【人工审核拒绝】、3【超过200条自动审核通过】、4【超过200条自动审核拒绝】)
msg_type string 要查询消息类型,多个类型用逗号分割,默认文本(text),可选值:text、image、link、video、voice、disable、disable_all、permit、permit_all,传all则获取所有

出参

参数 类型 是否必选 含义
list list 消息列表
total int 消息总条数
page_num int 当前页
page_all int 总页数

错误码

错误码 类型 含义
10016 int 频道ID不能为空
10020 int 开始时间不能为空
20004 int 频道查询为空
20010 int 聊天数据查询为空
30002 int 不是当前频道拥有者
40002 int 消息类型不正确
40004 int 时间类型不正确
40008 int 当前页数不正确
40009 int 分页条目不正确
40038 int 过滤类型不正确
40040 int 开始时间不能大于结束时间
40049 int msg_type含有不允许的类型
40050 int audit_status含有不允许的类型
40072 int 排序类型不正确,值为asc或者desc
70001 int 分页条目超过限制,最大1000

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "list":[
            {
			    "type":"text",
                "data": "天天",
                "date_time": "2017-12-22 01:32:25",
                "third_party_user_id": "test1",
                "nick_name": "游客1443",
                "avatar":""
            }
        ],
        "total":1,
        "page_num":1,
        "page_all":1
        }
}

设置第三方用户信息

API 地址

api.vhallyun.com/api/v2/channel/save-user-info

描述

在微吼云服务器设置第三方的头像昵称信息作为聊天时使用的头像和昵称 注意,该接口只作为消息服务,消息内容头像和昵称安全不被串改的一种保障,不作其他使用

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
third_party_user_id string 第三用户ID
nick_name string 昵称
avatar string 头像(头像网络路径)

出参

参数 类型 是否必选 含义

错误码

错误码 类型 含义
10006 int 第三方用户ID不能为空
10022 int 昵称不能为空
10023 int 头像不能为空
40043 int 无效的头像地址
50012 int 设置第三方用户信息失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": []
}

获取频道在线人数列表

API 地址

api.vhallyun.com/api/v2/channel/get-userid-list

描述

根据频道ID,获取聊天频道在线用户列表

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID
curr_page int 当前页,默认为1
page_size int 每页大小。默认为10,最大为1000

出参

参数 类型 是否必选 含义
list list 第三方用户id列表
context object 用户自定义内容
disable_users list 禁言用户列表
channel_disable bool 频道禁言状态,true未被禁言,false已被禁言
total int 消息总条数
page_num int 当前页
page_all int 总页数

错误码

错误码 类型 含义
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40008 int 当前页数不正确
40009 int 分页条目不正确
50016 int 获取聊天频道在线用户列表失败
70001 int 分页条目超过限制

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "list":[
            "vhallyun_5b6c126b69d43",//发送消息者ID
            "vhallyun_5b6c1289458db"//发送消息者ID
        ],
		"context":{
		  "vhallyun_5b6c126b69d43":false//用户自定义内容
		},
		"disable_users":[
			"vhallyun_5b6c1289458db"//禁言用户列表
		],
		"channel_disable":false,//频道禁言状态
        "total":2,
        "page_num":1,
        "page_all":1
    }
}

获取用户在线连接数

API 地址

api.vhallyun.com/api/v2/channel/user-online-count

描述

根据频道ID,获取频道在线人数

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID

出参

参数 类型 是否必选 含义
channel string 频道ID
count int 频道在线人数

错误码

错误码 类型 含义
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
50014 int 获取聊天频道在线人数失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "channel": "ch_fc9c96d5",
        "count": 2
    }
}

获取频道在线连接数

API 地址

api.vhallyun.com/api/v2/channel/connection-count

描述

根据频道ID,获取频道在线连接数

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID

出参

参数 类型 是否必选 含义
channel string 频道ID
count int 频道在线连接数

错误码

错误码 类型 含义
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
50022 int 获取聊天频道在线连接数失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "channel": "ch_fc9c96d5",
        "count": 2
    }
}

数据统计查询

获取聊天频道消息统计数据

API 地址

api.vhallyun.com/api/v2/channel/send-message-stat

描述

根据频道ID,获取聊天频道消息发送人数,消息发送总条数,删除消息条数,过滤消息条数

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID

出参

参数 类型 是否必选 含义
channel string 频道ID
count int 频道发送消息总数
user_count int 频道发送过消息的总人数
delete_count int 频道删除消息条数
filter_count int 频道被过滤消息条数

错误码

错误码 类型 含义
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
50021 int 获取聊天频道消息统计数据失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "channel": "ch_fc9c96d5",
        "count": 2,
        "delete_count": 0,
        "filter_count": 0,
        "user_count": 2
    }
}

聊天服务设置

设置聊天关键字过滤

API 地址

api.vhallyun.com/api/v2/channel/set-keyword

描述

根据应用app_id,设置聊天关键字过滤

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
black_list string 黑名单关键字,多个关键字以逗号分割,最多一次性传入1000个
white_list string 白名单关键字,多个关键字以逗号分割,最多一次性传入1000个

出参

参数 类型 是否必选 含义
app_id string 应用ID
black_list string 黑名单关键字
white_list string 白名单关键字

错误码

错误码 类型 含义
50017 int 设置自定义过滤关键字失败

响应格式

{
    "code": 200,
    "msg": null,
    "data":{
        "app_id":"app_sdfewfwe2e12321",//应用ID
        "black_list":"暴力的,不健康的",//黑名单关键字
        "white_list":"微吼,微吼直播"//白名单关键字
    }
}

获取聊天关键字过滤

API 地址

api.vhallyun.com/api/v2/channel/get-keyword

描述

根据应用app_id,获取聊天过滤关键字

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义

出参

参数 类型 是否必选 含义
app_id string 应用ID
black_list string 黑名单关键字
white_list string 白名单关键字

错误码

错误码 类型 含义
50018 int 获取自定义过滤关键字失败

响应格式

{
    "code": 200,
    "msg": null,
    "data":{
        "app_id":"app_sdfewfwe2e12321",//应用ID
        "black_list":"习近平,周恩来",//黑名单关键字
        "white_list":"微吼,微吼直播"//白名单关键字
    }
}

设置开关接口

API 地址

api.vhallyun.com/api/v2/channel/set-switch

描述

根据应用app_id,开启聊天关键字过滤及图片鉴黄功能

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
keyword_filter int 是否开启消息关键字过滤功能:0否,1是,默认为0

出参

参数 类型 是否必选 含义
app_id string 应用ID
keyword_filter int 是否开启消息关键字过滤功能:0 否 1 是

错误码

错误码 类型 含义
40041 int 开启消息关键字过滤类型错误
50019 int 设置开关状态失败

响应格式

{
    "code": 200,
    "msg": null,
    "data":{
        "app_id":"app_sdfewfwe2e12321",//应用ID
        "keyword_filter": 0//是否开启消息关键字过滤功能:0 否 1 是
    }
}

获取开关接口状态

API 地址

api.vhallyun.com/api/v2/channel/get-switch

描述

根据应用app_id,获取聊天关键字过滤及图片鉴黄状态

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义

出参

参数 类型 是否必选 含义
app_id string 应用ID
keyword_filter int 是否开启消息关键字过滤功能:0 否 1 是
status string 过滤状态:open开启 close 关闭

错误码

错误码 类型 含义
50020 int 获取开关状态失败

响应格式

{
    "code": 200,
    "msg": null,
    "data":{
        "app_id":"app_sdfewfwe2e12321",//应用ID
        "keyword_filter": 0,//是否开启消息关键字过滤功能:0 否 1 是
		"status":"open"//过滤开启(open),过滤关闭(close)
    }
}

批量检查聊天频道第三方用户是否在线

API 地址

api.vhallyun.com/api/v2/channel/check-user-online

描述

根据频道ID和第三方用户ID,检查第三方用户是否在线

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID
third_party_user_ids string 第三用户ID,多个用英文逗号分割

出参

参数 类型 是否必选 含义
channel string 频道ID
connections object 第三方用户id在线列表的对象,第三方用户ID为key,在线状态为值,大于0为在线,等于0为不在线

错误码

错误码 类型 含义
10006 int 第三方用户ID不能为空
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
50013 int 检查聊天频道第三方用户在线状态失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "channel": "ch_fc9c96d5",
        "connections": {
            "vhallyun_5b86182cd89c2": 1,
            "vhallyun_5b8619c942f23": 1
        }
    }
}

设置频道禁言

API 地址

api.vhallyun.com/api/v2/channel/set-channel

描述

根据频道ID和第三方用户ID,禁言频道或者频道内的某个人

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
channel_id string 频道ID
third_party_user_id string 第三用户ID
target_id string 被禁言者ID,当type为disable和permit时此值必填
type string disable 禁言频道内某个用户的聊天(频道内单个用户的禁言)、disable_all 禁言整个频道的聊天(全员禁言)、permit 取消禁言频道内某个用户的聊天(取消频道内单个用户的禁言)、 permit_all 取消禁言整个频道的聊天 (取消全员禁言)

出参

参数 类型 是否必选 含义

错误码

错误码 类型 含义
10006 int 第三方用户ID不能为空
10016 int 频道ID不能为空
10062 int 频道设置类型不能为空
10063 int 频道被操作者ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
40051 int 设置被禁言人ID错误
40052 int 设置频道禁言状态不正确
40054 int 禁言/取消禁言单个用户时target_id不能为空
50013 int 检查聊天频道第三方用户在线状态失败
50027 int 设置频道禁言失败

响应格式

{
    "code": 200,
    "msg": null,
    "data":[]
}