微信小程序音视频通话（for 硬件）

使用手册

1 产品介绍

1.1 基础介绍

借助微信小程序音视频通话（for 硬件）组件，开发者可以实现智能设备和手机微信端的一对一音视频通话，满足实时触达场景，提升通话体验。

下图为手机端示意图，授权弹窗、通话提醒、通话界面为微信提供的统一界面，硬件小程序接入微信VoIP通话插件后，可实现上述功能。

1.2 适用场景

微信小程序音视频通话（for 硬件）组件，适用于校园话机、门禁机、智能门锁、智慧中控屏、智能电视、智能摄像头、智能音箱、智慧养老等多种设备和场景，支持硬件设备和手机端双向通话，实现通话强提醒。

2 接入门槛

2.1 硬件要求

硬件不需要改造，需具备音频或者视频能力

● 安卓平台

（向下兼容技术研发中）

系统版本7.1 及以上

四核 2GHz CPU

内存 2GB RAM + 8GB ROM

●Linux平台

（后续将持续更新）

C++：提供 libstdc++.so.6，且支持 C++14

音频输入：必须支持 PCM，可选支持 OPUS、G711、G729

音频输出：PCM

视频输入（如有摄像头）：H.264 编码的视频流

如果设备采用 EMMC，需确保 RPMB 分区未被使用

2.2 软件要求

- 小程序主体已认证；

- 小程序主体公司营业执照经营范围包括硬件设备销售等；

- 小程序具备“工具-设备管理”类目，并开通设备管理功能；

3 如何接入

3.1 接入前准备工作

注：安卓设备与linux设备在账号接入准备和开发接入上有所不同，参考下图：

以下3.1.2、3.1.3、3.1.4 注册工作可并行，该部分涉及审核工作，请提前准备，此部分预计耗时2～5个工作日

3.1.1 设备

需有1台满足接入条件的设备（确认设备的RPMB 分区没有被使用过，具有音视频能力)

3.1.2 微信开放平台（Linux设备不需进行这一步）

需有企业主体的微信开放平台帐号并成功绑定一款移动应用（手机端的App，未上架也可，提交审核时需要注意企业官网要有该App介绍），已有移动应用也可以直接用，注意需要获取 host appid 微信开放平台

（1）  注册开放平台账号

（2）  添加移动应用

（3）  获取移动应用id（移动应用id即hostAppid）

3.1.3 微信终端合作平台（Linux设备不需进行这一步）

需有一个企业主体的wecooper平台帐号 微信终端合作平台，并按照小程序硬件框架流程指引绑定3.1.2和3.1.4的账号，并注册设备、登记型号、获得公钥等；

（1）  微信终端合作平台账号注册

（2）  绑定开放平台的移动应用和小程序（图二中appid应填写hostAppid，即开放平台移动应用id，其获取见上方3.1.2.(3) )

（3）  登记硬件设备信息

a).添加设备类型

b).添加设备机型

c).设置公钥

（4）  硬件注册

通过【微信终端合作平台】-【申请注册设备】提审获取注册设备接口权限，请确认已完成登记设备信息再注册，否则审核可能不通过。

3.1.4微信小程序

需有企业主体的微信小程序帐号微信公众平台 ，并在小程序管理后台添加“工具-设备管理”类目、左侧“硬件设备-设备管理”添加你需要接入的设备并提交审核（注意需要获取model_id），申请设备的小程序音视频能力，能力申请无需审核（插件自动通过）；开发完成后，你需要验证设备能力，包括提交设备体验视频、以及邮寄设备给微信团队进行审核，审核通过后能力可正式发布。

（1）  注册小程序账号（若已有小程序，可忽略这步）

（2）  调用接口获取小程序的access_token

（3）  添加类目和设备

在小程序管理后台【设置】添加【工具-设备管理】类目

在小程序管理后台【功能】-【硬件设备】-【设备管理】添加设备并提审，获取model_id

（4）  申请和验证设备能力-小程序音视频能力

申请设备能力

在小程序管理后台【功能】-【硬件设备】-【设备管理】选择对应设备，点击申请设备能力，设备能力选择小程序音视频能力，填写具体的申请理由，提交申请。

验证设备能力

设备的小程序音视频能力申请通过后，点击验证能力

验证能力分为四步：下载配置SDK、下载硬件框架、视频验证、寄送设备验证

注：视频验证和寄送设备验证审核要求见硬件VoIP审核验证要求

