资源工坊

业务 ​

获取用户授权 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持支持
const params = {
    app_id:'',
    scope_list:[]
};
window.ksoxz_sdk.requestAccess({params,onSuccess, onError});

输入参数 ​

参数类型描述备注
scope_liststring[]需要授权的scope必填，空数组则默认授予查询用户基础信息kso.user_base.read
app_idstring应用ID必填

输出参数 ​

参数类型描述备注
codestring用户授权临时授权码该参数用于调用获取用户授权access_token接口

错误码 ​

errnomsg备注
1043102Server api error,……服务端接口错误，输出具体接口错误

设置剪贴板数据 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持支持
const params = {
    text:'text'
};
window.ksoxz_sdk.setClipboard({params});

参数说明 ​

参数类型描述备注
textstring文本/

错误码
errnomsg含义
1021008Clipboard permission not obtained用户未授予App 剪贴板权限

获取剪贴板数据 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持支持
window.ksoxz_sdk.getClipboard({onSuccess, onError});

参数说明 ​

参数类型描述备注
textstring文本/

错误码
errnomsg含义
1021008Clipboard permission not obtained用户未授予App 剪贴板权限

分享 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持支持
const params = {
    type: 'webPage',
    content: {
        title: '金山软件欢迎你加入',
        url: 'https://www.kingsoft.com/',
        text: '描述内容xxx',
        image: 'https://bkimg.cdn.bcebos.com/pic/810a19d8bc3eb1352ac7091eac1ea8d3fd1f4416?x-bce-process=image/watermark,image_d2F0ZXIvYmFpa2UxMTY=,g_7,xp_5,yp_5/format,f_auto'
    }
};
window.ksoxz_sdk.shareMessage({params, onSuccess, onError});

参数说明 ​

参数类型描述是否必须备注
typestring分享类型是/
contentobject分享内容是/
channelTypestring[]分享平台否4.25新增
不填默认分享至协作平台
目前支持填入[wx]
channelObjectobject需要分享的JSON数据否4.25 新增
分享至第三方平台时需要填充的数据，填写方法详见参考

type ​

类型描述备注
text纯文本消息/
markdownMarkdown/
webPage链接分享/
miniProgram小程序4.25新增
目前只支持分享去微信平台

content 类型 ​

Text:

参数类型是否必须描述
textstring是分享描述文本

Markdown:

参数类型是否必须描述
textstring是分享描述文本

WebPage:

参数类型是否必须描述
urlstring是分享的 url
titlestring是分享标题
imagestring否分享配图 url，缺省使用 app 图标
textstring否分享描述文本

channelObject 类型 ​

Text:

参数类型是否必须描述
channelObjectobject否例子：详见下方示例代码（参考）

miniProgram:

参数类型是否必须描述
channelObjectobject否例子：详见下方示例代码（参考）
注意: 如果使用前端转换工具将图片转成base64编码时，可能会在base64编码开头携带图片格式信息(例如:data:image/png;base64,)。对于这种情况，需要在为image参数赋值时去掉图片格式信息。

WebPage:

参数类型是否必须描述
channelObjectobject否例子：详见下方示例代码（参考）
注意: 如果使用前端转换工具将图片转成base64编码时，可能会在base64编码开头携带图片格式信息(例如:data:image/png;base64,)。对于这种情况，需要在为image参数赋值时去掉图片格式信息。

示例代码(参考):

