微吼知客开放平台接口文档

产品简介

这里是知客开放平台

产品介绍

产品介绍暂无

历史版本介绍

1.0版本接口文档

常见问题

常见问题清单

开放API文档

知客开放平台相关接口

API介绍

API简介

【微吼知客】API可以让开发者将【微吼知客】的直播能力与自身管理系统（例如：OA系统、网校系统、培训系统等）相结合，帮助开发者快速定制专属于您的知客服务。依照【微吼知客】提供的API接入文档，您可以将【微吼知客】与自身的业务模式进行集成，进而拥有知客直播发起、知客管理、回放管理等功能。【微吼知客】API服务，让您告别复杂的架构设计和编程开发，快速拥有知客直播互动能力，从而能够将更多精力专注在自身业务逻辑实现及最终用户体验提升上。

接入步骤

1、注册【微吼知客】账号，在【微吼知客】操作台中，选择【账户管理-开放接口】点击【联系客服】，3个工作日内会有工作人员联系您。或进行在线咨询，联系客户经理开通权限。

2、成功开通API后，获取API的【应用ID】、【应用密钥】，如已开通API权限，点击查看

3、通过使用第2步中得到的权限密钥，便可以访问API中的全部接口服务，如果请求没有带上权限密钥，【微吼知客】API的安全机制将会视其为未授权访问操作，并将其拦截。

权限密钥

API权限申请通过后，用户可在【账户管理-开放接口】页面获取【应用ID】和【应用密钥】。

参数说明：【应用ID】——用于标识客户身份。

【应用密钥】——作为私钥形式存储于客户方本地，不在网络传递，它的作用是对客户方发起的请求进行数字签名，保证该请求是来自指定客户的请求，并且是合法的有效的。注意删除多余半角空格。

API接入方案

API调用

API调用说明，见下面说明

调用方式

概述

API调用主要是通过用户向API的服务端地址发送HTTP GET/POST请求，并按照接口说明填写相应的请求参数完成的。服务端接收到请求后，系统会按照请求的处理情况，返回处理结果。

请求结构

接口URL

微吼知客的接口地址为：

https://zhike.vhall.com/api/v1

通信协议

请求支持HTTP和HTTPS两种访问方式

请求方法

GET/api/login

POST/api/login

同时支持POST&GET方式，GET方式查询字符串（名称/值对）是在GET请求的URL中发送的，POST方式查询字符串（名称/值对）是在POST请求的HTTP消息主体中发送的(request body 消息体目前不支持解析json字典，特有业务如需传输json串会在文档中指明传输格式)。

请求参数

每个请求都需要包含的公共请求参数

字符编码

请使用UTF-8编码

公共参数

公共参数包括

公共请求参数、公共响应参数部分。
公共请求参数需要需要每次请求都附带上

请请求的接口为 www.domain.com/api/v1/room/delete?room_id=lss_123456

那么实际请求的接口为 www.domain.com/api/v1/room/deleteroom_id=lss_123456&app_id=abcdef&signed_at=189302463&sign=ec1218becfhgc

公共请求参数

参数名	类型	必选	说明
app_id	string	是	控制台中申请的应用ID
signed_at	string	是	时间戳，不能大于或者小于当前时间10分钟
sign	string	是	签名，祥见签名机制

返回结果

返回值

所有返回值一律为JSON格式，返回的 HTTP 状态码为 2xx，代表调用成功。返回 4xx 或 5xx 的 HTTP 状态码代表调用失败。形如：

{
	"code": 200,
	"msg": "success",
	"data": {
	  "user_id": 16417997
	}
}

成功结果示例

{
	"code": 200,
	"msg": "success",
	"data": {
	    "user_id": 16417997
	}
}

错误结果示例

{
    "code": 500,
    "msg": "服务请求错误",
    "data": {},
}

响应公共参数说明

参数名	类型	说明
code	int	接口响应code码，根据code码进行逻辑处理和判断
msg	string	接口响应消息，对于code码的基本描述
data	object	接口响应数据对象，接口响应的主要数据在data字段中返回

其它响应字段说明

参数名	类型	说明
list	array	数据列表
total	int	总条数

请求示例PHP版

	$url = 'https://zhike.vhall.com/api/v1/activity/activity-lists';
	$post_data = array(
		'key'=>'xxx',
		'subject'=>'vhall',
		'start_time'=>1376934451,
	);
	$data = http_build_query($post_data);
	$ch = curl_init();
	curl_setopt($ch, CURLOPT_POST, 1);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_HEADER, 0);
	curl_setopt($ch, CURLOPT_URL, $url);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
	curl_setopt($ch, CURLOPT_TIMEOUT, 6);
	$result = curl_exec($ch);
	curl_close($ch);
	var_dump($result);//操作成功，返回{'code':200,'data':'123456789'}

错误码

code	含义
200	程序返回正常

签名机制

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

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;

IP白名单

暂无

活动管理

直播管理

见目录说明

获取活动列表

接口：获取活动列表接口

获取客户创建的直播列表数据

请求URL:

GET/activity/activity-lists

参数:

参数名	是否必须	类型	说明
page	是	int	当前页
pageSize	是	int	每页大小<=100

返回示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "id": 62647341,
                "title": "我的活动",
                "liveTime": "17:21:01",
                "tags": [
                    "互联网",
                    "医疗",
                    "食品"
                ]
            },
            {
                "id": 52999553,
                "title": "测试活动",
                "liveTime": "2019-12-19 17:49:08",
                "tags": [
                    "互联网",
                    "IT技术",
                    "电商"
                ]
            }
        ],
        "total": 6
    }
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

参数名	类型	说明
id	int	课程ID
title	string	活动标题
liveTime	string	课程简介
tags	array	课程开始直播标签数组
tags->items	string	直播标签

备注:

更多返回错误代码请看首页的错误代码描述

获取知客活动列表

接口：获取知客活动列表接口

获取客户创建的知客直播列表数据

请求URL:

GET/v2/base-manage/list-activity

参数:

参数名	是否必须	类型	说明
status	否	string	活动状态： PREPARE =>预告，LIVING=>直播中，FINISH=>直播结束，PLAYBACK=>回放状态，不传为全部
page_size	是	int	每页大小<=100 ，默认为12
page	是	int	当前页
sort_by	否	string	排序：create_time=>创建时间，默认创建时间倒序
keyword	否	string	搜索关键字
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "total": 133,
        "total_page": 133,
        "curr_page": "1",
        "page_size": "1",
        "list": [
            {
                "id": 18179833,
                "title": "测试推荐卡片",
                "user_id": 21200013,
                "business_account_id": 26600001,
                "sponsor": "微吼直播",
                "start_time": "2021-05-22 00:00:00",
                "real_start_time": "2021-05-21 17:49:44",
                "end_time": "2021-05-24 14:14:29",
                "img_url": "mp-test/ec/ec/ececd6d3487358758ff03433b57dec95.jpg",
                "description": "",
                "status": "FINISH",
                "view_condition": "NONE",
                "live_room": "lss_0d8dd26b",
                "hd_room": "inav_4d8f15ef",
                "channel_room": "ch_A3Vl8vu3",
                "ext_channel_room": "ch_8j46SR84",
                "published": "Y",
                "created_at": "2021-05-21 17:49:07",
                "admin_closed": "N",
                "entry_time": 30,
                "whitelist_status": null,
                "is_portrait": "N",
                "is_playback": "N",
                "layout": 1,
                "manual": 2,
                "auth_chat": 2,
                "chat_filter": 2,
                "gift_status": 2,
                "reward_status": 2,
                "global_gift_status": 2,
                "global_reward_status": 2,
                "data_finish_time": "2021-05-24 14:29:29",
                "valid_status": "N",
                "user_count": 5,
                "appointment_count": 0,
                "sign_count": 0,
                "visit_num": "4"
            }
        ]
    },
    "request_id": "ffda77ee-66ed-464f-a06a-07ea2d73"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

参数名	类型	说明
id	int	课程ID
title	string	活动标题
user_id	int	客户id
business_account_id	int	客户账号id
sponsor	string	主办方
start_time	string	预计开始时间
real_start_time	string	真正开始时间
end_time	string	直播结束时间
img_url	string	活动图片地址
description	string	活动描述
status	string	活动状态
view_condition	string	观看条件NONE: 无限制 INVITATION: 邀请APPOINT: 预约报名
live_room	string	直播房间id
hd_room	string	互动房间id
channel_room	string	聊天频道房间id
ext_channel_room	string	扩展消息频道
published	string	是否发布：Y=>是，N=>否
created_at	string	创建时间
admin_closed	string	是否被后台关闭：Y=>是，N=>否
entry_time	string	预期提前时间：30分钟，默认
whitelist_status	string	白名单状态
is_portrait	string
is_playback	string
layout	int	1.视频直播 2. 文档直播
manual	int	活动报名人工审核开启状态 1.开启 2.关闭
auth_chat	int	聊天人工审核开关1开启 2关闭
chat_filter	int	聊天严禁词过滤状态1开启 2关闭
gift_status	int	礼物开关 1:开启 2:关闭
reward_status	int	打赏开关 1:开启 2:关闭
global_gift_status	int	通用礼物开关 1:开启 2:关闭
global_reward_status	int	通用打赏开关 1:开启 2:关闭
data_finish_time	string	数据计算完成时间
valid_status	string	N
user_count	int	用户总数
appointment_count	int	预约总数
sign_count	int	报名总数
visit_num	int	访问总数

备注:

更多返回错误代码请看首页的错误代码描述

根据活动id删除活动

接口：根据活动ID删除活动

根据活动ID删除活动

请求URL:

GET/v2/base-manage/del-activity

参数:

参数名	是否必须	类型	说明
id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": [],
    "request_id": "58bb426f-eee9-4b28-8f10-0039ceb3"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": [],
    "request_id": "58bb426f-eee9-4b28-8f10-0039ceb3"
}

备注:

更多返回错误代码请看首页的错误代码描述

获取活动详情

接口：根据活动id获取活动详情

根据活动id获取活动详情

请求URL:

GET/v2/activity-detail/index

参数:

参数名	是否必须	类型	说明
id	是	int	活动ID
app_id	是	string	appId
signed_at	是	string	时间戳
sign	是	string	签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "activity": {
            "id": 43137854,
            "title": "测试订单县骨干",
            "user_id": 21200013,
            "business_account_id": 26600001,
            "sponsor": "微吼直播",
            "start_time": "2021-05-21 00:00:00",
            "real_start_time": "2021-05-20 16:41:27",
            "end_time": "2021-05-20 16:45:37",
            "img_url": "",
            "description": "测试订单想逛",
            "status": "FINISH",
            "view_condition": "NONE",
            "live_room": "lss_657928eb",
            "hd_room": "inav_aa5dabb5",
            "channel_room": "ch_jC0vU5Km",
            "ext_channel_room": "ch_gAAvyG0l",
            "published": "Y",
            "created_at": "2021-05-20 16:40:51",
            "admin_closed": "N",
            "entry_time": 30,
            "is_portrait": "N",
            "is_playback": "N",
            "layout": 1,
            "manual": 2,
            "auth_chat": 2,
            "chat_filter": 2,
            "tags": [
                {
                    "id": 1,
                    "name": "互联网"
                }
            ],
            "valid_status": "N",
            "user_count": 3,
            "appointment_count": 0,
            "sign_count": 0,
            "visit_num": "5",
            "data_finish_time": "2021-05-20 17:00:37",
            "whitelist_status": "N",
            "gift_status": "N",
            "reward_status": "N",
            "global_gift_status": "N",
            "global_reward_status": "N"
        },
        "prepare": [
            {
                "submodule": "BASE",
                "switch": true,
                "desc": null,
                "is_set": null
            },
            {
                "submodule": "APPOINT",
                "switch": false,
                "desc": null,
                "is_set": false
            },
            {
                "submodule": "WARMUP",
                "switch": false,
                "desc": "",
                "is_set": false
            }
        ],
        "brand": [
            {
                "submodule": "TEMPLATE",
                "switch": false,
                "desc": "Y",
                "is_set": false
            },
            {
                "submodule": "LIVE_WATCH",
                "switch": true,
                "desc": "Y",
                "is_set": true
            },
            {
                "submodule": "INVITE_CARD",
                "switch": true,
                "desc": null,
                "is_set": null
            },
            {
                "submodule": "POSTER",
                "switch": true,
                "desc": null,
                "is_set": null
            },
            {
                "submodule": "PAGE_SCRIPT",
                "switch": true,
                "desc": null,
                "is_set": null
            },
            {
                "submodule": "INVITE_CARD",
                "switch": true,
                "desc": null,
                "is_set": null
            }
        ],
        "promote": [
            {
                "submodule": "EXPAND_NOTICE",
                "switch": false,
                "desc": "PLAYBACK",
                "is_set": true
            },
            {
                "submodule": "EXPAND_EMAIL",
                "switch": true,
                "desc": null,
                "is_set": false
            },
            {
                "submodule": "EXPAND_SMS",
                "switch": true,
                "desc": null,
                "is_set": false
            }
        ],
        "record": [
            {
                "submodule": "PLAYBACK",
                "switch": true,
                "desc": null,
                "is_set": false
            }
        ],
        "data": {
            "time": "2021-05-20 17:00:37"
        }
    },
    "request_id": "ff107a75-a3b9-4763-bcd3-db6f4a1c"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

