1.1 开放接口

1.1.1 登录

API： mos.login(appKey)

支持以 Promise 风格调用。

参数

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

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
code	string	登录凭证

1.1.2 分享文本

API： mos.shareToApp(content)

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

参数

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

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败

1.1.3 获取用户信息

API： mos.getUserInfo(Object object)

支持以 Promise 风格调用。每次请求都会弹出授权窗口。

参数

[Object object]

属性	类型	必填	说明	最低版本
authorizedDesc	string	否	获取授权信息的用处
closeOnClickOverlay	string	否	是否在点击遮罩层后关闭弹窗，0: 不关闭 1: 关闭	1.1.2

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败 \| CANCEL: 用户取消
authorized	number	0: 不授权 \| 1: 授权 \| 2: 没有对应信息
firstName	string	姓
lastName	string	名
headPortrait	string	头像地址
descriptor	string	个人简介

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

API： mos.getUserContactInfo(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	必填	说明	最低版本
authorizedDesc	string	否	获取授权信息的用处
closeOnClickOverlay	string	否	是否在点击遮罩层后关闭弹窗，0: 不关闭 1: 关闭	1.1.2

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败 \| CANCEL: 用户取消
authorized	number	0: 不授权 \| 1: 授权 \| 2: 没有对应信息
dialCode	string	区号
phone	string	手机号码
email	string	邮箱地址

1.1.5 获取用户唯一签名

API： mos.getSign()

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

参数

无

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
sign	string	签名

1.1.6 获取当前语言

API： mos.getLanguage()

支持以 Promise 风格调用。

参数

无

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
lang	string	语言，如 en_US

1.1.7 设置分享链接

API： mos.setShareLink(link)

支持以 Promise 风格调用。

参数

属性	类型	必填	说明
link	string	是	待分享的链接

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败

1.1.8 调起支付

API： mos.pay(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	必填	说明
amount	string	是	支付金额
currency	string	是	币种，USD: 美元 \| KHR: 瑞尔
appKey	string	是	微应用 appKey
prepayId	string	是	订单预支付 ID

响应

属性	类型	说明
result	string	SUCCESS: 成功 \| CANCEL: 用户取消 \| NOWALLET: 钱包不可用（未绑定钱包/未设置支付密码）
data	string	支付结果为 SUCCESS 时才有，值为服务端返回的信息

1.1.9 获取窗口信息

API： mos.getWindowInfo()

支持以 Promise 风格调用。

参数

无

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
statusBarHeight	number	状态栏高度

1.1.10 获取设备信息

API： mos.getAppBaseInfo()

支持以 Promise 风格调用。

参数

无

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
platform	string	客户端平台，'IOS' \| 'ANDROID'
SDKVersion	string	支持的 mos-js 库版本, 如: 1.1.0
language	string	客户端语言, 如: 'en-US'
version	string	客户端版本号, 如: '1.0.0'
deviceId	string	设备唯一识别码
brand	string	设备品牌
system	string	操作系统及版本

1.1.11 分享微应用页面

API： mos.shareMiniApp(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	必填	说明
query	string \| object	否	启动参数
shareDisabled	string	否	是否禁用分享 1: 禁用 \| 0: 启用
desc	string	否	页面描述，通常为当前页面标题
imageUrl	string	否	微应用消息上展示的图片地址，网络图片路径，建议https地址
screenShotDisabled	string	否	是否禁止屏幕截图用于微应用消息的页面图片展示 1: 禁止截图 \| 0: 自动截图

TIP

query 字段说明：

若 query 为对象类型，且有 ogLang 属性，则页面解析og标签时优先使用该属性值作为语言，ogLang取值为：
- zh-CN - 简体中文
- en-US - English
- km-KH - ភាសាខ្មែរ
- ja-JP - 日本語
- vi-VN - Tiếng Việt
- zh-HK - 繁體中文(香港)
- zh-TW - 繁體中文(臺灣)
- th-TH - ภาษาไทย
- ms-MY - Bahasa Melayu
- ko-KR - 한국어
- id-ID - Bahasa Indonesia
- lo-LA - ລາວ
- hi-IN - हिन्दी

图片展示规则：

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

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
shareLink	string	当前页面的链接地址，如：https://mp.mos.me/mp/小程序id?query=xxxxx

1.1.12 单次分享小程序数据，通知移动端打开转发到会话的页面

API： mos.shareMiniAppData(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	必填	说明
query	string \| object	否	启动参数
shareDisabled	string	否	是否禁用分享 1: 禁用 \| 0: 启用
desc	string	否	页面描述，通常为当前页面标题
imageUrl	string	否	微应用消息上展示的图片地址，网络图片路径，建议https地址
screenShotDisabled	string	否	是否禁止屏幕截图用于微应用消息的页面图片展示 1: 禁止截图 \| 0: 自动截图

TIP

query 字段说明：

若 query 为对象类型，且有 ogLang 属性，则页面解析og标签时优先使用该属性值作为语言，ogLang取值为：
- zh-CN - 简体中文
- en-US - English
- km-KH - ភាសាខ្មែរ
- ja-JP - 日本語
- vi-VN - Tiếng Việt
- zh-HK - 繁體中文(香港)
- zh-TW - 繁體中文(臺灣)
- th-TH - ภาษาไทย
- ms-MY - Bahasa Melayu
- ko-KR - 한국어
- id-ID - Bahasa Indonesia
- lo-LA - ລາວ
- hi-IN - हिन्दी

图片展示规则：

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

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
shareLink	string	当前页面的链接地址，如：https://mp.mos.me/mp/小程序id?query=xxxxx

1.1.13 获取启动参数

API： mos.getLaunchOptions()

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

参数

无

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
query	string \| object	启动参数

1.1.14 添加事件埋点统计

API： mos.addTrackingEvent(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	必填	说明
name	string	是	事件名称
data	string	否	JSON 字符串

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败

1.1.15 打开原生客服号聊天界面

API： mos.folderLinkClick(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	必填	说明
link	string	是	客服号链接，如：https://mos.me/xxxxyyyyzzz
query	object	否	支持客户来源、上下文功能等参数

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败

1.2 设备

1.2.1 扫码

API： mos.scanCode()

支持以 Promise 风格调用。

参数

无

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败(当获取不到摄像头或没有摄像头权限时)' \| CANCEL': 用户取消
code	string	二维码值

1.2.2 打电话

API： mos.makePhoneCall(phoneNumber)

支持以 Promise 风格调用。

参数

属性	类型	必填	说明
phoneNumber	string	是	手机号码

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败

1.2.3 设置状态栏样式

API： mos.setStatusbar(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	默认值	必填	说明
show	string	1	否	1: 显示 \| 0: 不显示
style	string	dark	否	状态栏字体样式，dark: 黑色 \| light: 白色

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败

1.3 位置

1.3.1 获取定位

API： mos.getLocation(Object object)

支持以 Promise 风格调用。

参数

[Object object]

属性	类型	默认值	必填	说明
isHighAccuracy	string	0	否	开启高精度定位，1: 开启 \| 0: 不开启
highAccuracyExpireTime	string	30000	否	高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
latitude	string	纬度，范围为 -90~90，负数表示南纬
longitude	string	经度，范围为 -180~180，负数表示西经
address	string	地址信息
speed	string	速度，单位 m/s
accuracy	string	位置的精确度，反应与真实位置之间的接近程度，可以理解成10即与真实位置相差10m，越小越精确
altitude	string	高度，单位 m
verticalAccuracy	string	垂直精度，单位 m
horizontalAccuracy	string	水平精度，单位 m（Android 无法获取，返回 0）

TIP

当开启高精度定位时，若 highAccuracyExpireTime 设置过低可能导致获取定位失败。

1.4 文件

1.4.1 下载网络文件

API： mos.downNetFile(Object object)

支持以 Promise 风格调用。如果为图片或视频类型则保存到相册。

参数

[Object object]

属性	类型	默认值	必填	说明
fileUrl	string		是	文件在线地址，https或http开头
fileName	string		否	文件名称，不带后缀名，为空时自动获取文件在线地址的名称
fileExt	string		否	文件类型，如txt、png等，为空时根据文件在线地址自动判断文件类型
showLoading	string	1	否	是否显示loading，1: 显示 0: 隐藏
showMsg	string	1	否	是否显示保存成功或失败的提示，1: 显示 0: 隐藏

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
message	string	错误信息
data	string	保存的文件路径

1.4.1 下载本地文件

API： mos.downLocalFile(Object object)

支持以 Promise 风格调用。如果为图片或视频类型则保存到相册。

参数

[Object object]

属性	类型	默认值	必填	说明
file	file		是	文件对象
fileName	string		否	文件名称，不带后缀名，为空时自动获取文件对象中的名称
fileExt	string		否	文件类型，如txt、png等，为空时根据文件对象自动判断文件类型
showLoading	string	1	否	是否显示loading，1: 显示 0: 隐藏
showMsg	string	1	否	是否显示保存成功或失败的提示，1: 显示 0: 隐藏

响应

属性	类型	说明
result	string	'SUCCESS': 成功 \| 'FAILURE': 失败
message	string	错误信息
data	string	保存的文件路径

1.1 开放接口 ​

1.1.1 登录 ​

参数 ​

响应 ​

1.1.2 分享文本 ​

参数 ​

响应 ​

1.1.3 获取用户信息 ​

参数 ​

[Object object] ​

响应 ​

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

参数 ​

[Object object] ​

响应 ​

1.1.5 获取用户唯一签名 ​

参数 ​

响应 ​

1.1.6 获取当前语言 ​

参数 ​

响应 ​

1.1.7 设置分享链接 ​

参数 ​

响应 ​

1.1.8 调起支付 ​

参数 ​

[Object object] ​

响应 ​

1.1.9 获取窗口信息 ​

参数 ​

响应 ​

1.1.10 获取设备信息 ​

参数 ​

响应 ​

1.1.11 分享微应用页面 ​

参数 ​

[Object object] ​

响应 ​

1.1.12 单次分享小程序数据，通知移动端打开转发到会话的页面 ​

参数 ​

[Object object] ​

响应 ​

1.1.13 获取启动参数 ​

参数 ​

响应 ​

1.1.14 添加事件埋点统计 ​

参数 ​

[Object object] ​

响应 ​

1.1.15 打开原生客服号聊天界面 ​

参数 ​

[Object object] ​

响应 ​

1.2 设备 ​

1.2.1 扫码 ​

参数 ​

响应 ​

1.2.2 打电话 ​

参数 ​

响应 ​

1.2.3 设置状态栏样式 ​

参数 ​

[Object object] ​

响应 ​

1.3 位置 ​

1.3.1 获取定位 ​

参数 ​

[Object object] ​

响应 ​

1.4 文件 ​

1.4.1 下载网络文件 ​

参数 ​

[Object object] ​

响应 ​

1.4.1 下载本地文件 ​

参数 ​

[Object object] ​

响应 ​

1.1 开放接口

1.1.1 登录

参数

响应

1.1.2 分享文本

参数

响应

1.1.3 获取用户信息

参数

[Object object]

响应

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

参数

[Object object]

响应

1.1.5 获取用户唯一签名

参数

响应

1.1.6 获取当前语言

参数

响应

1.1.7 设置分享链接

参数

响应

1.1.8 调起支付

参数

[Object object]

响应

1.1.9 获取窗口信息

参数

响应

1.1.10 获取设备信息

参数

响应

1.1.11 分享微应用页面

参数

[Object object]

响应

1.1.12 单次分享小程序数据，通知移动端打开转发到会话的页面

参数

[Object object]

响应

1.1.13 获取启动参数

参数

响应

1.1.14 添加事件埋点统计

参数

[Object object]

响应

1.1.15 打开原生客服号聊天界面

参数

[Object object]

响应

1.2 设备

1.2.1 扫码

参数

响应

1.2.2 打电话

参数

响应

1.2.3 设置状态栏样式

参数

[Object object]

响应

1.3 位置

1.3.1 获取定位

参数

[Object object]

响应

1.4 文件

1.4.1 下载网络文件

参数

[Object object]

响应

1.4.1 下载本地文件

参数

[Object object]

响应