Skip to content

1.1 开放接口

1.1.1 登录

API: mos.login(appKey)

支持以 Promise 风格调用。

参数

属性类型必填说明
appKeystring微应用 appKey

响应

属性类型说明
codestringTODO

1.1.2 分享文本

API: mos.shareToApp(content)

支持以 Promise 风格调用。通过 mos 分享文本。

参数

属性类型必填说明
contentstring需要分享出去的文本内容

响应

示例代码

js
mos.shareToApp(content)

1.1.3 获取用户信息

API: mos.getUserInfo(authorizedDesc)

支持以 Promise 风格调用。需弹窗显示,用户点击授权后返回相应信息。

参数

属性类型必填说明
authorizedDescstring获取授权信息的用处

响应

属性类型说明
authorizednumber0-不授权 | 1-授权 | 2-没有对应信息
firstNamestring
lastNamestring
headPortraitstring头像地址
descriptorstring个人简介

1.1.4 获取用户手机号/邮箱信息

API: mos.getUserContactInfo(authorizedDesc)

支持以 Promise 风格调用。

参数

属性类型必填说明
authorizedDescstring获取授权信息的用处

响应

属性类型说明
authorizednumber0-不授权 | 1-授权 | 2-没有对应信息
dialCodestring区号
phonestring手机号码
emailstring邮箱地址

1.1.5 获取用户唯一签名

API: mos.getSign

支持以 Promise 风格调用。获取用户签名用来校验 mos 是否切换了用户。

参数

响应

属性类型说明
signstring签名

1.1.6 获取当前语言

API: mos.getLanguage

支持以 Promise 风格调用。

参数

响应

属性类型说明
langstring语言,如 en_US

1.1.7 设置分享链接

API: mos.setShareLink(link)

支持以 Promise 风格调用。

参数

属性类型必填说明
linkstring待分享的链接

响应

1.1.8 调起支付

API: mos.pay(Object object)

支持以 Promise 风格调用。错误提示需客户端处理。

参数

属性类型必填说明
amountstring支付金额
currencystring币种,USD-美元 | KHR-瑞尔
appKeystring微应用 appKey
prepayIdstring订单预支付ID

响应

属性类型说明
resultstring支付结果 SUCCESS-成功 | CANCEL-用户取消 | NOWALLET-钱包不可用(未绑定钱包/未设置支付密码)
datastring支付结果为 SUCCESS 时才有,值为服务端返回的信息

1.1.9 获取窗口信息

API: mos.getWindowInfo

支持以 Promise 风格调用。

参数

响应

属性类型说明
statusBarHeightnumber状态栏高度

1.1.10 分享微应用页面

API: mos.shareMiniApp(Object object)

支持以 Promise 风格调用。

参数

属性类型必填说明
querystring启动参数
shareDisabledstring是否禁用分享 1-禁用 | 0-启用
descstring页面描述,通常为当前页面标题
imageUrlstring微应用消息上展示的图片地址
screenShotDisabledstring是否禁止屏幕截图用于微应用消息的页面图片展示 1-禁止截图 | 0-自动截图

TIP

图片展示规则:

  • imageUrl 有值时优先使用 imageUrl 的值
  • imageUrl 为空时:
    • screenShotDisabled=1 不截图,页面图片展示默认图
    • screenShotDisabled=0 系统自动截图

响应

1.1.11 获取启动参数

API: mos.getLaunchOptions

支持以 Promise 风格调用。获取微应用启动时的 query 参数,例如 https://mp.mos.me/mp/<miniapp_id>?query=<query>

参数

响应

属性类型说明
querystring启动参数

1.2 设备

1.2.1 打电话

API: mos.chooseContact(phoneNumber)

支持以 Promise 风格调用。

参数

属性类型必填说明
phoneNumberstring手机号码

响应