channelObject 类型 示例代码
text
json
{
  "text": "你好"
}
WebPage
json
{
  "title": "小程序标题",
  "description": "小程序描述",
  "webpageUrl": "https://www.baidu.com ",
  "thumbImage": "iVBORw0KGgoAAAANSUhEUgAAAHkAAAB4CAYAAADWpl3sAAAACXBIWXMAACE4AAAhOAFFljFgAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAATESURBVHgB7d0/bBxFFMfxN3tncjixOf4lIAQ6C1GBRAJdqosEbvNHoqAAUpoKF0QRVe4qBInkK5DsDiMXQIOdCgSRbApMlZBIFEgk8gWaJDQhIv7D3e6wE7C0OpGb2Z1beLvv96ksZexiv57NvM06JgIAAAAAAAAAAAAoFEUemu/rxthY7yhFdDD+So00n/vUw4oem6gQ3J/W4ZWKqv6gIvr2g9dVlzLKFPmVs72mIn0m/rBJGT39qKJH9gYEbrSixWoYtLPETn2Vp8/25uLAq+QRGNJTmk6GQbTx7mfhLKXkvJObc7o+1u+ZuAdpBLCTPQRB69xrqu283HVhtf9nh0YUGDxFUSvNjnaK/OqHWycVqbcI+FA0d/pT3XBZ6raTVXCGgJ0w0B+7rLNGNrs4rtwgYEg3Zx12s30nqwpu04xVVe+YbY01ssZhi7mgaV0x7A/N2BTPWHUCtpRSL9rWDI1c295G4BLA0wgBEFkARBYAkQVAZAEQWQBEFgCRBUBkARBZgKptwebWDuVhc2uMHqh4vSwKZN7otF/DoZF/un6DtMonRL9fp8nNcYL84XYtACILgMgCILIAiCwAIguAyAIgsgCILAAiC4DIAiCyAIgsACILgMgCILIAiCyA9fWfIjj+ckD79hALd3eIvvs5opt3iI1SRD4RRz4wyed9sZkjFZpfjWj5Ykgc4Hadk7ePmG88YgGRc3T4OR6XF5FzxOWvEETO0bXfNHGAyDm58TvRNz9GxAEi52RhtU9cIHIOvo538PpVHrdqA5FzsLTO4za9C5FHzAS+eYfPLjZK8cTr6i1z0BnNhTWPR5/dn230MYetpXUeT7mSShG5vTK6Q878m9kvydL3/AIbuF0nTD8fZN7FV37VbEamQYic8Mbh7Jfj3Jc8d7GByP8wgQ88lG0Xm5GJ22ErCZGJ7v1r0YmXsl2Kvw9bPG/TuxCZzC6u0N5atl1sDlucd7EhPrLZxdMvZN/FXA9bSeIjt45lH5na5/k8nx5GdGSfkckctq7d4n2b3iU6ctaR6Y9t/oetJLGRfUam5Uu8R6ZBIiP7j0x8H3z8G5GRfUemohEX2WdkMoetIoxMg8RF9hmZinTYShIV2Wdk4vgygCtRkbOOTOaw9cXFYu5iQ0xkn5HJHLbu7hRzFxsiIvuOTEU8bCWJiOwzMp36vBjPp4cpfWTfkamoh62k0kfOOjIV4WUAV6WO7DMyLV/i/zKAq1JH9hmZlgs8Mg0qbWSfkYnTD6uNQikj+4xM3H5YbRRK8RMUg8z/vHP8o3LtRh94W1MARBYAkQVAZAEQWQBEFgCRBUDk4rttWzA0cndhquvyReD/o3R03bbGZSdfJmAr0rRmW2ONrEJ9noCtaqRXbGvsO3mcFgm3bK4Wv3rvwa5tkTVytzN1W5FuE7BT6YdOXZxO1935qY7W+hMCNnSk2y672HAeoYIazRIOYSyYwBdO72m5rk/96sQzMxsdpdQ75OmJx+s0OTFO4E7fOxtF7Qunap00n5f6YcgvC1OzSulD8YdrBP+lxWo/PJQ2sOH1SxIaMxsN0sFRCnQz/i6rp/ncJ/fXaWIfdvL9xGeg+MCr4gcd4eXeZm1lraUw4QAAAAAAAAAAAIAUfwFKSVTj5L5X1wAAAABJRU5ErkJggg=="
}

thumbImage 为分享的图片的 Base64 编码。