参数名	类型	说明
activity.id	int	课程ID
activity.title	string	活动标题
activity.user_id	int	客户id
activity.business_account_id	int	客户账号id
activity.sponsor	string	主办方
activity.start_time	string	预计开始时间
activity.real_start_time	string	真正开始时间
activity.end_time	string	直播结束时间
activity.img_url	string	活动图片地址
activity.description	string	活动描述
activity.status	string	活动状态
activity.view_condition	string	观看条件NONE: 无限制 INVITATION: 邀请APPOINT: 预约报名
activity.live_room	string	直播房间id
activity.hd_room	string	互动房间id
activity.channel_room	string	聊天频道房间id
activity.ext_channel_room	string	扩展消息频道
activity.published	string	是否发布：Y=>是，N=>否
activity.created_at	string	创建时间
activity.admin_closed	string	是否被后台关闭：Y=>是，N=>否
activity.entry_time	string	预期提前时间：30分钟，默认
activity.whitelist_status	string	白名单状态
activity.is_portrait	string
activity.is_playback	string
activity.layout	int	1.视频直播 2. 文档直播
activity.manual	int	活动报名人工审核开启状态 1.开启 2.关闭
activity.auth_chat	int	聊天人工审核开关1开启 2关闭
activity.chat_filter	int	聊天严禁词过滤状态1开启 2关闭
activity.gift_status	int	礼物开关 1:开启 2:关闭
activity.reward_status	int	打赏开关 1:开启 2:关闭
activity.global_gift_status	int	通用礼物开关 1:开启 2:关闭
activity.global_reward_status	int	通用打赏开关 1:开启 2:关闭
activity.data_finish_time	string	数据计算完成时间
activity.valid_status	string	N
activity.user_count	int	用户总数
activity.appointment_count	int	预约总数
activity.sign_count	int	报名总数
activity.visit_num	int	访问总数
activity.tags	array	活动标签

备注:

更多返回错误代码请看首页的错误代码描述

修改活动基本信息

接口：根据活动id修改活动信息

根据活动id修改活动信息

请求URL:

GET/v2/base-manage/update-activity

参数:

参数名	是否必须	类型	说明
id	是	int	活动ID
app_id	是	string	appId
signed_at	是	string	时间戳
sign	是	string	签名
start_time	是	string	开始时间
img_url	否	string	封面图地址
title	是	string	活动标题
description	否	string	活动简介
sponsor	是	string	主办方
tags	是	string	活动标签
notice	是	string	N=> 否， Y=>是
notice_time	是	string	notice = Y 必须存在
is_playback	是	string	N=> 否， Y=>是是否生成回放，默认不生成回放
is_portrait	是	string	N=> 否， Y=>是是否竖屏直播，默认为横屏
entry_time	是	string	提前入场时间

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": [],
    "request_id": "9b53d5eb-1dfd-4506-b3a4-a643626f"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{ "code": 200, "msg": "", "data": [], "request_id": "9b53d5eb-1dfd-4506-b3a4-a643626f" }

备注:

更多返回错误代码请看首页的错误代码描述

编辑活动的子模块信息

接口：编辑活动子模块信息

编辑活动子模块信息

请求URL:

GET/v2/submodule-manage/edit

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	appId
signed_at	是	string	时间戳
sign	是	string	签名
submodule	是	string	模块名称 APPOINT=>活动报名，POSTER=>开屏海报 WARMUP =>暖场，TEMPLATE=>活动官网，INVITE_CARD=>邀请卡，PAGE_SCRIPT=>页眉页脚，EXPAND_NOTICE =>自动化通知，
enabled	是	string	N=> 关， Y=>开

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": [],
    "request_id": "9b53d5eb-1dfd-4506-b3a4-a643626f"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{ "code": 200, "msg": "", "data": [], "request_id": "9b53d5eb-1dfd-4506-b3a4-a643626f" }

备注:

更多返回错误代码请看首页的错误代码描述

聊天数据汇总统计

接口：聊天数据汇总统计

聊天数据汇总统计

请求URL:

GET/v2/interact/chat-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "msg_total": 0,
        "msg_user": 0,
        "permit_count": 0
    },
    "request_id": "bb2c87e0-c3ee-47bb-8a75-675a90ba"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "msg_total": 0,   //聊天消息总数
        "msg_user": 0,    //聊天用户总数
        "permit_count": 0    //审核通过的消息总数
    },
    "request_id": "bb2c87e0-c3ee-47bb-8a75-675a90ba"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动数据统计数据：分享、点赞、连麦、试看

接口：互动数据统计数据：分享、点赞、连麦、试看

互动数据统计数据：分享、点赞、连麦、试看

请求URL:

GET/v2/data-center/get-hd-big-data

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "info_collect_share_effects": 0,
        "info_collect_on_mike_users": 0,
        "info_collect_share_users": 0,
        "info_collect_admire_users": 0,
        "info_collect_try_see_users": 0,
        "info_collect_share_inviters": 0,
        "info_collect_admire_nums": 0
    },
    "request_id": "995d197d-3949-4cd9-bf14-497dad41"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "info_collect_share_effects": 0,// 分享--有效分享 
        "info_collect_on_mike_users": 0, // 连麦--连麦人数
        "info_collect_share_users": 0,    //分享--分享人数  
        "info_collect_admire_users": 0,    //点赞--点赞人数  
        "info_collect_try_see_users": 0,    //试看--试看人数  
        "info_collect_share_inviters": 0,    //分享--邀请人数
        "info_collect_admire_nums": 0       //点赞--点赞次数 
    },
    "request_id": "995d197d-3949-4cd9-bf14-497dad41"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具-----问卷统计

接口：互动工具-----问卷统计

互动工具-----问卷统计

请求URL:

GET/v2/interact/naire-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "push_nums": 0,
        "answer_nums": 0
    },
    "request_id": "c78b350a-0e34-4d1a-827c-58288b8f"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "push_nums": 0,   //推送次数
        "answer_nums": 0   //回答次数
    },
    "request_id": "c78b350a-0e34-4d1a-827c-58288b8f"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具-----红包统计

接口：互动工具-----红包统计

互动工具-----红包统计

请求URL:

GET/v2/interact/red-packet

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "joined_user_count": 0,
        "get_user_count": 0,
        "get_amount": 0,
        "push_count": 0,
        "push_amount": 0
    },
    "request_id": "61dc7566-b054-424a-9f7a-c834bdc6"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "joined_user_count": 0,  // 参与人数
        "get_user_count": 0,      //领取人数
        "get_amount": 0,          //领取总金额 
        "push_count": 0,          // 推送次数
        "push_amount": 0          //推送总金额
    },
    "request_id": "61dc7566-b054-424a-9f7a-c834bdc6"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------商品统计

接口：互动工具------商品统计

互动工具------商品统计

请求URL:

GET/v2/interact/goods-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "goods": "1/1",  //上架总数/商品总数
        "pv": 0,         //点击次数
        "buy": "1",      //购买次数
        "push": 0        //推送次数
    },
    "request_id": "16265792-192b-47c3-a7fb-3b796294"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "goods": "1/1",  //上架总数/商品总数
        "pv": 0,         //点击次数
        "buy": "1",      //购买次数
        "push": 0        //推送次数
    },
    "request_id": "16265792-192b-47c3-a7fb-3b796294"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------推荐卡统计

接口：互动工具------推荐卡统计

互动工具------推荐卡统计

请求URL:

GET/v2/interact/recommend-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "push_num": 0,
        "view_num": 0,
        "visit_num": 0
    },
    "request_id": "941d39fc-b9ee-4db2-92d3-14baac27"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "push_num": 0,   //推送次数
        "view_num": 0,    // 访问人数
        "visit_num": 0    //点击次数
    },
    "request_id": "941d39fc-b9ee-4db2-92d3-14baac27"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------邀请卡统计

接口：互动工具------邀请卡统计

互动工具------邀请卡统计

请求URL:

GET/v2/interact/inviter-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "invite_users": 0,
        "sign_up_users": 0,
        "subscribe_users": 0,
        "watch_users": 0
    },
    "request_id": "5aba551f-fbc5-41b5-abcb-34d116ae"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "invite_users": 0,   //邀请人数 
        "sign_up_users": 0,  //报名数
        "subscribe_users": 0,   //预约人数  
        "watch_users": 0     //观看人数
    },
    "request_id": "5aba551f-fbc5-41b5-abcb-34d116ae"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------排行榜统计

接口：互动工具------排行榜统计

互动工具------排行榜统计

请求URL:

GET/v2/interact/rank-list-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "buyer": "0.01",
        "invite": 0,
        "share": 0,
        "watch": 1,
        "gift": 0,
        "reward": 0
    },
    "request_id": "26c2fd65-fef5-458b-84e4-a2a3c604"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "buyer": "0.01",   //土豪榜统计（金额）
        "invite": 0,       //邀请榜统计（总人数）
        "share": 0,        //分享榜（总人数）
        "watch": 1,        //观看榜（总人数）
        "gift": 0,         //礼物榜（总金额）
        "reward": 0        //打赏榜（总金额）
    },
    "request_id": "26c2fd65-fef5-458b-84e4-a2a3c604"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------问答统计

接口：互动工具------问答统计

互动工具------问答统计

请求URL:

GET/v2/interact/question-stat

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
app_id	是	string	用户的appId
signed_at	是	int	时间戳
sign	是	string	计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "question_stat": 0,
        "answer_stat": 0
    },
    "request_id": "61b09ef1-24da-43ec-9646-2214e693"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

返回数据如下：

