npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ray-js/wechat-ms-voip

v0.0.6

Published

VoIP Page SDK

Downloads

139

Readme

@ray-js/wechat-ms-voip 该 SDK 提供了小程序VoIP通话和增值服务商城能力。

安装

yarn add @ray-js/wechat-ms-voip
// or
npm install @ray-js/wechat-ms-voip

getCommodityList

查询门锁可购买增值服务列表

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :--------- | :----- | :-------------------------- | -------- | | device_id | string | 设备 ID | true | | app_scheme | string | app的scheme | false | | os_system | string | 设备操作系统 ios or android | true |

返回参数

| 参数名 | 类型 | 描述 | | :------------ | :------ | :------------------------------- | | commodityCode | string | 商品代码 | | serviceCode | string | 服务代码 | | title | string | 商品标题 | | subTitle | string | 商品副标题 | | commodityUrl | string | 购买商品的 URL | | targetUrlType | number | 目标URL类型 0:h5 1:mini | | prices | Price[] | 价格列表 | | uuid | string | 设备的 UUID | | skuCode | string | 商品的 SKU 代码 | | type | number | 商品类型 0: 云存储 1: VoIp 2: AI |

Price

| 参数名 | 类型 | 描述 | | :---------------- | :----------------- | :------------------------------- | | price | number | 价格 | | strPrice | string | 价格字符串 | | originalPrice | number | 原始价格 | | strOriginalPrice | string | 原始价格字符串 | | currency | string | 货币 | | periodUnit | number | 周期单位 1: 年 2: 月 3: 日 4: 周 | | periodValue | number | 周期值 | | periodType | number | 周期类型 0: NORMAL 1: SUBSCRIBE | | marketingStrategy | IMarketingStrategy | 营销策略 | | optionType | number | 选项类型 | | optionNo | number | 选项编号 |

IMarketingStrategy

| 参数名 | 类型 | 描述 | | :---------- | :----- | :--------------------- | | discount | number | 折扣 百分比 20 => 20% | | periodUnit | number | 试用期单位 1: 年 3: 日 | | periodValue | number | 试用期周期数 |

getAppMallInfo

查询商城信息

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :------ | -------- | | device_id | string | 设备 ID | true | | catalog_code | string | 服务大类code | true |

返回参数

| 参数名 | 类型 | 描述 | | :------- | :----- | :------- | | mallCode | string | 商城编码 | | shopCode | string | 店铺编码 | | siteCode | string | 销售站点 | | currency | string | 销售币种 |

getDeviceAddValueType

查询设备支持的增值服务

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :------ | -------- | | device_id | string | 设备 ID | true |

返回参数

| 参数名 | 类型 | 描述 | | :----- | :----- | :--------------------------------------- | | icon | string | 图标 | | id | string | ID | | name | string | 名称 | | types | array | 设备支持的增值服务列表 0: 云存储 1: VoIP |

getDeviceList

查询当前家庭下设备列表

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :------- | :----- | :------ | -------- | | owner_id | string | 家庭 ID | true |

返回参数

| 参数名 | 类型 | 描述 | | :----------- | :----- | :----------- | | name | string | 设备名称 | | id | string | 设备 ID | | icon | string | 设备图标 | | locationName | string | 设备位置名称 | | types | array | 商品类型列表 |

getDeviceCapability

查询设备是否拥有相应的高级能力

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :----------------- | -------- | | device_id | string | 设备 ID | true | | code | string | 设备的高级能力code | true |

返回参数

| 参数名 | 类型 | 描述 | | :------------ | :----- | :------------------------- | | WechatMPAppid | string | 设备绑定的微信小程序 AppId | | WechatMPMid | string | 设备绑定的微信小程序 Mid | | WechatMPOid | string | 设备绑定的微信小程序 Oid |

getOrderList

获取订单列表

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------------- | :------------ | :----------- | -------- | | mallCode | string | 商城code | true | | siteCode | string | 站点code | true | | searchKey | string | 搜索关键字 | false | | orderStatusList | OrderStatus[] | 订单状态列表 | false | | pageNo | number | 页码 | true | | pageSize | number | 每页大小 | true |

OrderStatus string

示例 | 值 | 含义 | | :------------ | :--------------- | | created | 已创建,待支付 | | pending_audit_paid | 待审核 | | paying | 支付中 | | paid | 已支付 | | delivering | 发货中 | | delivered | 已发货 | | part_delivered | 已部分发货 | | finished | 已完成 | | canceled | 已取消 | | closed | 已关闭 | | refunded | 已退款 |

返回参数

| 参数名 | 类型 | 描述 | | :---------- | :----------- | :----------- | | data | IOrderInfo[] | 订单信息列表 | | pageCount | number | 页数 | | pageNum | number | 页码 | | pageSize | number | 每页数量 | | totalRecord | number | 总记录数 |

IOrderInfo

| 参数名 | 类型 | 描述 | | :------------------ | :-------------------- | :----------- | | orderBaseInfo | IOrderBaseInfo | 订单基础信息 | | orderCommodityInfos | IOrderCommodityInfo[] | 商品信息列表 | | orderLogisticsInfo | IOrderLogisticsInfo | 物流信息 |

