简介

微吼知客接口文档

公共参数

参数 类型 是否必选 备注
app_id String 应用id
signed_at String 时间戳,不能大于或者小于当前时间10分钟
sign String 签名,详见签名机制

签名机制

1)按照参数名称的字典顺序对请求中所有的请求参数进行排序。
2)按 键值键值 方式拼接成字符串。
3)在此字符串首尾各拼接一次secret_key。
4)对拼接后的字符串进行md5,得到sign。

Php demo

$secret_key = "9rdmeq5mfqbkcnocm9cp7pzz";//应用密钥,从知客提供

// 用户参数示例

$params = [
    "activity_id"=> "123456789", 
    "app_id"=> "1111", 
    "signed_at"=> "1484620708" 
];

// 按参数名升序排列
ksort($params);

// 初始化签名字串
$str = '';

// 将键值组合连接到签名字串上
foreach ($params as $k => $v) {
$str .= $k.$v;
}

// 将签名字串前后两端加上秘钥进行MD5运算
$sign = md5($secret_key . $str . $secret_key);

// 将sign签名放到请求数据中
$params["sign"] = $sign;

获取直播活动下的用户离线计算数据

接口地址:https://zhike.vhall.com/api/frontend/outapi/user-info-offline-by-activity
注:获取直播活动下的用户离线计算数据

输入参数:

参数 类型 是否必选 备注
activity_id String 活动id
signed_at String 当前页
sign String 每页条数小于等于100

输出参数:

{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "source": "百度渠道",                          //渠道来源
                "openId": "0x0x0x0x0x0x13600011111",          //微信授信
                "recvNum": "300",                             //是否提交问卷
                "getNum": "400",                              //是否领取红包
                "merchandiseBrowse": "30",                    //是否浏览商品
                "clicks": "20"                                //是否点击推荐卡片
            },
            {
                "source": "百度渠道",
                "openId": "0x0x0x0x0x0x13600011111",
                "recvNum": "300",
                "getNum": "400",
                "merchandiseBrowse": "30",
                "clicks": "20"
            },
            {
                "source": "百度渠道",
                "openId": "0x0x0x0x0x0x13600011111",
                "recvNum": "300",
                "getNum": "400",
                "merchandiseBrowse": "30",
                "clicks": "20"
            },
            {
                "source": "百度渠道",
                "openId": "0x0x0x0x0x0x13600011111",
                "recvNum": "300",
                "getNum": "400",
                "merchandiseBrowse": "30",
                "clicks": "20"
            }
        ],
        "page": 1,                                            //当前页
        "pageSize": 10,                                       //每页大小
        "total": 100                                          //数据总数
    }
}

获取直播活动下的用户实时数据

接口地址:https://zhike.vhall.com/api/frontend/outapi/user-info-current-by-activity
注:获取直播活动下的用户实时数据

输入参数:

参数 类型 是否必选 备注
activity_id String 活动id
signed_at String 当前页
sign String 每页条数小于等于100

输出参数:

{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "realName": "张三",                                              //姓名
                "phone": "13600011111",                                        //手机号码
                "email": "exmail@vhall.com",                                 //邮箱
                "company": "北京微吼时代科技有限公司",                //公司
                "position": "产品经理",                                         //职务
                "sex": "女",                                                         //性别
                "city": "四川省成都市",                                          //城市
                "comment": "备注",                                              //备注
                "appointmentTime": "06:30:15",                             //预约时间
                "signUpTime": "07:30:15",                                     //报名时间
                "firstJoinAt": "08:30:15"                                        //参会时间
            },
            {
                "realName": "张三",
                "phone": "13600011111",
                "email": "exmail@vhall.com",
                "company": "北京微吼时代科技有限公司",
                "position": "产品经理",
                "sex": "女",
                "city": "四川省成都市",
                "comment": "备注",
                "appointmentTime": "06:30:15",
                "signUpTime": "07:30:15",
                "firstJoinAt": "08:30:15"
            },
            {
                "realName": "张三",
                "phone": "13600011111",
                "email": "exmail@vhall.com",
                "company": "北京微吼时代科技有限公司",
                "position": "产品经理",
                "sex": "女",
                "city": "四川省成都市",
                "comment": "备注",
                "appointmentTime": "06:30:15",
                "signUpTime": "07:30:15",
                "firstJoinAt": "08:30:15"
            },
            {
                "realName": "张三",
                "phone": "13600011111",
                "email": "exmail@vhall.com",
                "company": "北京微吼时代科技有限公司",
                "position": "产品经理",
                "sex": "女",
                "city": "四川省成都市",
                "comment": "备注",
                "appointmentTime": "06:30:15",
                "signUpTime": "07:30:15",
                "firstJoinAt": "08:30:15"
            }
        ],
        "page": 1,                                                             //当前页
        "pageSize": 10,                                                     //每页大小
        "total": 100                                                          //数据总数
    }
}