{
    "code": 200,
    "msg": "",
    "data": {
        "question_stat": 0,    //问题总数
        "answer_stat": 0        //回答总数
    },
    "request_id": "61b09ef1-24da-43ec-9646-2214e693"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------抽奖统计

接口：互动工具------抽奖统计

互动工具------抽奖统计

请求URL:

GET/v2/interact/lottery-stat

参数:

参数名	是否必须	类型	说明
sign	是	string	签名
signed_at	是	string	时间戳
app_id	是	string	appId
activity_id	是	string	互动id

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data[push_count]	int	推送次数
data[join_count]	int	参数次数
data[count]	int	总数
request_id	string

请求结果示例:

{
    "code": 200,
    "msg": "",
    "data": {
        "push_count": 0,
        "join_count": 0,
        "count": 0
    },
    "request_id": "d6f2247f-2888-420f-ba2e-758e1b07"
}

备注:

更多返回错误代码请看首页的错误代码描述

互动工具------问答列表

接口：互动工具------问答列表

互动工具------问答列表

请求URL:

GET/v2/interact/question-stat-list

参数:

参数名	是否必须	说明
sign	是	签名
activity_id	是	活动id
curr_page	是	当前页
page_size	是	每页大小
app_id	是	appId
signed_at	是	时间戳

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data	object	数据对象
data[total_page]	int
data[curr_page]	string
data[total]	int
data[page_size]	string
data[list]	array	数据数组
data[list][avatar]	string
data[list][content]	object	数据对象
data[list][content][txt]	string
data[list][status]	int
data[list][operator]	string
data[list][top]	int
data[list][ext]	string
data[list][bu]	int
data[list][answers]	array	数据数组
data[list][answers][id]	int
data[list][answers][avatar]	string
data[list][answers][content]	object	数据对象
data[list][answers][content][txt]	string
data[list][answers][content][img_list]	array	数据数组
data[list][answers][status]	int
data[list][answers][type]	int
data[list][answers][role]	int
data[list][answers][bu]	int
data[list][answers][ext]	null
data[list][answers][children]	array	数据数组
data[list][answers][ques_id]	int
data[list][answers][parent_id]	int
data[list][answers][nick_name]	string
data[list][answers][app_id]	string
data[list][answers][webinar_id]	string
data[list][answers][is_open]	int
data[list][answers][join_id]	int
data[list][answers][is_backout]	int
data[list][answers][favored_count]	int
data[list][answers][created_at]	string
data[list][answers][updated_at]	string
data[list][answers][deleted_at]	null
data[list][id]	int
data[list][app_id]	string
data[list][user_id]	int
data[list][is_open]	int
data[list][nick_name]	string
data[list][webinar_id]	string
data[list][care_count]	int
data[list][answer_count]	int
data[list][same_count]	int
data[list][is_show]	int
data[list][operate_time]	string
data[list][created_at]	string
data[list][updated_at]	string
data[list][deleted_at]	null
data[list][is_quality]	int
request_id	string

请求结果示例:


{
    "code": 200,
    "msg": "",
    "data": {
        "total_page": 1,
        "curr_page": "1",
        "total": 1,
        "page_size": "10",
        "list": [
            {
                "avatar": "mp-test/d0/1f/d01f89642653872da0e0c7802c6cbe6b.png",
                "content": {
                    "txt": "231432411234"
                },
                "status": 3,
                "operator": "",
                "top": 0,
                "ext": "15801678947",
                "bu": 5,
                "answers": [
                    {
                        "id": 82347,
                        "avatar": "mp-dev/6c/cf/6ccfde984fe2fe0ab0ee026db7c11caa.png",
                        "content": {
                            "txt": "地方撒撒的发水淀粉",
                            "img_list": []
                        },
                        "status": 0,
                        "type": 0,
                        "role": 0,
                        "bu": 5,
                        "ext": null,
                        "children": [],
                        "ques_id": 84972,
                        "parent_id": 0,
                        "nick_name": "微吼直播",
                        "app_id": "02391153",
                        "webinar_id": "43137854",
                        "is_open": 1,
                        "join_id": 124080,
                        "is_backout": 0,
                        "favored_count": 0,
                        "created_at": "2021-05-26 17:45:33",
                        "updated_at": "2021-05-26 17:45:33",
                        "deleted_at": null
                    }
                ],
                "id": 84972,
                "app_id": "02391153",
                "user_id": 91900002,
                "is_open": 0,
                "nick_name": "sadfasdf",
                "webinar_id": "43137854",
                "care_count": 0,
                "answer_count": 1,
                "same_count": 0,
                "is_show": 0,
                "operate_time": "2021-05-26 17:45:25",
                "created_at": "2021-05-26 17:45:25",
                "updated_at": "2021-05-26 17:45:33",
                "deleted_at": null,
                "is_quality": 0
            }
        ]
    },
    "request_id": "f11b9ff6-622b-4028-8415-3aefa60d"
}

备注:

更多返回错误代码请看首页的错误代码描述

知客后台手动报名活动

接口：知客后台手动报名活动

知客后台手动报名活动

请求URL:

GET/v2/activity-detail/manual-enroll

参数:

参数名	是否必须	说明
activity_id	是	活动ID
enroll_string	是	手动报名的json数据
app_id	是	appId
signed_at	是	时间戳
sign	是	签名

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data	object	数据对象
data[success]	int	报名成功数
data[sum]	int	总数
data[repeat]	int	重复数据数
request_id	string

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

用户体系->活动报名列表

接口：用户体系->活动报名列表

用户体系->活动报名列表

请求URL:

GET/v2/data-center/enroll-list

参数:

参数名	是否必须	说明
app_id	是	appId
signed_at	是	时间戳
sign	是	签名
activity_id	是	活动ID
fuzzy_search	否	搜索的关键字
type	是	类型 2
is_watch	是	0.全部 1是 2否
is_join	是	0.全部 1是 2否
page	是	当前页
page_size	是	每页大小

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[total]	int
data[page]	string
data[page_size]	string
data[list]	array	数据数组
data[list][activity_consumer_uid]	string	参加B端用户活动的C端用户ID（主键）
data[list][activity_id]	int	活动ID
data[list][business_consumer_uid]	int	B端用户的C端用户ID
data[list][consumer_uid]	Array	C端用户ID
data[list][account_id]	int	微吼注册用户ID
data[list][third_user_id]	null	第三方用户id
data[list][username]	string	账号名称
data[list][real_name]	string	姓名
data[list][source]	string	渠道来源[ IMPORT、PC、MOBILE ]
data[list][business_uid]	int	所属B端企业ID
data[list][phone]	string	手机号
data[list][avatar]	string	头像
data[list][email]	string	邮箱
data[list][sex]	string	性别
data[list][market_channel]	null	最初渠道
data[list][wx_qrcode]	null	微信二维码
data[list][is_new]	int	新用户 1 老用户 0
data[list][bu]	int	业务线 0:saas 5:zhike
data[list][channel]	string	活动最初渠道 (integer) 10002:主渠道 0:邮件 1:微信 2:短信其它数字:自定义渠道
data[list][first_join]	string	首次参会时间毫秒
data[list][sign_up_time]	Array	报名时间毫秒
data[list][sign_up_phone]	null	报名手机号
data[list][appointment_time]	Array	预约时间毫秒
data[list][appointment_phone]	null	预约手机号
data[list][is_subscribe]	null	是否有预约 0：没有 1：有
data[list][is_sign_up]	null	是否有报名 0：没有 1：有
data[list][deleted]	int	是否删除 0否 1是
data[list][updated_at]	string	更新时间毫秒
data[list][area]	null	地区
data[list][browser]	null	浏览器
data[list][chat_pv]	null	参与聊天的次数
data[list][city]	null	城市
data[list][country]	null	国家
data[list][created_at]	string	创建日期毫秒
data[list][deleted_at]	null	删除日期毫秒
data[list][device]	null	观看设备 3:手机 7:电脑
data[list][in_and_out_nums]	null	进出次数
data[list][invite_nums]	null	邀请卡 -邀请他人的人头数
data[list][ip]	null	用户的ip
data[list][is_admire]	null	是否参与点赞 0：没有 1：有 (boolean)
data[list][is_draw_lottery]	null	是否参与抽奖 0：没有 1：有 (boolean)
data[list][is_email_click]	null	邮件渠道是否有点击 (boolean) 0：没有 1：有
data[list][is_email_watch]	null	邮件渠道是否有观看 (boolean) 0：没有 1：有
data[list][is_gift]	null	是否参与礼物 0：没有 1：有 (boolean)
data[list][is_goods]	null	是否参与商品 0：没有 1：有 (boolean)
data[list][is_note_click]	null	短信渠道是否有点击 (boolean) 0：没有 1：有
data[list][is_note_watch]	null	短信渠道是否有观看 (boolean) 0：没有 1：有
data[list][is_on_mike]	null	是否参与连麦 0：没有 1：有 (boolean)
data[list][is_questionnaire]	null	是否参与问卷 0：没有 1：有 (boolean)
data[list][is_questions_answers]	null	是否参与问答 0：没有 1：有 (boolean)
data[list][is_recommend_card]	null	是否参与推荐卡片 0：没有 1：有 (boolean)
data[list][is_red]	null	是否参与红包 0：没有 1：有 (boolean)
data[list][is_reward]	null	是否参与打赏 0：没有 1：有 (boolean)
data[list][is_sign_in]	null	是否参与签到 0：没有 1：有 (boolean)
data[list][is_sign_up_after]	null	是否在开播后报名 (boolean) 0：没有 1：有
data[list][is_sign_up_before]	null	是否在开播前报名 (boolean) 0：没有 1：有
data[list][is_subscribe_for_email]	null	是否订阅了邮箱
data[list][is_try_see]	null	是否参与试看 0：没有 1：有 (boolean)
data[list][is_watch]	null	是否有观看 (boolean) 0：没有 1：有
data[list][is_weChat_click]	null	微信渠道是否有点击 (boolean) 0：没有 1：有
data[list][is_weChat_watch]	null	微信渠道是否有观看 (boolean) 0：没有 1：有
data[list][laster_join]	null	最后离开时间毫秒
data[list][live_pv]	null	单个用户观看直播的次数 (integer)
data[list][live_tt]	null	单个用户观看直播的总时长 (integer) 单位/秒
data[list][real_live_tt]	null
data[list][os]	null	操作系统
data[list][pf]	null	观看平台
data[list][province]	null	省份
data[list][score]	null	用户本场活动得分
data[list][share_invited_uv]	null	分享时-被他人邀请的人头数
data[list][share_inviter_uv]	null	分享时-邀请他人的人头数
data[list][vod_pv]	null	单个用户观看回放的次数
data[list][vod_tt]	null	单个用户观看回放的总时长单位/秒
data[list][real_vod_tt]	null
data[list][watch_date]	null	观看的时间格式:yyyy-MM-dd HH:mm:ss
data[list][watch_page_pv]	null	活动观看页的访问次数
data[list][website_pv]	null	活动官网的访问次数
data[list][website_tt]	null	活动官网的总停留时长
data[list][visitor_id]	string
data[list][remark]	string	备注
data[list][user_level]	null	用户级别 1 优质用户 2 潜在用户 3 一般用户 4 流失用户 0 没有评级（默认）
data[list][company]	string	公司
data[list][position]	string	职位
data[list][role]	int	角色id: 0为观众，1为主持，2为助理 (默认是0)
data[list][auth_status]	int
data[list][apply_status]	int
data[list][wx_open_id]	null	公众平台OPENID
data[list][channel_name]	string	渠道名称
data[list][nick_name]	string	昵称
data[list][address]	string	地址
data[list][id]	int	ID
data[list][consumer_user_id]	int	C端用户ID
data[list][businessUserId]	int	b端用户的ID
data[list][question_id]	int	问题ID
data[list][type]	string
data[list][mobile]	string	手机号
data[list][qrcode]	null	二维码
data[list][channel_id]	null	渠道ID
data[list][is_join]	int
data[list][nickname]	string	昵称
data[list][method]	int	1.活动报名 2.后台导入

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

活动下添加白名单

接口：活动下添加白名单

活动下添加白名单

请求URL:

GET/v2/whitelist/add-whitelist

参数:

参数名	是否必须	说明
app_id	是	appId
signed_at	是	时间戳
sign	是	签名
activity_id	是	活动ID
whitelist_notice	是	活动的提示
group_id	是	白名单的分组列表，json结构
msg_status	是	Y : 开启 N : 关闭
check_method	是	1.引入 2.导入

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data	null
request_id	string

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

直播数据管理

直播数据相关接口

获取活动计算数据

接口：获取活动计算数据接口

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

请求URL:

GET/activity/activity-lists

参数:

参数名	是否必须	类型	说明
activityId	是	int	活动ID

返回示例:

正确时返回:

    { 
		"code": 200,
		"msg": null, 
		"data": {
			"joinUserValue": 100, //参与用户 
			"viewerCount": 1000, //观众总数 
			"watchTimeValue": 86400, //人居观看时长 
			"spreadRatio": 6.8, //分享效果指数
			"interactintRatio": 7, //互动效果指数 
			"behaviorRatio": 9, //用户行为得分 
			"activity_id": 46536048 //活动 id 
		} 
	}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回数据如下：

参数名	类型	说明
joinUserValue	int	参与用户
viewerCount	int	观众总数
watchTimeValue	int	人均观看时长
spreadRatio	float	分享效果指数
interactintRatio	float	互动效果指数
behaviorRatio	float	用户行为得分
activity_id	int	活动 id

备注:

更多返回错误代码请看首页的错误代码描述

用户管理

用户相关接口文档

获取活动下的用户数据

接口：获取活动下的用户数据接口

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

请求URL:

GET/activity/user-lists

参数:

参数名	是否必须	类型	说明
page	是	int	当前页
pageSize	是	int	每页大小<=100
activityId	是	int	活动ID

返回示例:

正确时返回:

   { 
   		"code": 200, 
		"msg": null, 
		"data": { 
			"list": [ 
            {
                "userId": "101702036",
                "realName": "real",
                "nickName": null,
                "avatar": "mp-test/4b/11/4b117c2aad07e8a63569dec5809f2462.png",
                "phone": "18510781799",
                "email": null,
                "company": null,
                "position": null,
                "sex": "M",
                "city": "北京",
                "comment": null,
                "appointmentTime": null,
                "signUpTime": "",
                "firstJoinAt": "2021-03-03 14:45:52",
                "openId": null,
                "userSource": "PC",
                "watchLiveTime": null,
                "srcIp": "111.201.244.77",
                "liveTime": 16068,
                "vodTime": 2499,
                "inviterEmail": null,
                "inviterPhone": null,
                "inviterName": null
            },
	}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回数据如下：

参数名	类型	说明
userId	int	用户ID
realName	string	真实姓名
phone	string	手机号
email	string	邮箱
company	string	公司名称
position	string	职位
sex	string	性别
city	string	城市
comment	string	备注
appointmentTime	string	预约时间
signUpTime	string	首次登录时间
firstJoinAt	string	首次访问时间
openId	string	微信openid信息
userSource	string	用户来源
srcIp	string	来源ip
liveTime	int	直播观看时长(单位：秒)
vodTime	int	回放观看时长(单位：秒)
inviterEmail	string	邀请人邮箱
inviterPhone	string	邀请人手机号
inviterName	string	邀请人

备注:

更多返回错误代码请看首页的错误代码描述

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

接口：获取直播活动下的用户计算数据接口

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

请求URL:

GET/activity/user-calculate

参数:

参数名	是否必须	类型	说明
page	是	int	当前页
pageSize	是	int	每页大小<=100
activityId	是	int	活动ID

返回示例:

正确时返回:

	{ 
		"code": 200, 
		"msg": null, 
		"data": { 
			"list": [
				{ 
					"userId": "100",
					"source": "百度渠道", //渠道来源 
					"behaviorRatio": "0.8", //行为得分
					"recvNum": "300", //提交问卷次数 
					"getNum": "400", //领取红包金额 
					"merchandiseBrowse": "30", //浏览商品次数 
					"clicks": "20" //点击推荐卡片次数 
					"activityId":89909009 //活动ID 
					"liveTt":2000 //用户直播观看时长（秒）
				} 
			],
			"page": 1, //当前页 
			"pageSize": 10, //每页大小 
			"total": 100 //数据总数 
		} 
	}

返回数据如下：

参数名	类型	说明
userId	int	用户ID
source	string	渠道来源
behaviorRatio	float	行为得分
recvNum	string	提交问卷次数
getNum	string	领取红包金额
merchandiseBrowse	string	浏览商品次数
clicks	string	点击推荐卡片次数
activityId	int	活动 id
liveTt	int	用户直播观看时长(秒)

备注:

更多返回错误代码请看首页的错误代码描述

用户详情

接口：用户详情

用户详情

请求URL:

POST/v2/customer/detail

参数:

参数名	是否必须	说明
business_consumer_uid	是	用户id
signed_at	是	签名时间戳
app_id	是	应用ID
sign	是	签名值

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[business_consumer_uid]	string	b下c用户id
data[consumer_uid]	string	用户id
data[account_id]	int	用户帐号id
data[username]	string	用户名
data[business_uid]	int	企业用户id
data[phone]	string	手机号
data[avatar]	null	头像
data[real_name]	string	真实姓名
data[nickname]	string	昵称
data[email]	null	邮箱
data[industry]	null	行业
data[position]	null	职位
data[company]	string	公司
data[user_identifier]	null
data[sex]	null	性别
data[education_level]	null	教育水平
data[birthday]	null	生日
data[remark]	null	备注
data[is_activated]	string
data[source]	string	来源
data[import_date]	null
data[src_ip]	string
data[country]	null	国家
data[province]	null	省
data[city]	null	市
data[area]	string	区
data[first_visited_at]	string	第一次参加活动时间
data[last_visited_at]	string	最后一次直播访问时间
data[join_count]	int	参加场次
data[chat_count]	int	聊天频次
data[share_count]	int	分享次数
data[invite_friends_count]	int	邀请次数
data[sign_up_count]	int	报名次数
data[watch_live_time]	int	直播观看时长
data[watch_replay_time]	int	回放观看时长
data[watch_replay_count]	int	回放观看次数
data[attention_goods_count]	null
data[user_level]	int	用户分级
data[system_tags_array]	array	系统标签
data[custom_tags_array]	null	自定义标签
data[group_ids_array]	array	分组标签
data[activity_id_array]	array	参加活动id
data[wx_union_id]	null
data[wx_qr_open_id]	null
data[wx_open_id]	null
data[address]	null	地址
data[buser_custom_field_object]	null
data[bu]	int
data[channel]	string	渠道
data[channel_activity_id]	string	渠道来源活动
data[deleted]	int	删除时间
data[created_at]	string	创建时间
data[updated_at]	string	更新时间
data[wechat_list]	null
data[visitor_id]	string	游客id
data[role]	int	角色
data[first_channel]	object	数据对象
data[first_channel][date]	string
data[first_channel][active_name]	string
data[first_channel][channel_name]	string
data[selffield]	array	用户自定义字段
data[selffield][id]	int
data[selffield][name]	string
data[selffield][fieldName]	string
data[selffield][fieldDesc]	string	描述
data[selffield][type]	int
data[selffield][value]	null
data[selffield][data]	Array

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

活动-足迹

接口：活动-足迹

活动-足迹

请求URL:

POST/user/customer/behavior-list-one

参数:

参数名	是否必须	说明
business_consumer_uid	是	b下c用户id
page	是	页码
page_size	是	页数
activity_id	是	活动id
app_id	是	应用id
sign	是	签名
signed_at	是

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[total]	int
data[page]	int
data[list]	array	数据数组
data[list][consumer_uid]	string	用户id
data[list][activity_id]	int	活动id
data[list][business_uid]	int	企业用户id
data[list][type]	string
data[list][join_time]	string	参加时间
data[list][data]	object	数据对象
data[list][data][activity_title]	string	活动名称
data[list][data][data]	string
data[page_size]	int

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

活动列表-足迹

接口：活动列-足迹

活动列-足迹

请求URL:

POST/user/customer/behavior-list

参数:

参数名	是否必须	说明
business_consumer_uid	是	b下c用户id
page	是	页码
page_size	是	页数
app_id	是	应用id
sign	是	签名
signed_at	是

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[total]	int
data[page]	int
data[list]	array	数据数组
data[list][consumer_uid]	string
data[list][activity_id]	Array
data[list][business_uid]	int
data[list][source_channel]	string
data[list][join_time]	string
data[list][data]	object	数据对象
data[list][data][activity_title]	string
data[list][type]	string
data[list][bu]	int
data[list][channel_id]	null
data[page_size]	int

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

报名问卷列表

接口：报名问卷列表

报名问卷列表

请求URL:

POST/user/customer/survey-list

参数:

参数名	是否必须	说明
business_consumer_uid	是
page	是
page_size	是
app_id	是
sign	是
signed_at	是

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int	状态码
msg	null	状态信息描述
data	object	数据对象
data[total]	int	总数
data[page]	int	页码
data[list]	array	数据数组
data[list][consumer_uid]	string	c端用户id
data[list][activity_id]	Array	活动id
data[list][business_uid]	int	企业用户id
data[list][source_channel]	string	来源
data[list][join_time]	string	参会时间
data[list][data]	object	数据对象
data[list][data][activity_title]	string	活动名称
data[list][type]	string
data[list][bu]	int
data[list][channel_id]	null
data[page_size]	int	页数

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

用户池列表

接口：用户池列表

用户池列表

请求URL:

POST/user/customer/lists

参数:

参数名	是否必须	说明
fuzzy_search	是	昵称，手机号等模糊搜索
first_visited_at_start	是	首次参会开始时间
first_visited_at_end	是	首次参会结束时间
last_visited_at_start	是	末次参会开始时间
last_visited_at_end	是	末次参会结束时间
sex	是	M	W	UNKNOWN
province	是	省
city	是	市
wechatlist	是
industry	是	行业
source	是	来源
activity_id_array	是	参会id
system_tags_array	是	智能标签
group_ids_array	是	分组标签
page	是	页码
page_size	是	页数
custom_tags_array	是	自定义标签
user_level	是	用户水平
join_count	是	C端用户参与活动的次数
should_activity_id_array	是
should_system_tags_array	是
should_group_ids_array	是
should_custom_tags_array	是
not_activity_id_array	是
not_system_tags_array	是
not_group_ids_array	是
not_custom_tags_array	是
nonempty_filed	是	过滤字段不为空的数据
identitty	是
app_id	是	应用id
sign	是	签名
signed_at	是	签名时间戳

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[total]	int
data[page]	int
data[list]	array	数据数组
data[list][business_consumer_uid]	string
data[list][consumer_uid]	string
data[list][account_id]	Array
data[list][username]	Array
data[list][business_uid]	int
data[list][phone]	string
data[list][avatar]	null
data[list][real_name]	Array
data[list][nickname]	string
data[list][email]	Array
data[list][industry]	null
data[list][position]	Array
data[list][company]	Array
data[list][user_identifier]	null
data[list][sex]	string
data[list][education_level]	Array
data[list][birthday]	null
data[list][remark]	Array
data[list][is_activated]	string
data[list][source]	string
data[list][import_date]	null
data[list][src_ip]	Array
data[list][country]	null
data[list][province]	null
data[list][city]	null
data[list][area]	string
data[list][first_visited_at]	Array
data[list][last_visited_at]	Array
data[list][join_count]	int
data[list][chat_count]	int
data[list][share_count]	int
data[list][invite_friends_count]	int
data[list][sign_up_count]	int
data[list][watch_live_time]	int
data[list][watch_replay_time]	int
data[list][watch_replay_count]	int
data[list][attention_goods_count]	null
data[list][user_level]	int
data[list][system_tags_array]	array	数据数组
data[list][custom_tags_array]	null
data[list][group_ids_array]	array	数据数组
data[list][activity_id_array]	Array
data[list][wx_union_id]	null
data[list][wx_qr_open_id]	null
data[list][wx_open_id]	Array
data[list][address]	string
data[list][buser_custom_field_object]	null
data[list][bu]	int
data[list][channel]	Array
data[list][channel_activity_id]	Array
data[list][deleted]	int
data[list][created_at]	string
data[list][updated_at]	string
data[list][wechat_list]	null
data[list][visitor_id]	string
data[list][role]	int
data[list][identity]	int
data[list][consumer_user_id]	string
data[page_size]	int

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

批量删除用户

接口：批量删除用户

批量删除用户

请求URL:

POST/v2/customer/bath-delete

参数:

参数名	是否必须	说明
business_consumer_uids	是	B端用户的C端用户ID，多个以半角逗号‘,’分割
action_type	是	操作类型

SEARCH 选中所有，包括其他页，当选中此项，将用户列表的搜索选项传入 CHECK 选中数据 | | app_id | 是 | | | sign | 是 | | | signed_at | 是 | |

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	boolean

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

用户趋势图

接口：用户趋势图

用户趋势图

请求URL:

POST/v2/customer/level-trend

参数:

参数名	是否必须	说明
start_time	是

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[x_axis]	array	日期
data[list]	array	数据数组
data[list][data]	array	详细数据
data[list][name]	string	数据名

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

更新用户信息

接口：更新用户信息

更新用户信息

请求URL:

POST/v2/customer/update

参数:

参数名	是否必须	说明
business_consumer_uid	是	B端用户的C端用户ID
birthday	是	出生年月
industry	是	行业
position	是	职位
education_level	是	教育水平
remark	是	备注
email	是	邮箱
address	是	地址

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

获取用户数量

接口：获取用户数

获取用户数

请求URL:

POST/v2/customer/get-num

参数:

参数名	是否必须	说明

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	boolean

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

用户群组标签

接口：用户群组标签

用户群组标签

请求URL:

POST/user/customer/consumer-group-tag

参数:

参数名	是否必须	说明
consumer_uid	是

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[group_list]	array	用户所属分组列表
data[group_list][bu]	int
data[group_list][group_id]	int	分组id
data[group_list][system_type]	int
data[group_list][business_uid]	int	B用户id
data[group_list][describe]	string	描述
data[group_list][type]	int	分组类型：1 为系统分组 2 为固定分组 3 为智能分组
data[group_list][title]	string	分组名
data[tag_list]	array	数据数组
data[tag_list][tag_name]	string	标签名
data[tag_list][tag_type]	string	标签类型：1.系统标签，2.自定义标签
data[tag_list][tag_id]	string	标签id
data[custom_tag_list]	array	数据数组
data[custom_tag_list][bu]	int
data[custom_tag_list][tag_name]	string	标签名
data[custom_tag_list][tag_type]	int	标签类型：1.系统标签，2.自定义标签
data[custom_tag_list][tag_id]	int	标签id
data[custom_tag_list][business_uid]	int

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

更新用户姓名

接口：更新用户姓名

更新用户姓名

请求URL:

POST/v2/customer/update-real-name

参数:

参数名	是否必须	说明
consumer_uid	是	C端用户id 和游客id 必传1个
visitor_id	是	游客id 和C端用户id 必传1个
real_name	是	姓名
business_consumer_uid	是	B端用户的C端用户ID

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	boolean

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

C端授权登录

身份授权相关接口

通过账号密码获取授权token

接口：通过账号密码获取授权token

通过账号密码自动注册登录活动，成功后返回token

调用流程

请求URL:

GET/api/v1/user/auto-login-by-account

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
username	是	string	账号。注册时，账号已经注册会报错，需要调用方保障账号唯一
password	否	string	密码。传此参数代表登录。不传此参数，会进行注册，注册成功后会返回password，需要调用方记录，下次登录时使用
nickname	否	string	昵称
wx_open_id	否	string	微信open_id
avatar	否	string	头像地址 url

返回示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "token": "e6a670c65c6dde1aeb594c9e1c32be0f",
        "password": "1e6a67",
        "user_id": 101436531,
    }
}

返回参数说明:

参数名	类型	说明
code	int	状态码
msg	int	状态信息
data	null	返回数据
token	string	授权的token值
password	string	当请求参数password为空的时候，会返回此参数
user_id	int	用户user_id

错误时返回:

{
    "code": 500,
    "msg": "invalid appid"
}

备注:

code	信息
800090	手机号自动授权失败

网页授权接口

接口：网页授权接口

网页授权接口

请求URL:

当使用移动端的活动时使用:

GET:https://zhike.vhall.com/m/auth/:token?&success_back=success_url&error_back=error_url

当使用PC端的活动时使用:

GET:https://zhike.vhall.com/webinar/auth/:token?&success_back=success_url&error_back=error_url

参数:

参数名	是否必须	类型	说明
token	是	String	验证签名
success_back	否	String	验证成功之后要跳转的url,需前端对url进行decodeURIComponent()
error_back	否	String	验证失败之后要跳转的url,需前端对url进行decodeURIComponent()

返回示例:

success_back和error_back必填。验证成功之后要跳转到success_url, 验证失败之后要跳转到error_url

window.addEventListener('message', function(event){
   let msg = JSON.parse(event.data)
}, false);

获取结果，自行处理。如：改变iframe的url地址跳转到自己指定url

/* iframe使用样例 */
<iframe 
   allow="camera *;microphone *;" 
   allowfullscreen="true" border="0" 
   src="https://zhike.vhall.com/m/auth/:token?success_back=success_url&error_back=error_url"
   width="800" height="600"></iframe>

正确时返回:

http 302

错误时返回:

http 302

返回参数说明:

无

备注:

直接使用链接做授权登录在转跳到相应活动后，系统可以根据用户设备自动跳转到移动端。而在使用嵌入时无法识别用户设备，不能自动跳转
当页面嵌入时，关闭页面后需要取消自动登录状态
更多返回错误代码请看首页的错误代码描述

通过手机号获取授权token

接口：通过手机号获取授权token

通过手机号和活动自动注册登录活动

请求URL:

GET/api/v1/user/auto-login

调用流程：

参数:

参数名	是否必须	类型	说明
activity_id	是	int	活动ID
mobile	是	int	手机号
nickname	否	string	昵称
wx_open_id	否	string	微信open_id
avatar	否	string	头像地址 url

返回示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "token": "e6a670c65c6dde1aeb594c9e1c32be0f"
    }
}