miniProgram
json
{
  "title": "小程序标题",
  "description": "小程序描述",
  "webpageUrl": "https://www.baidu.com ",
  "userName": "yourID",
  "withShareTicket": true,
  "thumbImage": "iVBORw0KGgoAAAANSUhEUgAAAHkAAAB4CAYAAADWpl3sAAAACXBIWXMAACE4AAAhOAFFljFgAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAATESURBVHgB7d0/bBxFFMfxN3tncjixOf4lIAQ6C1GBRAJdqosEbvNHoqAAUpoKF0QRVe4qBInkK5DsDiMXQIOdCgSRbApMlZBIFEgk8gWaJDQhIv7D3e6wE7C0OpGb2Z1beLvv96ksZexiv57NvM06JgIAAAAAAAAAAAAoFEUemu/rxthY7yhFdDD+So00n/vUw4oem6gQ3J/W4ZWKqv6gIvr2g9dVlzLKFPmVs72mIn0m/rBJGT39qKJH9gYEbrSixWoYtLPETn2Vp8/25uLAq+QRGNJTmk6GQbTx7mfhLKXkvJObc7o+1u+ZuAdpBLCTPQRB69xrqu283HVhtf9nh0YUGDxFUSvNjnaK/OqHWycVqbcI+FA0d/pT3XBZ6raTVXCGgJ0w0B+7rLNGNrs4rtwgYEg3Zx12s30nqwpu04xVVe+YbY01ssZhi7mgaV0x7A/N2BTPWHUCtpRSL9rWDI1c295G4BLA0wgBEFkARBYAkQVAZAEQWQBEFgCRBUBkARBZgKptwebWDuVhc2uMHqh4vSwKZN7otF/DoZF/un6DtMonRL9fp8nNcYL84XYtACILgMgCILIAiCwAIguAyAIgsgCILAAiC4DIAiCyAIgsACILgMgCILIAiCyA9fWfIjj+ckD79hALd3eIvvs5opt3iI1SRD4RRz4wyed9sZkjFZpfjWj5Ykgc4Hadk7ePmG88YgGRc3T4OR6XF5FzxOWvEETO0bXfNHGAyDm58TvRNz9GxAEi52RhtU9cIHIOvo538PpVHrdqA5FzsLTO4za9C5FHzAS+eYfPLjZK8cTr6i1z0BnNhTWPR5/dn230MYetpXUeT7mSShG5vTK6Q878m9kvydL3/AIbuF0nTD8fZN7FV37VbEamQYic8Mbh7Jfj3Jc8d7GByP8wgQ88lG0Xm5GJ22ErCZGJ7v1r0YmXsl2Kvw9bPG/TuxCZzC6u0N5atl1sDlucd7EhPrLZxdMvZN/FXA9bSeIjt45lH5na5/k8nx5GdGSfkckctq7d4n2b3iU6ctaR6Y9t/oetJLGRfUam5Uu8R6ZBIiP7j0x8H3z8G5GRfUemohEX2WdkMoetIoxMg8RF9hmZinTYShIV2Wdk4vgygCtRkbOOTOaw9cXFYu5iQ0xkn5HJHLbu7hRzFxsiIvuOTEU8bCWJiOwzMp36vBjPp4cpfWTfkamoh62k0kfOOjIV4WUAV6WO7DMyLV/i/zKAq1JH9hmZlgs8Mg0qbWSfkYnTD6uNQikj+4xM3H5YbRRK8RMUg8z/vHP8o3LtRh94W1MARBYAkQVAZAEQWQBEFgCRBUDk4rttWzA0cndhquvyReD/o3R03bbGZSdfJmAr0rRmW2ONrEJ9noCtaqRXbGvsO3mcFgm3bK4Wv3rvwa5tkTVytzN1W5FuE7BT6YdOXZxO1935qY7W+hMCNnSk2y672HAeoYIazRIOYSyYwBdO72m5rk/96sQzMxsdpdQ75OmJx+s0OTFO4E7fOxtF7Qunap00n5f6YcgvC1OzSulD8YdrBP+lxWo/PJQ2sOH1SxIaMxsN0sFRCnQz/i6rp/ncJ/fXaWIfdvL9xGeg+MCr4gcd4eXeZm1lraUw4QAAAAAAAAAAAIAUfwFKSVTj5L5X1wAAAABJRU5ErkJggg==",
  "path": "yourPath"
}

thumbImage 为分享的图片的 Base64 编码。

返回结果 ​

参数类型描述备注
usersArray<user>用户集合user 返回的字段见下表
failListArray<user>发送失败用户集合user 返回的字段见下表

user： ​

参数类型描述备注
avatarstring头像地址/
namestring名字/
useridnumber用户 id/
chatidnumber会话 id/
mtypemumber成员类型company: 0, // 企业成员
team: 1, // 团队成员
collaborators: 2, // 协作者
contacts: 3, // 我的联系人
recent: 4, // 最近联系人
groupMembers: 5, // 分组成员
dept: 6, // 企业部门，部门当做一种特殊的成员

扫码 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持/
const params = {
    needResult:1
}
window.ksoxz_sdk.scan({onSuccess, onError});

参数说明 ​

参数类型是否必须描述备注
needResultnumber是是否需要回传扫码结果1:需要,由调用者处理扫码结果 0:不需要,由原生处理扫码结果
scanTypestring[]否扫码类型扫码类型：
barCode：一维码
qrCode：QrCode 码
datamatrix:
Data Matrix 码
pdf417: PDF417 码
支持传入多个类型
默认值：["barCode","qrCode","datamatrix","pdf417"]
barCodeInputboolean否是否支持手动输入条形码true：支持
false：不支持
默认值：false
onlyFromCameraboolean否是否只能从相机扫码，不允许从相册选择图片true：只允许相机扫码
false：允许从相册扫码
默认值：false

返回结果 ​

参数类型是否必须描述备注
textstring是二维码包含的文本内容/
scanTypestring否识别到的图形码的类型一维码：CODE_39，CODE_93，CODE_128，EAN_8，EAN_13，ITF，UPC_E
二维码：QR_CODE，DATA_MATRIX，PDF_417
其它：USER_INPUT