获取用户创建的直播列表数据--实时

接口地址:https://zhike.vhall.com/api/frontend/outapi/activity-info-current?page=1&pageSize=10
注:获取用户创建的直播列表数据--实时

输入参数:

参数 类型 是否必选 备注
signed_at String 当前页
sign String 每页条数小于等于100

输出参数:

{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "id": 62647341,                                      //活动id
                "title": "我的活动",                                  //活动标题
                "liveTime": "2019-12-19 17:21:01",            //直播时长
                "tags": [                                               //直播标签
                    "互联网",
                    "医疗",
                    "食品"
                ]
            },
            {
                "id": 52999553,
                "title": "测试活动",
                "liveTime": "2019-12-19 17:49:08",
                "tags": [
                    "互联网",
                    "IT技术",
                    "电商"
                ]
            },
            {
                "id": 60426064,
                "title": "可以预约直播课程",
                "liveTime": "2019-12-19 18:52:07",
                "tags": [
                    "互联网",
                    "IT技术",
                    "汽车"
                ]
            },
            {
                "id": 26072917,
                "title": "测试活动",
                "liveTime": "2019-12-20 10:29:21",
                "tags": [
                    "互联网",
                    "IT技术",
                    "电商"
                ]
            },
            {
                "id": 78124525,
                "title": "测试活动",
                "liveTime": null,
                "tags": [
                    "互联网",
                    "IT技术",
                    "电商"
                ]
            },
            {
                "id": 91141077,
                "title": "我的活动",
                "liveTime": null,
                "tags": [
                    "互联网",
                    "IT技术",
                    "电商"
                ]
            }
        ],
        "page": 1,                                                            //当前页
        "pageSize": 10,                                                    //每页大小
        "total": 6                                                            //总数
    }
}

获取用户创建的直播列表数据--离线计算

接口地址:https://zhike.vhall.com/api/frontend/outapi/activity-info-current?page=1&pageSize=10
注:获取用户创建的直播列表数据--离线计算

输入参数:

参数 类型 是否必选 备注
signed_at String 当前页
sign String 每页条数小于等于100

输出参数:

{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "joinUserValue": 100,                               //参与用户
                "viewerCount": 1000,                               //观众总数
                "watchTimeValue": 86400,                       //人居观看时长
                "spreadRatio": 6.8,                                  //分享效果指数
                "interactintRatio": 7,                                //互动效果指数
                "behaviorRatio": 9,                                  //用户行为得分
                "activity_id": 46536048                            //活动id
            },
            {
                "joinUserValue": 100,
                "viewerCount": 1000,
                "watchTimeValue": 86400,
                "spreadRatio": 6.8,
                "interactintRatio": 7,
                "behaviorRatio": 9,
                "activity_id": 46536049
            },
            {
                "joinUserValue": 100,
                "viewerCount": 1000,
                "watchTimeValue": 86400,
                "spreadRatio": 6.8,
                "interactintRatio": 7,
                "behaviorRatio": 9,
                "activity_id": 46536010
            },
            {
                "joinUserValue": 100,
                "viewerCount": 1000,
                "watchTimeValue": 86400,
                "spreadRatio": 6.8,
                "interactintRatio": 7,
                "behaviorRatio": 9,
                "activity_id": 46536090
            },
            {
                "joinUserValue": 100,
                "viewerCount": 1000,
                "watchTimeValue": 86400,
                "spreadRatio": 6.8,
                "interactintRatio": 7,
                "behaviorRatio": 9,
                "activity_id": 46536090
            }
        ],
        "page": 1,                                                                         //当前页
        "pageSize": 10,                                                                 //每页大小 
        "total": 100                                                                      //总数
    }
}