IOrderBaseInfo

| 参数名 | 类型 | 描述 | | :--------------- | :-------- | :----------- | | afterSaleEnabled | boolean | 是否支持售后 | | amOrder | boolean | 是否AM订单 | | amountOrigin | number | 原始金额 | | amountTrade | number | 成交金额 | | currency | string | 货币 | | gmtCreate | string | 创建时间 | | mallInfo | IMallInfo | 商城信息 | | orderId | string | 订单号 | | orderStatus | string | 订单状态 | | orderTypeCode | string | 订单类型代码 | | tradeType | string | 交易类型 | | totalQuantity | number | 总数量 |

IMallInfo

| 参数名 | 类型 | 描述 | | :------- | :----- | :------- | | mallCode | string | 商城编码 | | shopCode | string | 店铺编码 | | siteCode | string | 销售站点 |

IOrderCommodityInfo

| 参数名 | 类型 | 描述 | | :--------------- | :--------------- | :----------- | | afterSaleEnabled | boolean | 是否支持售后 | | commodityCode | string | 商品代码 | | commodityName | string | 商品名称 | | commodityType | number | 商品类型 | | iconUrl | string | 图标URL | | quantity | number | 数量 | | skuCode | string | SKU代码 | | skuSrvPeriodDTO | ISkuSrvPeriodDTO | SKU 服务周期 | | skuValueList | string[] | SKU 值列表 | | unitPriceOrigin | number | 原始单价 | | unitPriceTrade | number | 成交单价 |

ISkuSrvPeriodDTO

| 参数名 | 类型 | 描述 | | :------------- | :----- | :----------- | | skuCode | string | SKU代码 | | srvCode | string | 服务代码 | | srvPeriodUnit | number | 服务周期单位 | | srvPeriodValue | number | 服务周期值 |

IOrderLogisticsInfo

| 参数名 | 类型 | 描述 | | :---------------- | :------ | :------- | | orderLogisticsTag | boolean | 物流标签 |

getSubscriptionOrderList

获取订阅的订单列表

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :------- | :----- | :------- | -------- | | pageSize | number | 每页大小 | true | | pageNo | number | 页码 | true | | siteCode | string | 站点code | true | | mallCode | string | 商城code | true |

返回参数

| 参数名 | 类型 | 描述 | | :------- | :--------------- | :----------- | | data | ISubscribeData[] | 订阅数据列表 | | index | number | 索引 | | pageNum | number | 页码 | | pageSize | number | 每页数量 |

ISubscribeData

| 参数名 | 类型 | 描述 | | :-------------- | :-------------- | :----------- | | gmtNextTime | number | 下次时间 | | orderListModel | IOrderListModel | 订单列表模型 | | paidProvider | number | 支付提供商 | | regularInterval | number | 定期间隔 | | regularUnit | number | 定期单位 | | status | number | 状态 | | subscribeId | string | 订阅ID |

IOrderListModel

| 参数名 | 类型 | 描述 | | :------------- | :----------- | :----------- | | amountOrigin | number | 原始金额 | | amountTrade | number | 成交金额 | | currency | string | 货币 | | mallInfo | IMallInfo | 商城信息 | | orderGmtCreate | number | 订单创建时间 | | orderId | string | 订单ID | | orderItemList | IOrderItem[] | 订单项列表 | | orderStatus | string | 订单状态 | | quantity | number | 数量 |

IOrderItem

| 参数名 | 类型 | 描述 | | :----------- | :------- | :-------- | | amountOrigin | number | 原始金额 | | amountTrade | number | 成交金额 | | currency | string | 货币 | | quantity | number | 数量 | | skuCode | string | SKU代码 | | skuPic | string | SKU图片 | | skuValueList | string[] | SKU值列表 | | title | string | 标题 |

getServiceIntroduction

获取服务介绍

无请求参数

返回参数

| 参数名 | 类型 | 描述 | | :--------- | :--------- | :------- | | moduleList | ModuleList | 模块列表 |

ModuleList

| 参数名 | 类型 | 描述 | | :--------------- | :----------------- | :------- | | serviceProtocol | ServiceProtocol[] | 服务协议 | | serviceIntro | ServiceIntro[] | 服务介绍 | | serviceLightSpot | ServiceLightSpot[] | 服务亮点 | | serviceName | ServiceName[] | 服务名称 | | configItem | ConfigItem[] | 配置项 |

ServiceProtocol

| 参数名 | 类型 | 描述 | | :------- | :----- | :----- | | color | string | 颜色 | | display | number | 显示 | | subtitle | string | 副标题 | | subType | string | 子类型 | | id | number | ID | | cfgId | number | 配置ID | | lang | string | 语言 | | title | string | 标题 | | type | string | 类型 | | content | string | 内容 | | seq | number | 序列 |

ServiceIntro

| 参数名 | 类型 | 描述 | | :------------- | :----- | :------- | | color | string | 颜色 | | display | number | 显示 | | subtitle | string | 副标题 | | attachmentJson | object | 附件JSON | | subType | string | 子类型 | | id | number | ID | | cfgId | number | 配置ID | | lang | string | 语言 | | title | string | 标题 | | type | string | 类型 | | content | string | 内容 | | seq | number | 序列 |