错误时返回:

{
    "code": 500,
    "msg": "invalid appid"
}

返回参数说明:

参数名	类型	说明
code	int	状态码
msg	int	状态信息
data	null	返回数据
token	string	授权的token值

备注:

code	信息
800090	手机号自动授权失败

物料管理

文档管理
奖品管理

新建文档

接口：新建文档

新建文档

请求URL:

POST/v2/activity-doc/create-doc

参数:

参数名	是否必须	说明
name	是	文档名称
oss_file	是	文档地址(域名加路径)

返回参数说明:

返回数据如下：

参数名	类型	说明
msg	string	状态信息
data	object	数据对象
data[business_user_id]	string	用户ID
data[doc_id]	string	文档ID
data[name]	string	文档名称
data[page_num]	string	文档页数
data[transfer]	string	转换状态 0：等待上传 1：等待转换 2：转换中 3：转换成功 4：转换失败
data[yun_id]	string	微吼云文档id
data[type]	string	文档类型
data[live_time]	string	文档最近演示时间
data[oss_file]	string	文档下载地址
data[created_at]	string	创建时间
data[updated_at]	string	最后更新时间
code	int	状态码

请求结果示例:

正确时返回:


{
    "code": 200,
    "msg": null,
    "data": {
        "name": "1619581519072.jpg",
        "created_at": "2021-05-27 02:27:47",
        "page_num": 0,
        "transfer": 1,
        "status": 1,
        "operator": 23300083,
        "business_user_id": 23300083,
        "yun_id": "973ae622",
        "doc_url": "",
        "url_expire": "",
        "oss_file": "https://test-zhike.oss-cn-beijing.aliyuncs.com/mp-test/62/4b/624bb0783449ef9a6a1dfed406109208a.jpg",
        "type": "jpg",
        "updated_at": "2021-05-27 02:27:47",
        "doc_id": 330
    }
}

失败时返回:

{
    "code": 201,
    "msg": "name 不能为空。",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

文档列表

接口：文档列表

文档列表

请求URL:

GET/v2/activity-doc/business-doc-list

参数:

参数名	是否必须	说明
name	否	文档名称
page	是	页码
page_size	是	每页展示多少条
activity_id	是	活动ID
show_fail	否	是否显示转换失败的数据 1.显示 2.不显示默认为2

返回参数说明:

返回数据如下：

参数名	类型	说明
msg	string	状态信息
data	object	数据对象
data[total]	int	数据总数
data[total_page]	int	总页数
data[curr_page]	int	当前页
data[page_size]	int	每页展示数据
data[list]	array	数据数组
data[list][doc_id]	string	文档ID
data[list][name]	string	文档名称
data[list][page_num]	string	文档页数
data[list][transfer]	string	转换状态 0：等待上传 1：等待转换 2：转换中 3：转换成功 4：转换失败
data[list][yun_id]	string	微吼云文档id
data[list][type]	string	文档类型
data[list][live_time]	string	文档最近演示时间
data[list][oss_file]	string	文档下载地址
data[list][created_at]	string	创建时间
data[list][updated_at]	string	最后更新时间
code	int	状态码

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":null,
    "data":{
        "total":1,
        "total_page":1,
        "curr_page":"1",
        "page_size":"10",
        "list":[
            {
                "doc_id":324,
                "name":"test.jpg",
                "page_num":1,
                "transfer":3,
                "doc_url":"",
                "yun_id":"fefba423",
                "type":"jpg",
                "live_time":"",
                "oss_file":"https:\/\/test-zhike.oss-cn-beijing.aliyuncs.com\/mp-test\/62\/4b\/624bb0783449ef9a6a1dfed406109208a.jpg",
                "created_at":"2021-05-26 14:14:44",
                "updated_at":"2021-05-26 14:14:44",
                "deleted_at":null
            }
        ]
    }
}

备注:

更多返回错误代码请看首页的错误代码描述

文档批量删除

接口：文档批量删除

文档批量删除

请求URL:

POST/v2/activity-doc/del-doc

参数:

参数名	是否必须	说明
name	否	名称模糊删除
ids	否	id删除多个id用英文逗号隔开
type	是	all：删除全部 ids：按id删除

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int	状态码
msg	string	状态信息
data	int	删除成功个数

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":null,
    "data":2
}

失败时返回:

{
    "code": 201,
    "msg": "参数错误",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

奖品列表

接口：奖品列表

奖品列表

请求URL:

GET/v2/lottery/lists

参数:

参数名	是否必须	说明
page	是	页码
page_size	是	当前页最大数据
award_name	否	奖品名称
activity_id	是	活动ID

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int	状态码
msg	string	状态信息
data	object	删除条数
data[total]	string	数据总数
data[page]	string	当前页
data[page_size]	string	每页展示多少条
data[list]	array	数据列表
data[list][id]	string	奖品ID
data[list][business_uid]	string	用户ID
data[list][app_id]	string	业务app_id
data[list][source_id]	string	来源ID
data[list][award_name]	string	奖品名称
data[list][image_url]	string	奖品图片
data[list][award_desc]	string	奖品描述
data[list][link_url]	string	奖品链接
data[list][created_at]	string	奖品创建时间

请求结果示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "id": 237415,
                "business_uid": 23300083,
                "app_id": "1111111",
                "source_id": "",
                "award_name": "xixi",
                "image_url": "mp-test/b6/1d/b61ddbbed0298824a5f744e2f9f3e884a.jpeg",
                "award_desc": "112",
                "link_url": "https://vhall.com",
                "created_at": "2021-01-07 14:22:41"
            }
        ],
        "total": 1,
        "page": 1,
        "page_size": 10
    }
}

备注:

更多返回错误代码请看首页的错误代码描述

新增奖品

接口：新增奖品

新增奖品

请求URL:

POST/v2/lottery/add

参数:

参数名	是否必须	说明
award_name	是	奖品名称
image_url	是	奖品地址
link_url	否	奖品链接
award_desc	否	奖品描述

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int	状态码
msg	string	状态信息
data	object	删除条数
data[app_id]	string	业务app_id
data[award_desc]	string	奖品描述
data[award_name]	string	奖品名称
data[business_uid]	string	用户ID
data[created_at]	string	创建时间
data[id]	string	奖品ID
data[image_url]	string	奖品图片
data[link_url]	string	奖品地址
data[source_id]	string	来源ID

请求结果示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "id": 238653,
        "business_uid": 23300083,
        "app_id": "02391153",
        "source_id": null,
        "award_name": "test",
        "image_url": "mp-test/62/4b/624bb0783449ef9a6a1dfed406109208a.jpg",
        "award_desc": "test",
        "link_url": "",
        "created_at": null
    }
}

失败时返回:

{
    "code": 201,
    "msg": "award_name 不能为空。",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

编辑奖品

接口：编辑奖品

编辑奖品

请求URL:

POST/v2/lottery/edit

参数:

参数名	是否必须	说明
image_url	是	奖品地址
link_url	否	奖品链接
award_desc	否	奖品描述
id	是	奖品ID
award_name	是	奖品名称

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int	状态码
msg	string	状态信息
data	object	删除条数
data[app_id]	string	业务app_id
data[award_desc]	string	奖品描述
data[award_name]	string	奖品名称
data[business_uid]	string	用户ID
data[created_at]	string	创建时间
data[id]	string	奖品ID
data[image_url]	string	奖品图片
data[link_url]	string	奖品地址
data[source_id]	string	来源ID

请求结果示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "id": 238653,
        "business_uid": 23300083,
        "app_id": "02391153111",
        "source_id": null,
        "award_name": "testtest",
        "image_url": "mp-test/62/4b/624bb0783449ef9a6a1dfed406109208a.jpg",
        "award_desc": "testtest",
        "link_url": "",
        "created_at": null
    }
}

失败时返回:

{
    "code": 201,
    "msg": "id 不能为空。",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

批量删除奖品

接口：批量删除奖品

批量删除奖品

请求URL:

GET/v2/lottery/delete

参数:

参数名	是否必须	说明
id	否	奖品ID多个ID用英文逗号隔开
type	是	ids:按id删除 all:全部删除

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int	状态码
msg	string	状态信息
data	boolean	true:删除成功 false:删除失败

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":null,
    "data":true
}

失败时返回:

{
    "code": 201,
    "msg": "type 不能为空。",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

活动维度下的奖品列表

编辑活动维度下的奖品

删除活动维度下的奖品

用户维度下的奖品绑定到活动下

活动维度下的文档列表

将用户维度下的文档关联到活动下

删除活动维度下的文档

公共接口

文件上传

接口：文件上传

文件上传

请求URL:

POST/v2/upload/doc

参数:

参数名	是否必须	说明
file	是	文件

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[name]	string	文件路径
data[host]	string	文件域名

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":null,
    "data":{
        "name":"mp-test\/62\/4b\/624bb0783449ef9a6a1dfed406109208.jpg",
        "host":"https:\/\/zhike.oss-cn-beijing.aliyuncs.com"
    }
}

失败时返回:

{
    "code": 500,
    "msg": "网络波动,请刷新后重试",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

图片上传

接口：图片上传

图片上传

请求URL:

POST/v2/upload/image

参数:

参数名	是否必须	说明
file	是	文件

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[name]	string	文件路径
data[host]	string	文件域名

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":null,
    "data":{
        "name":"mp-test\/62\/4b\/624bb0783449ef9a6a1dfed406109208.jpg",
        "host":"https:\/\/zhike.oss-cn-beijing.aliyuncs.com"
    }
}

失败时返回:

{
    "code": 500,
    "msg": "网络波动,请刷新后重试",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

营销互动

礼物/打赏列表

接口：礼物/打赏列表

礼物/打赏列表

请求URL:

GET/v2/reward/list

参数:

参数名	是否必须	说明
type	否	gift:礼物 reward:打赏
activity_id	否	用户维度下传0.活动维度下传活动ID

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[list]	array	数据数组
data[list][id]	string	礼物／打赏ID
data[list][online_status]	string	上下架状态(0:下架,1:上架)
data[list][price]	string	金额
data[list][status]	string	0:系统默认打赏 1:普通打赏
data[list][activity_id]	string	用户维度下返回0，活动维度下返回活动ID
data[list][full_screen_status]	string	全屏特效开关(0:关闭 1:开启)
data[list][image_url]	string	礼物图片
data[list][full_screen_image_url]	string	礼物全屏效果图片
data[list][name]	string	礼物名称
data[list][created_at]	string	创建时间
data[list][updated_at]	string	最后更新时间
data[total]	string	总数

请求结果示例:

正确时返回:


{
    "code": 200,
    "msg": null,
    "data": {
        "list": [
            {
                "id": 1333,
                "name": "",
                "online_status": 1,
                "price": "0.88",
                "full_screen_status": 0,
                "image_url": "",
                "full_screen_image_url": "",
                "status": 0,
                "activity_id": "0",
                "created_at": "2021-05-13 09:40:47",
                "updated_at": "2021-05-13 09:40:47"
            },
        ],
        "total": 1
    }
}

失败时返回:

{
    "code": 201,
    "msg": "activity_id 不能为空。",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

创建/编辑(礼物/打赏)

接口：创建／编辑(礼物／打赏)

创建／编辑(礼物／打赏)

请求URL:

POST/v2/reward/create-or-edit

参数:

参数名	是否必须	说明
id	是	编辑的时候传礼物/打赏ID
activity_id	是	用户维度下传0.活动维度下传活动ID
price	是	金额
online_status	是	上下架状态(0:下架,1:上架)
full_screen_status	是	全屏特效开关(0:关闭 1:开启)
image_url	是	礼物图片 type=gift时必传
full_screen_image_url	是	礼物全屏特效地址
type	是	传reward:打赏，传gift:礼物
name	是	礼物名称 type=gift时必传

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[id]	string	礼物／打赏ID
data[name]	string	礼物名称
data[online_status]	string	上下架状态(0:下架,1:上架)
data[price]	string	金额
data[status]	string	0:系统默认打赏 1:普通打赏
data[activity_id]	string	活动ID(通用打赏返回0)
data[full_screen_status]	string	全屏特效开关(0:关闭 1:开启)
data[image_url]	string	礼物图片
data[full_screen_image_url]	string	礼物全屏特效地址
data[created_at]	string	创建时间
data[updated_at]	string	最后更新时间

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":null,
    "data":{
        "id":134265,
        "name":"test",
        "price":"1314.00",
        "status":"1",
        "activity_id":"0",
        "online_status":1,
        "full_screen_status":0,
        "image_url":"mp-test\/62\/4b\/624bb0783449ef9a6a1dfed406109208.jpg",
        "full_screen_image_url":"",
        "created_at":"2021-05-27 11:17:53",
        "updated_at":""
    }
}

失败时返回:

{
    "code": 500,
    "msg": "最多设置20个，超过数量限制",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

获取打赏礼物开关信息

接口：获取打赏礼物相关开关信息

获取打赏礼物相关开关信息

请求URL:

GET/v2/reward/create-or-edit_1622087053404

参数:

参数名	是否必须	说明
activity_id	是	活动ID

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[gift_status]	string	活动下礼物开关(N:关 Y:开)
data[reward_status]	string	活动下打赏开关(N:关 Y:开)
data[global_gift_status]	string	活动下用户维度礼物开关(N:关 Y:开)
data[global_reward_status]	string	活动下用户维度打赏开关(N:关 Y:开)

请求结果示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {
        "gift_status": "Y",
        "reward_status": "Y",
        "global_gift_status": "N",
        "global_reward_status": "N"
    }
}

失败时返回:

{
    "code": 500,
    "msg": "活动不存在",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

删除礼物/打赏

接口：删除礼物／打赏

删除礼物／打赏

请求URL:

GET/v2/reward/del

参数:

参数名	是否必须	说明
id	是	礼物／打赏 ID
activity_id	是	活动ID,用户维度下传0，活动维度下传活动ID
type	是	传reward:打赏，传gift:礼物

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据

请求结果示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {

    }
}

失败时返回:

{
    "code": 401,
    "msg": "id 礼物id不能为空",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

设置活动维度下的打赏/礼物开关

接口：设置活动维度下礼物/打赏开关

设置活动维度下礼物/打赏开关

请求URL:

POST/v2/reward/switch

参数:

参数名	是否必须	说明
switch_status	是	开关(N:关,Y:开)
activity_id	是	活动ID
type	是	传reward:打赏，传gift:礼物

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据

请求结果示例:

正确时返回:

{
    "code": 200,
    "msg": null,
    "data": {

    }
}

失败时返回:

{
    "code": 201,
    "msg": "参数错误",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

获取打赏/礼物的人数和金额

接口：互动数据-人数/现金总额

互动数据-人数/现金总额

请求URL:

GET/v2/reward/interact-data

参数:

参数名	是否必须	说明
activity_id	是	活动ID

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[reward_num]	string	打赏人数
data[reward_money]	string	打赏金额
data[gift_num]	string	礼物人数
data[gift_money]	string	礼物金额

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":"",
    "data":{
        "reward_num":1,
        "reward_money":0.01,
        "gift_num":1,
        "gift_money":0
    },
    "request_id":"a440fe9a-ce26-48e0-b2a9-e8e3bc9b4dc1"
}

失败时返回:

{
    "code": 500,
    "msg": "活动不存在",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

打赏/礼物榜列表

接口：打赏/礼物榜列表

打赏/礼物榜列表

请求URL:

GET/v2/interact/rank-list

参数:

参数名	是否必须	说明
activity_id	是	活动ID
type	是	传reward:打赏，传gift:礼物
pos	是	偏移量
limit	是	获取数据行数

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[pos]	string	偏移量
data[limit]	string	获取数据行数
data[total]	string	数据总数
data[list]	array	数据数组
data[list][rank]	string	排行
data[list][email]	string	邮箱
data[list][avatar]	string	头像
data[list][nickname]	string	昵称
data[list][price]	string	打赏金额
data[list][consumer_uid]	string	发起打赏用户id
data[list][phone]	string	手机号

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":"",
    "data":{
        "list":[
            {
                "rank":1,
                "avatar":"mp-test\/67\/8e\/678e512b3a28f6904d63365181f94476.png",
                "name":"\u7965\u5a01",
                "consumer_uid":101403306,
                "money":"0.01",
                "phone":"15210497597",
                "gift_name":"",
                "email":""
            }
        ],
        "pos":"0",
        "limit":1,
        "total":1
    }
}

失败时返回:

{
    "code": 201,
    "msg": "参数错误",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

打赏/礼物数据详情

接口：打赏/礼物数据详情

打赏/礼物数据详情

请求URL:

GET/v2/interact/details-list

参数:

参数名	是否必须	说明
activity_id	是	活动ID
type	是	传reward:打赏，传gift:礼物
pos	是	偏移量
limit	是	获取数据行数

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据
data[pos]	string	偏移量
data[limit]	string	获取数据行数
data[list]	array	数据数组
data[list][activity_consumer_uid]	string	活动下的用户ID
data[list][avatar]	string	头像
data[list][nickname]	string	昵称
data[list][money]	string	金额
data[list][consumer_uid]	string	发起打赏用户id
data[list][phone]	string	手机号
data[list][name]	string	礼物名称
data[list][created_at]	string	赠送时间

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":"",
    "data":{
        "list":[
            {
                "name":"",
                "money":0.01,
                "phone":"15210497597",
                "avatar":"mp-test\/67\/8e\/678e512b3a28f6904d63365181f94476.png",
                "nickname":"\u7965\u5a01",
                "created_at":"2021-05-24 18:52:32",
                "consumer_uid":101403306
            }
        ],
        "pos":"0",
        "limit":"10",
        "total":1
    }
}

失败时返回:

{
    "code": 201,
    "msg": "参数错误",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

打赏/礼物相关数据导出(异步需要接下载中心)

接口：打赏/礼物相关数据导出

打赏/礼物相关数据导出

请求URL:

GET/v2/download/add-task

参数:

参数名	是否必须	说明
activity_id	是	活动ID
download_type	是	礼物:GIFT_EXPORT 打赏:REWARD_EXPORT 打赏榜:REWARD_RANK_EXPORT 礼物榜:GIFT_RANK_EXPORT

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据对象

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":"",
    "data":{

    }
}

失败时返回:

{
    "code": 201,
    "msg": "参数错误",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

通用开关

接口：通用开关

通用开关

请求URL:

GET/v2/reward/global-switch

参数:

参数名	是否必须	说明
activity_id	是	活动ID
swtich_status	是	开关(N:关 Y:开)
type	是	reward:打赏，传gift:礼物

返回参数说明:

返回数据如下：

参数名	类型	说明
code	string	状态码
msg	string	状态信息
data	object	数据对象

请求结果示例:

正确时返回:

{
    "code":200,
    "msg":"",
    "data":{

    }
}

失败时返回:

{
    "code": 201,
    "msg": "参数错误",
    "data": null
}

备注:

更多返回错误代码请看首页的错误代码描述

电商管理

商品列表

接口：商品列表

商品列表

请求URL:

GET/v2/goods/lists

参数:

参数名	是否必须	说明
app_id	是	账号的appId
signed_at	是	时间戳
sign	是	签名
page	是	当前页
page_size	是	每页大小
name	是	商品名字

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data	object	数据对象
data[page]	int
data[list]	array	数据数组
data[list][bu]	string
data[list][title]	string	商品标题
data[list][price]	int	价格
data[list][preferential]	int	优惠价
data[list][image]	string	图片链接多张
data[list][describe]	string	商品描述
data[list][content]	string	商品详情内容
data[list][url]	string	商品链接
data[list][tao]	string	淘口令
data[list][top]	int	置顶
data[list][push]	int	推送数
data[list][pv]	int	浏览次数
data[list][uv]	int	浏览人数
data[list][buy]	int	购买人数
data[list][added]	int	是否上架 1默认上架 0下架
data[list][deleted]	int	是否已删除 0 表示未删除 1 表示已删除
data[list][deposit]	int	订金
data[list][free]	string	商品是否免费：N 不免费 Y 免费
data[list][stock]	int	商品的库存：默认值为9999个商品，最大值为9999
data[list][brand_id]	Array	品牌id
data[list][brand_name]	Array	品牌名称
data[list][app_id]	string
data[list][third_part_uid]	string	创建人ID
data[list][buy_nums]	int	购买次数
data[list][goods_id]	int	商品id
data[list][external_link_status]	string	是否开启外部链接：N不开启 Y 开启
data[list][created_at]	string
data[list][updated_at]	string
data[list][deleted_at]	null
data[page_size]	int
data[total]	int
request_id	string

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

删除商品

接口：删除商品

删除商品

请求URL:

GET/v2/goods/delete

参数:

参数名	是否必须	说明
goods_id	是	商品ID ，type为ids时必传
type	是	ids=>删除指定商品，all=>删除所有商品
app_id	是	账号的appId
signed_at	是	时间戳
sign	是	签名

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data	boolean
request_id	string

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

商品详情

接口：商品详情

商品详情

请求URL:

GET/v2/goods/detail

参数:

参数名	是否必须	说明
goods_id	是	商品id
app_id	是	账号的appId
signed_at	是	时间戳
sign	是	签名

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	string
data	object	数据对象
data[goods_id]	string
data[bu]	string
data[title]	string
data[price]	string
data[preferential]	string
data[image]	string
data[describe]	string
data[content]	string
data[url]	string
data[tao]	string
data[top]	string
data[push]	string
data[pv]	string
data[uv]	string
data[buy]	string
data[added]	int
data[deleted]	string
data[deposit]	string
data[free]	string
data[stock]	int
data[brand_id]	null
data[brand_name]	null
data[app_id]	string
data[third_part_uid]	string
data[buy_nums]	string
data[external_link_status]	string
data[created_at]	string
data[updated_at]	string
data[deleted_at]	null
request_id	string

字段含义参照 http://doc.vhall.com/docs/show/1902

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

编辑商品

接口：编辑商品

编辑商品

请求URL:

GET/v2/goods/update

参数:

参数名	是否必须	说明
app_id	是	账号的appId
signed_at	是	时间戳
sign	是	签名
goods_id	是	商品id
free	是	Y=>免费，N=>不免费
stock	是	库存
external_link_status	是	是否开启外链：Y=>开启，N=>不开启
deposit	是	订金
brand_id	是	品牌id
content	否	品牌描述
tao	否	淘口令
url	是	外链地址
preferential	是	优惠价
price	是	原价
activity_id	否	活动ID、非必须
describe	否	商品描述
image	是	图片地址： [{"errMsg":"","name":"mp-test/20/7b/207b663983910fd32ed6a8e7cab80511.jpg"}] 形式的字符串
title	是	商品名称

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	boolean

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

商品库商品上下架

接口：商品库商品上下架

商品库商品上下架

请求URL:

GET/v2/goods/added

参数:

参数名	是否必须	说明
goods_id	是	商品ID
type	是	1=》上架，0=》下架
app_id	是	账号的appId
signed_at	是	时间戳
sign	是	签名

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	boolean

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

添加商品

接口：创建商品

创建商品

请求URL:

GET/v2/goods/create

参数:

参数名	是否必须	说明
title	是	产品名称
image	是	图片地址json字符串： [{"errMsg":"","name":"mp-test/19/b6/19b609c0f78aedde26c02e161b9a88ff.jpg"}]
describe	是	描述
activity_id	否	活动ID ，非必须
price	是	原价
preferential	是	折扣价
url	否	外链地址
tao	否	淘口令
content	是	商品详情
brand_id	否	品牌ID
deposit	否	定金，商品是免费商品时，不填
external_link_status	是	Y=>开启，N=>不开启，开启外链时，外链地址和淘口令必填
third_part_uid	否	第三方用户ID
free	是	in:Y,N 是否免费 Y => 免费， N=>不免费
stock	是	库存
app_id	是	用户的appId
sign	是	签名
signed_at	是	时间戳

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[app_id]	string
data[third_part_uid]	string
data[title]	string
data[describe]	string
data[content]	string
data[price]	string
data[preferential]	string
data[image]	string
data[url]	string
data[tao]	string
data[top]	int
data[push]	int
data[uv]	int
data[buy]	int
data[pv]	int
data[buy_nums]	int
data[added]	int
data[bu]	string
data[deleted]	int
data[created_at]	string
data[updated_at]	null
data[deleted_at]	null
data[deposit]	string
data[external_link_status]	string
data[stock]	string
data[free]	string
data[goods_id]	string

字段含义参考： http://doc.vhall.com/docs/show/1902

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

添加品牌

接口：添加品牌

添加品牌

请求URL:

GET/v2/brands/add

参数:

参数名	是否必须	说明
name	是	品牌名称
app_id	是	账号的appId
signed_at	是	时间戳
sign	是	签名

返回参数说明:

返回数据如下：

参数名	类型	说明
code	int
msg	null
data	object	数据对象
data[remark]	string	备注
data[add]	string	上下架： Y=>上架，N=>下架
data[deleted]	int	是否删除: 0=>为删除，1=>已删除
data[bu]	string
data[brand_id]	string	品牌id
data[app_id]	string
data[third_part_uid]	string	第三方用户ID
data[brand_name]	string	品牌名称
data[brand_num]	string
data[good_count]	int	商品总数
data[shop_count]	int	门店总数
data[created_at]	string
data[updated_at]	null
data[deleted_at]	null

请求结果示例:

无

备注:

更多返回错误代码请看首页的错误代码描述

数据报告

推广渠道数据

推广活动官网数据

推广页面访问折线图数据

推广活动引导页

用户列表

概览数据-直播数据-预览数据-活动得分

概览数据-直播数据-预览数据-用户观看统计

概览数据-直播数据-预览数据-观看影像系数因子

直播数据相关的接口-----互动工具参与趋势图

直播数据相关的接口-----观众访问趋势图

直播数据相关的接口-----观看回放规律图

直播数据相关的接口-----观看数据

直播数据相关的接口-----观看时长与观众分布图

开放JSSDK文档

介绍

简介

微吼知客Javascript SDK为WEB端提供了直播和点播功能的集成服务，除支持基础的直播和点播功能外，还融合了如聊天、红包等丰富的互动服务，为用户提供了简单、快速、功能全面、稳定的视频服务。温馨提示： 1、请不要将JSSDK嵌入到您的小程序中。由于小程序域名审核严格，将会导致JSSDK内部部分请求无通过，无法保证稳定运行。

功能列表

分类	功能	描述
聊天	观看端聊天	支持在直播时聊天和观看回放时聊天
视频	观看端视频	支持移动端和PC端观看直播视频和回放视频
文档	观看端文档	支持移动端和PC端观看文档演示（移动端不支持文档笔触信息）
暖场	观看端暖场	支持暖场视频的播放及配置获取
回放	观看端回放	支持回放视频的播放及配置获取
公告	观看端公告	支持观看端显示公告消息
红包	观看端实时红包	抢红包功能
推荐卡片	观看端推荐卡片	观看端实时推荐卡片分享
问卷	观看端问卷	实时收到问卷信息，并提供填写问卷
抽奖	观看端抽奖	支持直播时抽奖消息响应，及查看中奖人信息
弹幕	观看端视频弹幕	观看端视频发送实时弹幕
自定义菜单	观看端菜单	支持自定义菜单的实时变更通知显示（包括：排行榜，热门直播，媒体推广，自定义富文本）
点赞	观看端点赞	支持点赞及实时点赞通知
聊天审核	观看端聊天审核通知	支持聊天审核开关通知
踢出	观看端用户被踢出	支持观看端用户实时被踢出通知
禁言	观看端用户被禁言	支持观看端用户实时被禁言通知
聊天删除	观看端用户聊天实时删除通知	支持观看端用户聊天实时删除通知
虚拟人数	观看端虚拟人数	支持观看端虚拟人数实时通知

点播上传支持格式

上传格式	用途
mp4	暖场，回放

播放支持格式

播放格式	用途	PC浏览器	移动端浏览器
RTMP	直播	支持	支持
MP4	点播/回放	支持	支持
HLS(M3U8)	点播/回放	支持	支持

浏览器支持

为保证点播SDK能够正常使用请尽量在高版本浏览器下使用本SDK产品（Chrome58及以上版本）

接入申请

接入步骤

1、联系客户经理开通权限立即沟通权限申请，或400-888-9970电话立即沟通申请

2、获取API/SDK的使用权限信息，得到Acess key点击查看

3、依照文档进行功能接入

Access Key

权限申请通过后，用户可在 https://zhike.vhall.com/assetMager/openInterface 页面获取app_id 、secret_key。说明：

app_id：应用ID, 用于标识客户身份，在网络请求中会以某种形式传输

secret_key：作为私钥形式存储于客户方本地，不在网络传递，它的作用是对客户方发起的请求进行数字签名，保证该请求是来自指定客户的请求，并且是合法的有效的。

功能使用

快速开始

引入知客 jssdk

// 仅支持https 协议
// 底层消息sdk
<script src="https://static.vhallyun.com/jssdk/vhall-jssdk-base/vhall-msg-2.0.0.js?oldver=1.0.11"></script>
// 底层聊天sdk
<script src="https://static.vhallyun.com/jssdk/vhall-jssdk-chat/3.0.0/vhall-jssdk-chat-3.0.0.js"></script>
// 底层播放器sdk
<script src="https://static.vhallyun.com/jssdk/vhall-jssdk-player/latest/vhall-jssdk-player-2.3.1.js"></script>
// 知客jssdk
<script src="https://static-zhike.vhall.com/fe_jssdk_prod/1.0.0/zk-jssdk.min.js"></script>

初始化知客JSSDK

/* 初始化sdk */
VHALL_ZK.init({
  app_id: params.app_id, // app_id, 申请的应用id
  activity_id: params.activity_id, // 活动id
  sign: params.sign, // 服务器签名
  account_id: params.account_id, // 第三方账户id
  signed_at: params.signed_at, // 签名时间，精确到秒
  share_id: '' // 分享人id，非必填
  refer: '' // 渠道来源，非必填，具体见下表
  open_id: '' // 微信授权open_id，非必填
  qrcode: '' // 微信授权，非必填
})
/* 监听初始化完毕，可以进行操作 */
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.initReady, () => {
  ...
})

参数说明

参数名	是否必须	类型	说明
app_id	是	string	应用id
account_id	是	string	第三方用户的唯一id
sign	是	string	校验签名
signed_at	是	string	签名时间戳
activity_id	是	string	知客活动id
share_id	否	string	分享人id，用于用户画像，形成分享数据链路
refer	否	string	渠道来源。具体见下表
open_id	否	string	微信授权open_id

渠道来源refer

值	来源
0	邮件
1	微信
2	短信
1000-10000	自定义渠道
99999	微信扫描
''	不填写表示，主渠道

模块功能

视频

视频观看模块功能API 说明

调用方式： VHALL_ZK.init完成之后，用VHALL_ZK.$player初始播放器。

/* 初始化播放器 */
VHALL_ZK.$player.init({
  type: type || 'live', // live 直播  vod 点播  必填
  recordId: this.recordId || '', // 回放id，type==vod 时必传
  videoNode: '' // 播放器的容器， div的id 必填
})
/* 播放器初始化成功 */
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.PlayerReady, (res) => {
  console.log('--初始化直播播放器成功--')
})

播放器API列表使用VHALL_ZK.$player作为句柄调用

API名	功能描述	参数	返回值	备注
play	自助操作播放	无
pause	自助操作暂停	无
getQualityList	清晰度列表	无	Array	没有则返回[]
getCurrentQuality	当前使用清晰度	无	Object	没有则返回null
setQuality	设定指定清晰度	Object	无	参数为getQualityList中单个值
getCurrentTime	当前播放时间	无	Number	没有则返回0
seekTime	设置播放时间	Number	无	参数精确到秒
getSpeedList	获取当前可支持倍速列表	无	Array	返回结果 [0.75, 1, 1.25, 1.5, 2]
setSpeed	设置倍速	int	无	参数为getSpeedList里面单个值
setMute	设置是否禁音	boolean	无	参数为true 或 false
setVolume	设置声音音量	boolean	无	参数为 0 ~ 1 范围数值
toggleBarrage	视频弹幕开关切换	boolean	无	参数为true 或 false
addBarrage	发送弹幕	string	无	参数为字符串
getMarkPoints	获取视频打点信息	无	Array	返回样例[{timePoint:'打点的时间', msg: '打点的文字'}]
on	监听播放器事件	(type, event)	无	type为监听的类型，event为响应事件
off	移除播放器监听事件	(type, event)	无	type为监听的类型，event为响应事件
enterFullScreen	进入视频全屏	无	无	-
destroy	销毁播放器	无	无	销毁播放器之后视频不能播放

播放器事件列表

事件名	功能描述	备注
VHALL_ZK.EVENTS.PLAY	开始播放	无
VHALL_ZK.EVENTS.PAUSE	暂停播放	无
VHALL_ZK.EVENTS.LAG_REPORT	播放卡顿	视频卡顿时触发
VHALL_ZK.EVENTS.LAG_RECOVER	播放卡顿恢复	视频卡顿恢复时触发
VHALL_ZK.EVENTS.DEFINITION_CHANGE	当前清晰度改变时触发	卡顿时自动切清晰度触发，手动切换不触发
VHALL_ZK.EVENTS.TIMEUPDATE	播放时间改变	播放时间改变时触发，其中delay为直播时延

代码示例

VHALL_ZK.$player.init({
 ...
})
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.PlayerReady, (res) => {
  console.log('--初始化直播播放器成功--')
  this.addEventPlayer()
})
// 自助操作 播放
VHALL_ZK.$player.play()
// 自助操作 暂停
VHALL_ZK.$player.pause()
// 获取当前可支持倍速列表
let speedList = VHALL_ZK.$player.getSpeedList()
// 设置倍速
VHALL_ZK.$player.setSpeed(speedList[2])
// 清晰度列表
let qualityList = VHALL_ZK.$player.getQualityList()
// 设定指定清晰度
VHALL_ZK.$player.setQuality(qualityList[1])
// 获取当前使用清晰度
let currentQuality = VHALL_ZK.$player.getCurrentQuality()
// 当前播放时间
let currentTime = VHALL_ZK.$player.getCurrentTime()
// 视频跳转到第100秒
VHALL_ZK.$player.seekTime(100)
// 获取当前可支持倍速列表
let speedList = VHALL_ZK.$player.getSpeedList()
// 设置倍速
VHALL_ZK.$player.setSpeed(speedList[1])
// 设置声音是否静音
VHALL_ZK.$player.setMute(true | false)
// 设置声音音量, 0.5表示50%音量
VHALL_ZK.$player.setVolume(0.5)
// 视频弹幕开关切换, true打开弹幕开关
VHALL_ZK.$player.toggleBarrage(true)
// 发送弹幕, 发送弹幕
VHALL_ZK.$player.addBarrage(str)
// 获取视频打点信息
VHALL_ZK.$player.getMarkPoints()
// 播放器全屏
VHALL_ZK.$player.enterFullScreen()
// 销毁播放器
VHALL_ZK.$player.destroy()
/* 视频监听事件 */
addEventPlayer () {
  VHALL_ZK.$player.on(VHALL_ZK.EVENTS.PLAY, () => {
    console.log('-----视频开始播放-----')
  })
  VHALL_ZK.$player.on(VHALL_ZK.EVENTS.PAUSE, () => {
    console.log('-----视频暂停-----')
  })
  VHALL_ZK.$player.on(VHALL_ZK.EVENTS.LAG_REPORT, () => {
    console.log('-----视频卡顿-----')
  })
  VHALL_ZK.$player.on(VHALL_ZK.EVENTS.LAG_RECOVER, () => {
    console.log('-----卡顿恢复-----')
  })
  VHALL_ZK.$player.on(VHALL_ZK.EVENTS.DEFINITION_CHANGE, () => {
    console.log('-----清晰度改变-----')
    this.currentQuality = VHALL_ZK.$player.getCurrentQuality()
  })
  VHALL_ZK.$player.on(VHALL_ZK.EVENTS.TIMEUPDATE, (e) => {
    // e.delay直播时延
  })
}