1）下载配置SDK（根据不同设备所属平台选择不同SDK）

2）下载硬件框架（Linux设备不需这一步）

3）视频验证

4）寄送设备验证

填写寄送信息

寄送信息验证中

寄送信息验证成功

（5）购买小程序音视频通话License套餐

开通小程序音视频能力后可获得10个7天有效期的体验license（所有设备类型通用）。体验license使用完，需要采购小程序音视频通话-设备license套餐。你可以在小程序管理后台——左侧付费管理——硬件能力——小程序音视频通话（设备license套餐）中进行购买。设备license套餐分为A、B、C、D、E五种类型，对应不同设备混用，采购时需注意选择适合小程序设备的license套餐。

3.2 开发流程

接入微信硬件VoIP，你需要在硬件端、小程序端进行开发运行同一款微信小程序。微信将提供统一的SDK（插件），你的小程序需开通并调用该插件。此部分预计耗时5～10个工作日，具体接入流程请参考小程序音视频通话（for 硬件）|微信开放文档

其中安卓端硬件开发文档参考：开发安卓设备端应用

linux端硬件开发文档参考：小程序音视频通话SDK（linux）

4 常见问题及反馈渠道

其他开发相关的功能介绍和常见问题请参考小程序音视频通话（for 硬件）|微信开放文档

4.1 接入VOIP 通话插件时，应选择哪种业务类型 (businessType)？

所有设备均可使用「手机微信拨打硬件设备」或「硬件设备拨打手机微信」。如针对校园场景的官方刷脸能力有特殊需求，可选择「校园场景支付刷脸模式」。

4.2 手机端通话结束后，结束页面有个『关闭』按钮，是否可以直接关闭小程序？

暂不支持，所有小程序的关闭都是需要点击右上角的「胶囊」关闭。但可以设置点击关闭按钮后跳转去小程序的其他页面。参考插件文档「4.2 自定义通话结束跳转页」

4.3 点击右上角胶囊有「退出设备登录」和「关闭小程序」的选项，可以去掉吗？

可以隐藏。向行业经理提交需求，待平台开权限后，安卓应用去调用 WMPF initGlobalConfig 接口，传closeButtonActionType: 10即可实现。设置完打开小程序，预期点击胶囊按钮的关闭，会弹出“不支持关闭小程序”。

以下补充几点说明：

1）开通权限是给开发者配置是否可以禁用关闭小程序的能力，开通后还需要调用WMPF initGlobalConfig 接口，传closeButtonActionType: 10来实现禁用，框架不会自动禁用。

2）禁用会影响wmpf启动的所有小程序的所有页面。如有需要，禁用后，也可以通过传0来取消，实现根据业务场景动态控制。

3）禁用的表现是用户点击胶囊右侧时，不会弹出关闭小程序的菜单，并弹框提示用户当前不允许关闭。禁用后胶囊按钮不会被隐藏。

4）开通权限请在社群填写问卷申请，会有专人处理。

4.4 怎么找到音视频套餐包付费入口？

在小程序管理后台【功能】-【硬件设备】-【设备管理】选择对应设备，点击申请设备能力，设备能力选择【小程序音视频能力】，填写具体的申请理由，提交申请。申请会自动通过。点击验证能力，到达界面【验证小程序音视频能力】，点击【我的用量】。

4.5 设备的唯一性是怎么规定的？硬件开发者应该怎样配合？

我们要求硬件的emmc存储分区写入唯一key，且写入后不可更改，以保证设备的唯一性，从而保障通话安全。这样会要求：硬件开发者传给微信的设备sn不可变化，且硬件端运行的小程序只能为一个，不可更改。

如果遇到设备需要维修/售后的情况，强烈建议开发者不要随意更改设备sn，否则会影响用户通话权限。

4.6 小程序音视频通话License套餐的发票如何开具？

开发者可登录小程序管理后台，通过左侧“设备管理”进入，点击音视频通话能力的设备“查看用量”-“发票”，按每月已消耗的套餐去申请开票。

其他未涉及问题，可通过硬件服务社区向我们反馈。

VoIP在技术接入、查看用量和支付过程中遇到报错，应该怎么办？

可以多试几次。如依然出现相关问题，可以留言以下信息供我们定位：

- 问题描述：

- 小程序appid：

- 小程序名称：

- 小程序主体：

- 报错时间：

- 报错界面截图：