ServiceLightSpot

| 参数名 | 类型 | 描述 | | :------------- | :----- | :------- | | color | string | 颜色 | | display | number | 显示 | | subtitle | string | 副标题 | | attachmentJson | object | 附件JSON | | subType | string | 子类型 | | id | number | ID | | cfgId | number | 配置ID | | lang | string | 语言 | | title | string | 标题 | | type | string | 类型 | | content | string | 内容 | | seq | number | 序列 |

ServiceName

| 参数名 | 类型 | 描述 | | :------------- | :----- | :------- | | color | string | 颜色 | | display | number | 显示 | | subtitle | string | 副标题 | | attachmentJson | object | 附件JSON | | subType | string | 子类型 | | id | number | ID | | cfgId | number | 配置ID | | lang | string | 语言 | | title | string | 标题 | | type | string | 类型 | | content | string | 内容 | | seq | number | 序列 |

ConfigItem

| 参数名 | 类型 | 描述 | | :------- | :----- | :----- | | color | string | 颜色 | | display | number | 显示 | | subtitle | string | 副标题 | | subType | string | 子类型 | | id | number | ID | | cfgId | number | 配置ID | | lang | string | 语言 | | title | string | 标题 | | type | string | 类型 | | content | string | 内容 | | seq | number | 序列 |

getServiceListByDevice

根据设备ID查询已经购买的服务凭证列表

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :------ | -------- | | device_id | string | 设备 ID | true |

返回参数

| 参数名 | 类型 | 描述 | | :---------- | :------------ | :--------- | | name | string | 服务名称 | | code | string | 服务代码 | | startTime | number | 开始时间 | | endTime | number | 结束时间 | | tags | ServiceTag[] | 标签列表 | | isFree | boolean | 是否免费 | | isAY | boolean | 是否为国区 | | isExit | boolean | 是否退出 | | type | CommodityType | 商品类型 | | isPermanent | boolean | 是否永久 |

ServiceTag

| 参数名 | 描述 | | :--------------- | :------- | | freeTrial | 免费试用 | | automaticRenewal | 自动续期 |

getVoipAuthUser

查询voip默认推送用户

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :------ | -------- | | device_id | string | 设备 ID | true |

返回参数

| 参数名 | 类型 | 描述 | | :-------- | :------ | :-------------------------------- | | userId | string | 用户Id | | avatarUrl | string | 用户头像Url | | userName | string | 用户名称 | | isAuth | boolean | 云端保存的VoIP授权状态 不一定准确 | | isValid | boolean | 用户状态是否失效 |

saveWXVoipAuth

保存设备设置voip的微信授权情况,用于通过微信api获取voip的授权状态后同步到云端

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :----------- | -------- | | device_id | string | 设备 ID | true | | auth_tag | number | voip授权状态 | true |

返回参数

boolean: 是否保存成功

saveVoipAuthUser

保存设备voip默认推送用户

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :------ | -------- | | device_id | string | 设备 ID | true | | user_id | string | 用户 ID | true |

返回参数

boolean: 是否保存成功

getDeviceWXUserInfo

查询微信用户信息,用于查询云端提供的用户的openId

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :----- | :------ | -------- | | app_id | string | 小程序app ID | true |

返回参数

| 参数名 | 类型 | 描述 | | :----- | :----- | :--------------------- | | openId | string | 云端提供的用户的openId | | userId | string | 用户Id |

微信小程序购买VoIP的回调函数

buyIncreaseServiceByWx

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :--------- | :---------------- | :--------------------- | -------- | | device_id | string | 设备 ID | true | | mallCode | string | 商城 code | true | | siteCode | string | 商城站点 code | true | | currency | string | 商城 货币 | true | | skuCode | string | 当前选中商品的sku code | true | | optionType | string | 当前选中商品的付费方式 | true | | optionNo | string | 当前选中商品的付费项 | true | | homeId | string | 家庭 id | true | | openId | string | 微信 openId | true | | name | string | 设备名称 | true | | uuid | string | 设备uuid | true | | wxAppId | string | 微信小程序 appId | true | | success | (success) => void | 购买成功回调 | false | | fail | (fail) => void | 购买失败回调 | false |

VoIP服务授权

voipServiceAuthorization

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :---------------- | :----------- | -------- | | device_id | string | 设备 ID | true | | name | string | 设备名称 | true | | uuid | string | 设备uuid | true | | success | (success) => void | 授权成功回调 | false | | fail | (fail) => void | 授权失败回调 | false |

兑换VoIP兑换码

exchangeCode

请求参数

| 参数名 | 类型 | 描述 | 是否必传 | | :-------- | :---------------- | :----------- | -------- | | device_id | string | 设备 ID | true | | homeId | string | 家庭 ID | true | | code | string | 兑换码 | true | | name | string | 设备名称 | true | | uuid | string | 设备uuid | true | | success | (success) => void | 兑换成功回调 | false | | fail | (fail) => void | 兑换失败回调 | false |