文档

视频观看模块功能API 说明

###调用方式： VHALL_ZK.init完成之后，用VHALL_ZK.$doc初始化文档

/* 初始化播放器 */
VHALL_ZK.$doc.init('watch_doc_id')

参数说明

参数名	是否必须	类型	说明
watch_doc_id	是	string	div的id

事件列表

事件名	功能描述	备注
VHALL_ZK.EVENTS.DOC_CURRENT_ID	当前文档id	无
VHALL_ZK.EVENTS.DOC_LOAD_COMPLETE	文档加载完成	无
VHALL_ZK.EVENTS.DOC_ALL_COMPLETE	所有文档加载完成	无
VHALL_ZK.EVENTS.DOC_VOD_LOAD_COMPLETE	回放文档加载完成	回放期间可能有多个问题
VHALL_ZK.EVENTS.VOD_TIME_UPDATE	视频回放更新时间	--

API列表使用VHALL_ZK.$doc作为句柄调用

API名	功能描述	参数	返回值	备注
zoomIn	放大	无	无	执行之后，点击文档会自动放大
zoomOut	缩小	无	无	执行之后，点击文档会自动缩小
zoomReset	复原	无	无	执行之后，文档还原到初始状态
move	移动	无	无	执行之后，可以拖动文档
docFull	全屏	无	无	执行之后，文档全屏展示
resize	重置布局	无	无	根据容器尺寸重新计算尺寸
destroy	销毁	无	无	销毁文档

代码示例

VHALL_ZK.$doc.init('watch_doc_id')
// 自助操作 放大
VHALL_ZK.$doc.zoomIn()
// 自助操作 缩小
VHALL_ZK.$doc.zoomOut()
// 自助操作 复原
VHALL_ZK.$doc.zoomReset()
// 自助操作 移动
VHALL_ZK.$doc.move()
// 自助操作 全屏
VHALL_ZK.$doc.docFull()
// 自助操作 重置布局
VHALL_ZK.$doc.resize()
// 自助操作 销毁文档
VHALL_ZK.$doc.destroy()
// 事件监听
/* 当前正在演示文档id */
VHALL_ZK.$doc.on(VHALL_ZK.EVENTS.DOC_CURRENT_ID, (res) => {
  this.currentDocId = res.id || ''
})
/* 回放正在使用文档id */
VHALL_ZK.$doc.on(VHALL_ZK.EVENTS.VOD_TIME_UPDATE, (res) => {
  this.currentDocId = res.id || ''
})
/* 当前文档加载完成 */
VHALL_ZK.$doc.on(VHALL_ZK.EVENTS.DOC_LOAD_COMPLETE, () => {
  this.loading = false
})
/* 所有文档加载完成 */
VHALL_ZK.$doc.on(VHALL_ZK.EVENTS.DOC_ALL_COMPLETE, () => {
  this.loading = false
  VHALL_ZK.$doc.resize()
})
/* 回放文件加载完成 */
VHALL_ZK.$doc.on(VHALL_ZK.EVENTS.DOC_VOD_LOAD_COMPLETE, () => {
  this.loading = false
})

聊天

聊天功能模块功能API 说明

###调用方式： VHALL_ZK.init完成之后

API列表使用VHALL_ZK.$chat作为句柄调用

API名	功能描述	参数	返回值	备注
sendChat	发送聊天	string	Promise	返回结果中有，消息id
onChat	监听聊天	function	Object	聊天内容
getEmojiArr	获取标签列表	无	Array	执行之后，文档还原到初始状态
getChatHistroy	获取历史聊天	页面信息	Object	返回聊天历史消息

代码示例

VHALL_ZK.$chat.sendChat('哈喽，这是我发的第一条聊天内容')
/* 获取聊天所有表情 */
const faceArr = VHALL_ZK.$chat.getEmojiArr()
[
  {'[微笑]': '1'},
  {'[撇嘴]': '2'},
   ...
]
/* 对应表情图片 */
[
  https://cnstatic01.e.vhall.com/static/img/arclist/Expression_1@2x.png,
  https://cnstatic01.e.vhall.com/static/img/arclist/Expression_2@2x.png,
  ...
]
/* 监听聊天消息 */
VHALL_ZK.$chat.onChat(listenChat)
funciton listenChat (msg) {
  console.log('聊天内容', msg)
}
/* 获取历史聊天 */
VHALL_ZK.$chat.getChatHistroy({
  activity_id: this.activity_id, // 活动id
  page: 1, // 页码
  page_size: 50 // 每页条数
}).then((res) => {
  console.log('聊天历史记录', res)
})

用户

互动功能模块功能API 说明

调用方式： VHALL_ZK.init完成之后

API列表使用VHALL_ZK.$api作为句柄调用

API名	功能描述	参数	返回值	备注
getUser	获取用户信息	无	Object	用户的基本信息
updateUser	更新用户信息	Object	Promise	-
updateMobile	更新手机号	Object	Promise	-
userShareRecord	用户分享记录	无	Promise	数据上报用
getOnlineNum	获取在线人数	无	Promise	-
visitorInfo	获取初始化时的游客信息	无	Object	-
getVisitorInfo	实时获取游客信息	无	Promise	-
joinActivity	用户加入活动	无	Promise	-

代码示例

VHALL_ZK.$api.getUser()
/* 可以只更新单项 */
VHALL_ZK.$api.updateUser({
  nick_name: ''
})
/* 也可以只更新多项 */
VHALL_ZK.$api.updateUser({
  avatar: '' // 头像
  nick_name: '', // 昵称
  email: '' // 邮箱
}).then((res) => {
  console.log(res)
})
/* 修改用户手机号 */
VHALL_ZK.$api.updateUserMobile({
  mobile: '', // 手机号
  code: '', // 用户输入的手机验证码
  code_token: this.code_token // 验证短信码后的code_token, 通过verifyCode接口获取
}).then((res) => {
  console.log(res)
})
VHALL_ZK.$api.userShareRecord()
VHALL_ZK.$api.getOnlineNum().then((res) => {
  // 真实浏览人数 res.data.visit_num
  // 真实在线人数 res.data.online_num
  // 虚拟在线人数 res.data.init_online_num
  console.log(res)
})
const visitorInfo = VHALL_ZK.$api.visitorInfo()
visitorInfo.visit_id // 游客id
visitorInfo.visit_name // 游客名称
VHALL_ZK.$api.getVisitorInfo().then(info => {
  info.visit_id // 游客id
  info.visit_name // 游客名称
})
/* 用户参会 */
VHALL_ZK.$api.joinActivity({
  activity_id: '', // 必填， 活动id
  join_source: '4', // 必填， 参会来源页：1.官网，2.引导页，3.观看页，4.邀请卡
  share_id: '', // 必填，分享人id
  refer: '' // 非必填，渠道
}).then((res) => {
  console.log(res)
})

渠道来源refer

值	来源
0	邮件
1	微信
2	短信
1000-10000	自定义渠道
99999	微信扫描
''	不填写表示，主渠道

互动请求

互动功能模块功能API 说明

调用方式： VHALL_ZK.init完成之后

API列表使用VHALL_ZK.$api作为句柄调用