地理位置 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持/
const params = {
    coordinate:1,
    withReGeocode:true
}
window.ksoxz_sdk.getLocationInfo({params, onSuccess, onError})

参数说明 ​

参数类型是否必须描述备注
coordinatenumber否1:高德地图坐标 0:标准 gps 坐标默认为高德地图坐标
withReGeocodebolean否是否需要逆编码信息默认为是

返回结果 ​

参数类型是否必须描述备注
longitudenumber是经度字符串,按需截取和转换
latitudenumber是维度字符串,按需截取和转换
addressobject否逆编码位置信息标准 gps 坐标获取无此字段返回

adress: ​

参数类型是否必须描述备注
descriptionstring否地理位置逆编码信息如:湖北省武汉市洪山区雄庄路 100 号光谷 app 广场 2 号楼
provicestring否省如:湖北省
citystring否城市如:武汉市; 直辖市为空
districtstring否行政区如:洪山区
roadstring否街道如:雄庄路 100 号

获取应用信息 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持支持
window.ksoxz_sdk.getWebAppInfo({ onSuccess, onError});

返回结果 ​

参数类型是否必须描述备注
iconstring是应用的 icon/
namestring是名称/
appIdstring是应用 id/
descstring是描述有描述则返回描述，没有则为空

获取用户信息 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持支持
window.ksoxz_sdk.getUserInfo({ onSuccess, onError});

返回结果 ​

参数类型描述备注
userInfoobject用户信息/
∟ namestring用户名/
∟ avatarstring用户头像/
∟ phonestring电话/
∟ corpIdstring企业ID/
∟ corpUserIdstring企业用户ID/
∟ userIdstringWPS用户ID/
∟ xzUserIdstring协作用户ID/
∟ thirdUnionIdstring通过通讯录接口同步的第三方企业用户id/

错误码 ​

errnomsg含义
1002005User not granted webApp userInfo permission用户未授予网页应用用户信息权限
1043001Network connection failed网络连接失败
1043102Server api error服务端接口错误

启动摇一摇 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持/
const params = {
    sensitivity:'3.5',
    frequency: '50',
    callbackInterval: '3000',
};
window.ksoxz_sdk.accelerometerWatchShake({param, onSuccess, onError});

参数说明 ​

参数类型是否必须描述备注
sensitivitynumber是振动幅度（m/s²），加速度变化超过这个值后触发 shake。推荐值：3.5
frequencynumber是采样间隔(毫秒)，指每隔多长时间对加速度进行一次采样， 然后对比前后变化，判断是否触发 shake。最大值取决于设备，建议该值不超过 80
callbackIntervalnumber是两次『摇一摇』的时间间隔(毫秒)。触发『摇一摇』后，在该时间间隔内，不再触发摇一摇\

停止摇一摇 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持/
window.ksoxz_sdk.keyboard();

隐藏键盘导航栏 ​

使用说明 ​

客户端AndroidiOSPC
支持说明/支持/
window.ksoxz_sdk.getStepCount({onSuccess});

返回结果 ​

参数类型描述备注
hideAccessoryBarboolean控制webview中iOS键盘顶部的完成操作栏显隐。默认为true，隐藏该操作栏。隐藏操作栏后，只能通过前端其他操作触发收起键盘

运动与健康 ​

使用说明 ​

客户端AndroidiOSPC
支持说明支持支持/
window.ksoxz_sdk.getStepCount({onSuccess});

返回结果 ​

参数类型描述备注
stepCountnumber设备当前步数/

错误码 ​

errnomsg含义
1023002Step count not available计步功能不可用，当前设备可能不支持该功能
1021008Step count permission not obtained未授权运动与健康权限
1002006User not granted webApp runData permission用户未授权 webApp 关于运动与健康的权限
1801001already start之前获取步数还未结束，请确保上次调用已经完成

注意事项 ​

该接口在Android和ios双端在获取数据来源时，可能存在一定差异。

a. Android V5.31.0 及以前的版本 获取传感器设备中的当前总步数。如果设备重启，设备传感器中的步数会被清零。如果未能获取到步数信息。请检查设备是否支持 TYPE_STEP_COUNTER 传感器以及传感器是否正常工作。

b. Android V5.32.0 及以后的版本 在小米系列手机上，从小米运动中获取设备当天 0 点至当前时间的步数信息。相关信息参见小米运动文档。 在非小米系列手机上，获取传感器设备内的当前总步数。如果设备重启，设备传感器中的步数不会被清零，运动步数会一直累加。如果未能获取到步数信息, 请检查设备是否支持 TYPE_STEP_COUNTER 传感器以及传感器是否正常工作。