API名	功能描述	参数	返回值	备注
getActivityInfo	获取活动信息	无	Object	活动的基本信息
getWatchPageSetting	获取观看页设置信息	无	Promise	-
activityShareRecord	分享活动	无	Promise	-
getWarmInfo	获取暖场信息	无	Promise	-
getActivityPlayBackInfo	获取回放信息	无	Promise	用于数据统计
getCardDetail	获取推荐卡片信息	无	Promise	-
viewCard	点击访问推荐卡片	无	Promise	用于数据统计
getArea	获取地区地理映射	无	Promise	-
getNaireDetail	获取问卷信息	无	Promise	-
submitNaire	提交问卷	Object	Promise	-
unLockRedBag	解锁红包	无	Promise	针对条件限制红包
getNowRedBagInfo	获取当前未开始的红包信息接口	无	Promise	-
grabRedBag	抢红包	red_packet_uuid	Promise	-
getRedBagInfo	获取红包信息	red_packet_uuid	Promise	通过红包uuid获取红包信息
getRedBagRecord	红包获取记录信息	red_packet_uuid	Promise	通过红包uuid获取红包中奖记录
getRedBagList	观看端获取红包领取记录接口	red_packet_uuid	Promise	通过红包uuid获取红包中奖用户列表
getAllInviteLotteryUsers	获取当前活动下所有被邀请抽奖人	无	Promise	-
getWinLotteryList	获取中奖列表	{lottery_id:'奖品id'，page:'',page_size:''}	Promise	-
unLockLottery	解锁抽奖	{lottery_id:''，password:'口令'}	Promise	-
getLotteryInfo	获取奖品信息	lottery_id（非必传）	Promise	如果不传递奖品id，讲查询当前活动正在进行的奖品信息
checkLotteryAddress	检测是否填写抽奖地址	lottery_id（必传）	Promise	-
submitLotteryAddress	提交填写的抽奖地址	{lottery_id:'',name: '昵称',phone: '',address: ''}	Promise	-
checkIsLottery	检测是否中奖	lottery_id（必传）	Promise	-
checkHasOrder	检测用户是否下过单	无	Promise	-
sendZan	点赞	无	Promise	-
getChatSetting	获取聊天审核信息	无	Promise	-
getShareCount	获取资料分享次数	无	Promise	-
getActivityMenuList	获取自定义菜单	无	Promise	-
getRankMenuList	排行榜菜单	menu_id	Promise	-
getRankList	排行榜类型列表	{ menu_id: '',type:''}	Promise	type:传reward:打赏，传gift:礼物
getMySelfRankInfo	自己的排行榜信息	{ menu_id: '',type:''}	Promise	type:share=》分享,invite=〉邀请,buyer=》土豪,watch=〉观看,gift=》礼物,reward=〉打赏
getMenuLive	热门直播菜单	menu_id	Promise	-
getMenuPromote	推广列表菜单	menu_id	Promise	-
getDocDownloadSetting	获取文档下载设置	无	Promise	-
getInviteCardList	获取邀请卡列表信息	无	Promise	-
logInviteCard	邀请卡数据上报	object	Promise	-

代码示例

/* 获取活动信息 */
const activityInfo = VHALL_ZK.$api.getActivityInfo()
/* 解锁红包 */
VHALL_ZK.$api.unLockRedBag({
  red_packet_uuid: '' // 红包uuid
  condition: '', // 红包类型0:默认 1:分享红包  2:口令红包  3:问卷红包  4:邀请红包
  password: '' // 红包口令
}).then((res) => {
  console.log(res)
})
/* 获取问卷信息 */
VHALL_ZK.$api.getNaireDetail().then((res) => {
  console.log(res)
  /* 样例 */
  {
    "code": 200,
    "data": {
        "id": 11910,
        "title": "问卷-test",
        "description": "请您仔细填写下面的信息！",
        "img_url": "mp-test/ba/45/ba45c8f60456a672e003a875e469d0eb.jpg",
        "publish": "Y",
        "app_id": "02391153",
        "detail": [
            {
                "id": 39991,
                "title": "姓名",
                "type": "text",
                "placeholder": "请输入姓名",
                "verification": "N",
                "required": "N", // 是否必填： Y必填， N非必填
                "style": "text",
                "ext": "{\"name\":\"姓名\",\"key\":\"name\"}",
                "custom_ques": 2,
                "created_at": "2021-06-29 10:48:21",
                "updated_at": "2021-06-29 10:48:21",
                "detail": {
                    "is_answer": null,
                    "format": "none",
                    "min": null,
                    "max": 0
                }
            },
            {
                "id": 39992,
                "title": "性别",
                "type": "select",
                "placeholder": "请选择性别",
                "verification": "N",
                "required": "N",
                "ext": "{\"fixedness\":true,\"name\":\"性别\",\"key\":\"sex\"}",
                "custom_ques": 2,
                "created_at": "2021-06-29 10:48:21",
                "updated_at": "2021-06-29 10:48:21",
                "detail": {
                    "list": [
                        {
                            "id": 75403,
                            "is_answer": 0,
                            "key": "60da89f596b2f",
                            "value": "男"
                        },
                        {
                            "id": 75404,
                            "is_answer": 0,
                            "key": "60da89f596f9e",
                            "value": "女"
                        }
                    ]
                }
            },
            {
                "id": 39996,
                "title": "手机号",
                "type": "text",
                "placeholder": "请输入手机号",
                "verification": "Y",
                "required": "Y",
                "style": "text",
                "ext": "{\"name\":\"手机号\",\"key\":\"phone\"}",
                "app_id": "02391153",
                "custom_ques": 2,
                "detail": {
                    "format": "phone",
                    "min": null,
                    "max": 11
                }
            }
        ]
    }
  }
})
let params = {
  "naire_id": 11911,
  "ext_data": JSON.stringify({
     "real_name":"刘德华",
     "sex":"M",
     "phone":"17600801597",
     "verify_code":"111111"
  }),
  "naire_data": JSON.stringify({
     "39994":"刘德华",
     "39995":"60da8e74ecbf1",
     "39996":"17600801597"
  })
}
/* 提交问卷 */
VHALL_ZK.$api.submitNaire(params).then((res) => {
  console.log(res)
})
/* 邀请卡数据上报 */
VHALL_ZK.$api.logInviteCard({
  business_uid: 'b端用户id',
  inviter_type: '邀请人类型', // ，1：主办方，2：c端用户
  invitation_card_id: '邀请卡id', // 邀请卡id
  inviter_id: '邀请人用户id或者邀请人游客id' // 邀请人用户id
}).then((res) => {
  console.log(res)
})

事件

全局事件说明

调用方式：

调用方式： VHALL_ZK.init完成之后，用VHALL_ZK.$event.on方法进行使用

事件	功能描述	参数	备注
VHALL_ZK.EVENTS.initReady	sdk初始准备完毕	callback	VHALL_ZK.init成功之后执行
VHALL_ZK.EVENTS.PlayerReady	视频播放器初始准备完毕	callback	VHALL_ZK.$player.init成功之后执行
VHALL_ZK.EVENTS.DocReady	文档初始准备完毕	callback	VHALL_ZK.$doc.init成功之后执行
VHALL_ZK.EVENTS.JOIN	用户进入执行	callback	-
VHALL_ZK.EVENTS.LEAVE	用户离开执行	callback	-
VHALL_ZK.EVENTS.BEGIN_LIVE	开始直播	callback	-
VHALL_ZK.EVENTS.FINISH_LIVE	结束直播	callback	-
VHALL_ZK.EVENTS.DISABLE_LIVE	直播不可用	callback	套餐用尽或者房间被禁
VHALL_ZK.EVENTS.MARKET_TOOL	互动工具消息	callback	问卷，红包，推荐卡片，抽奖，商品
VHALL_ZK.EVENTS.ANNOUNCEMENT	公告	callback	-
VHALL_ZK.EVENTS.KICK	踢出	callback	-
VHALL_ZK.EVENTS.KICK_BATCH	批量踢出	callback	-
VHALL_ZK.EVENTS.GAG	禁言	callback	-
VHALL_ZK.EVENTS.DISABLE_GAG	恢复禁言	callback	-
VHALL_ZK.EVENTS.GAG_ALL	全体禁言	callback	-
VHALL_ZK.EVENTS.DISABLE_GAG_ALL	恢复全体禁言	callback	-
VHALL_ZK.EVENTS.DELETE_MESSAGE	删除聊天消息	callback	-
VHALL_ZK.EVENTS.MENU_PUSH	菜单开关推送	callback	-
VHALL_ZK.EVENTS.INCREMENT_ONLINE	虚拟人数通知	callback	-
VHALL_ZK.EVENTS.ERROR	错误消息通知	callback	-

代码示例

VHALL_ZK.init({
 ...
})
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.initReady, () => {
 ...
})
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.ERROR, (e) => {
  console.error(e)
  if (e.code === 50000) { // 套餐用尽
    if (e.data.can_login === 'N') {
      let type = e.data.package === 'FLOW' ? 'off' : 'over'
      window.location.href = `${this.PC_HOST}other/${type}`
    }
  }
})
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.KICK, () => { // 当前用户被踢出
   this.$router.replace('/kicked')
})
/* 监听营销工具消息 */
VHALL_ZK.$event.on(VHALL_ZK.EVENTS.MARKET_TOOL, (msg) => {
	switch (msg.type) {
	  case SaleTool.TOAST_NUM: // 点赞消息
	    this.zan_num = msg.toast_num // 点赞数量
	    break
	case SaleTool.DOC_DOWNLOAD_SWITCH: // 资料下载开关
	    ...
	    break
	}
	/* 根据直播延迟时间延迟处理营销工具推送消息 */
	let tTime = setTimeout(() => {
	  clearTimeout(tTime)
	  // 处理营销工具推送消息
	  marketTool(msg)
	}, this.live_delay)
})
function marketTool (msg) {
   switch (msg.type) {
      case SaleTool.RECOMMEND_CARD_PUSH:
         console.log('--推荐卡片--消息--')
         break
      case SaleTool.NAIRE:
         console.log('--发送问卷--消息--')
         break
       case RedBagTool.createRedBag:
         console.log('--红包消息--消息--')
         break
       case DrawTool.createDraw:
         console.log('--创建抽奖通知--消息--')
         break
       case DrawTool.endLottery:
         console.log('--抽奖结束--消息--')
         break
   }
}

错误码

VHALL_SDK客户端错误代码

使用方式

通过全局事件消息VHALL_ZK.EVENTS.ERROR进行监听

VHALL_ZK.$event.on(VHALL_ZK.EVENTS.ERROR, (e) => {
  console.error(e)
})

错误码表

错误码	说明
10000	消息体格式不正确
10001	参数不能为空
10002	聊天输入不能超过120个字符
20000	成功
20001	验证信息不正确
20002	接口请求失败
20003	活动不存在
40000	直播中不能seek
50400	用户身份认证错误

SDKDemo

视频观看模块功能API 说明

体验demo

H5-demo：

https://static-zhike.vhall.com/fe_h5_demo_prod/dist/index.html#/watch/活动id

PC-demo：

https://static-zhike.vhall.com/fe_pc_demo_prod/dist/index.html#/watch/活动id

获取demo

H5-demo：

https://github.com/vhall/VHZk_H5_Demo

PC-demo：

https://github.com/vhall/VHZk_PC_Demo

更新记录

v1.0.0

JSSDK v1.0.0 更新记录

【新增】功能

分类	功能	描述
聊天	观看端聊天	支持在直播时聊天和观看回放时聊天
视频	观看端视频	支持移动端和PC端观看直播视频和回放视频
文档	观看端文档	支持移动端和PC端观看文档演示（移动端不支持文档笔触信息）
暖场	观看端暖场	支持暖场视频的播放及配置获取
回放	观看端回放	支持回放视频的播放及配置获取
公告	观看端公告	支持观看端显示公告消息
红包	观看端实时红包	抢红包功能
推荐卡片	观看端推荐卡片	观看端实时推荐卡片分享
问卷	观看端问卷	实时收到问卷信息，并提供填写问卷
抽奖	观看端抽奖	支持直播时抽奖消息响应，及查看中奖人信息
弹幕	观看端视频弹幕	观看端视频发送实时弹幕
自定义菜单	观看端菜单	支持自定义菜单的实时变更通知显示（包括：排行榜，热门直播，媒体推广，自定义富文本）
点赞	观看端点赞	支持点赞及实时点赞通知
聊天审核	观看端聊天审核通知	支持聊天审核开关通知
踢出	观看端用户被踢出	支持观看端用户实时被踢出通知
禁言	观看端用户被禁言	支持观看端用户实时被禁言通知
聊天删除	观看端用户聊天实时删除通知	支持观看端用户聊天实时删除通知
虚拟人数	观看端虚拟人数	支持观看端虚拟人数实时通知

帮助和工具

暂无

在线API测试工具

暂无

历史文档(历史版本)

历史文档

历史接口文档，不在维护

开放接口

简介

微吼知客接口文档

公共参数

参数	类型	是否必选	备注
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                                                                      //总数
    }
}

微吼知客 开放平台接口文档

产品简介

产品简介

产品介绍

产品介绍

历史版本介绍

历史版本介绍

常见问题

常见问题

开放API文档

开放API文档

API介绍

API简介

接入步骤

权限密钥

API接入方案

API调用

调用方式

概述

请求结构

接口URL

通信协议

请求方法

请求参数

字符编码

公共参数

公共参数包括

公共请求参数

返回结果

返回值

成功结果示例

错误结果示例

响应公共参数说明

其它响应字段说明

请求示例PHP版

错误码

签名机制

签名机制

DEMO

IP白名单

IP白名单

活动管理

直播管理

获取活动列表

接口：获取活动列表接口

请求URL:

参数:

返回示例:

返回参数说明:

备注:

获取知客活动列表

接口：获取知客活动列表接口

请求URL:

参数:

返回示例:

返回参数说明:

备注:

根据活动id删除活动

接口：根据活动ID删除活动

请求URL:

参数:

返回示例:

返回参数说明:

备注:

获取活动详情

接口：根据活动id获取活动详情

请求URL:

参数:

返回示例:

返回参数说明:

备注:

修改活动基本信息

接口：根据活动id修改活动信息

请求URL:

参数:

返回示例:

返回参数说明:

备注:

编辑活动的子模块信息

接口：编辑活动子模块信息

微吼知客开放平台接口文档

互动数据统计数据：分享、点赞、连麦、试看

接口：互动数据统计数据：分享、点赞、连麦、试看