服务支撑API

服务支撑API 都是以service. 开头描述的。主要用户给第三方应用提供多样化的支撑

其中：

  • service.media.xx 代表多媒体有关的功能
  • service.file.xx 代表文件相关功能
  • service.storage.xx 代表存储有关的功能
  • service.saoysao.xx 代表扫一扫相关的功能
  • service.chat.xx 代表聊天相关的功能
  • service.contact.xx 代表通讯录的功能
  • service.exContact.xx 代表外部联系人相关功能

  • service.share.xx 代表分享相关功能

    接口列表

接口名称 需要授权 接口描述 同步/异步 企业端版本 政府端版本
service.media.openLib 不需要 打开本地库，并支持选择 异步 >= 3.0.3 >= 3.0.3
service.media.openCamera 不需要 打开本地摄像机，并拍照或录像 异步 >= 3.0.3 >= 3.0.3
serivce.file.download 不需要 下载文件 异步 >= 3.0.3 >= 3.0.3
serivce.file.upload 不需要 通用的上传文件 异步 >= 3.0.3 >= 3.0.3
service.file.bigPhoto 不需要 将图片放大看 异步 >3.1.0 >3.0.8
serivce.storage.put 不需要 存储信息 异步 >= 3.0.3 >= 3.0.3
serivce.storage.get 不需要 获取信息 异步 >= 3.0.3 >= 3.0.3
serivce.storage.remove 不需要 移除信息 异步 >= 3.0.3 >= 3.0.3
serivce.storage.removeWhenDismiss 不需要 webview销毁时移除存储数据 异步 >= 3.1.2 >= 3.2.0
serivce.saoysao.scanCard 不需要 扫名片 异步 >= 3.0.6 >= 3.1.3
serivce.saoysao.scanEWM 不需要 扫二维码 异步 >3.1.0 >3.1.8
serivce.contact.choose 不需要 人员选择 异步 >= 3.1.2 >= 3.1.9
serivce.contact.detail 不需要 打开人员详情 异步 >= 3.0.3 >= 3.0.3
serivce.share.star 不需要 关注 异步 >= 3.0.5 >= 3.1.2
serivce.share.favorite 不需要 收藏 异步 >= 3.0.5 >= 3.1.2
serivce.share.share 不需要 分享 异步 >= 3.0.3 >= 3.0.3
serivce.share.removeMsg 不需要 移除消息 异步 >= 3.2.0 >= 3.2.2

接口详情

service.media.openLib

调用方法:
zqtbridge.call("service.media.openLib",{"type":1, "maxNum":5}, function (v) { alert(v) });
参数说明:
  • type 类型 0-照片 1-视频
  • maxNum 选择最大数量，最大不超过5
返回结果:
{"code":"0","msg":"处理成功","list":"[\"path1\",\"path2\"]"}

service.media.openCamera

调用方法:
zqtbridge.call("service.media.openCamera", function (v) { alert(v) });
返回结果:
{"code":"0","msg":"处理成功","list":"[\"path1\"]"}

service.file.download

调用方法:
zqtbridge.call("service.file.download", {"url":"https://58.215.198.210:8443/EFS_investsmart/card/08029001.jpg", "api-key":"0cf8d5ab024e42b1ad53f73a5bbc4a64","autoOpen":true,"title":"文件标题"}, function (v) { alert(v) });
参数说明:
  • url 文件路径
  • api-key efs的apikey 选填
  • autoOpen 下载完成后是否自动打开
  • title: 文件名称，不传的话默认展示图片本机地址
返回结果:
{"code":"0","msg":"处理成功","filePath":"path"}

service.file.upload

调用方法:
zqtbridge.call("service.file.upload", {
    "fileUrl":"/storage/emulated/0/DCIM/Camera/IMG_20181101_081322.jpg",
    "destUrl":"https://58.215.198.210:8443/EFS_investsmart/card/uploadtestandroid.jpg",
    "isLib":false,
    "mineType":"image/png",
    "api-key":"0cf8d5ab024e42b1ad53f73a5bbc4a64"}, function (v) { alert(v) });
参数说明:
  • fileUrl 本地文件路径
  • destUrl 目标路径
  • isLib 是否是照片库中的文件（ios专用，android可不填）
  • mineType 文件类型
  • api-key efs的apikey 选填
返回结果:
{"code":"0","msg":"处理成功","destUrl":"path"}

service.file.bigPhoto

调用方法：

zqtbridge.call("service.file.bigPhoto", {"fileUrl":"https://58.215.198.210:9997/test/icon.png"}, function (v) { alert(v) });

参数说明

  • fileUrl: 图片的网络链接

service.storage.put

调用方法:
zqtbridge.call("service.storage.put", {"key":"name","value":"james"}, function (v) { alert(v) });
参数说明:
  • key 本地存储的key
  • value 本地存储的value
返回结果:
{"code":"0","msg":"处理成功"}

service.storage.get

调用方法:
zqtbridge.call("service.storage.get", {"key":"name"}, function (v) { alert(v) });
参数说明:
  • key 本地存储的key
返回结果:
{"code":"0","msg":"处理成功","value":"james"}

service.storage.remove

调用方法:
zqtbridge.call("service.storage.remove", {"key":"name"}, function (v) { alert(v) });
参数说明:
  • key 本地存储的key
返回结果:
{"code":"0","msg":"处理成功"}

service.storage.removeWhenDismiss

此方法使用场景：当h5无法捕捉返回按钮点击方法的时候，也就是webview被移动端返回销毁的时候，需要删除之前h5存储在本地的一些数据，那么就要通过此方法提前向移动端注册一下。
调用方法:
zqtbridge.call("service.storage.removeWhenDismiss", {"keys":["name","age","money"]}, function (v) { alert(v) });
参数说明:
  • keys: 本地存储的数据的key数组，元素是每个存储数据的key
返回结果:
{"code":"0","msg":"处理成功"}

webview销毁时候，移动端会根据js传过来的keys数组中的数据，逐一删除本地数据。

service.saoysao.scanCard

调用方法:
zqtbridge.call("service.saoysao.scanCard", function (v){alert(v)});
返回结果:
{"code":"0","msg":"处理成功","info":"{\"name\":\"\",\"phone\":\"\",\"landline\":\"\",\"company\":\"\",\"department\":\"\",\"position\":\"\",\"address\":\"\",\"email\":\"\",\"remark\":\"\"}"}
参数说明
  • info 代表扫描结果对象。
  • name 代表姓名。
  • phone 代表电话
  • landline 代表固定电话
  • company 代表公司
  • department 代表部门
  • position 代表职务
  • address 代表地址
  • email 代表电子邮箱地址
  • remark 代表备注

serivce.saoysao.scanEWM

调用方法:

zqtbridge.call("service.saoysao.scanEWM", function (v){
                           alert(v)
                           });

返回结果

"扫码得到的信息"

service.contact.choose

调用方法:
zqtbridge.call("service.contact.choose",{"forwardMsg":"",chooseRange":1,"chooseType":0,"dataToShow":{"deptId":["id1","id2"],"userId":["id1","id2"]},"chooseDatas":{"departments":[{"deptNum":5,"id":"689b07ba-a8ba-4f77-8495-8ddc6a7a014e","name":"测试1"}],"users":[{"realname":"马千","userId":"030cf1fd-9e07-434d-b7a6-55eb5207d97c"},{"realname":"张荣娟","userId":"8e07d2a2-0a96-4d7c-bde2-627703564ac5"}]}}, function (v){
    alert(v)});
参数说明:
  • forwardMsg 企业端消息转发专用，需要转发的内容
  • chooseRange 责任范围，传整数(例如1-园区；2-部门；3-个人)，默认是1，1表示展示所有部门，2表示展示当前用户所在部门，3表示展示当前用户。
  • chooseType 传整数；0-即可选择人员也可选择部门；1-只能选择人员；2-只能选择部门
  • dataToShow 待展示人员(只能从这里面去选，前端从后台获取的可选择人员和部门列表，传递给app)，deptId：部门id列表，userId：人员id列表
  • chooseDatas 已选择人员，适用于选人途中，未提交数据前，重选的情况，departments部门列表(deptNum:部门人数，id:部门id，name:部门名称)，users人员列表(realname:姓名，userId:用户id)
返回结果:
{"code":"0","msg":"处理成功","datas":"{\"departments\":[{\"deptNum\":5,\"id\":\"689b07ba-a8ba-4f77-8495-8ddc6a7a014e\",\"name\":\"测试1\"}],\"users\":[{\"realname\":\"张荣娟\",\"userId\":\"8e07d2a2-0a96-4d7c-bde2-627703564ac5\"}]}"}

service.contact.detail

调用方法:
zqtbridge.call("service.contact.detail", {"userId":"2fb5c7c3-6841-4b15-9c4d-b2e807b792e5", "imId":"ff1e4de2a84e4772813b91df353222bd"}, function (v){alert(v)});
参数说明:
  • userId 人员id
  • imId 云信人员id
返回结果:
{"code":"0","msg":"处理成功"}

service.share.star

调用方法:
zqtbridge.call("service.share.star",{"title":"测试1","date":"2018-07-08","image":"","source":"","type":"1","detailUrl":"http://www.baidu.com","category":"1","contentId":"c48696bb-cb5a-4e5f-80ec-b0477c58269e",}, function (v){
                           alert(v)
                           });
参数说明:
  • contentId 内容Id
  • category 类型(1是文章)
  • title 标题 String 文章标题 必填
  • date 日期 String 2018-07-08 选填
  • image 图片url String http://www.baidu.com 选填
  • source 来源 String 科技局 选填
  • type 类型("1"文章或"0"通知公告) String 1 必填
  • detailUrl 详情接口url String http://www.baidu.com 必填
返回结果:
无

service.share.favorite

调用方法:
zqtbridge.call("service.share.favorite",
{"category":"1","title":"测试1","date":"2018-07-08","image":"","source":"","type":"1","detailUrl":"http://www.baidu.com","articleId":"0044a65c-b577-4b9b-bf2f-0b023b2a0fd7"}, function (v){});
参数说明:
  • category 类型(1是文章)
  • articleId 文章ID String 0044a65c-b577-4b9b-bf2f-0b023b2a0fd7 必填
  • title 标题 String 文章标题 必填
  • date 日期 String 2018-07-08 选填
  • image 图片url String http://www.baidu.com 选填
  • source 来源 String 科技局 选填
  • type 类型("1"文章或"0"通知公告) String 1 必填
  • detailUrl 详情接口url String http://www.baidu.com 必填
返回结果:
无

service.share.share

调用方法:
zqtbridge.call("service.share.share",{
    "title":"测试分享",
    "detail":"测试分享的描述",
    "url":"https://www.baidu.com"
    }, function (v){
            alert(v)
    });
参数说明:
  • title 分享的标题
  • detail 分享的描述
  • url 分享的链接
返回结果:
{"code":"0","msg":"处理成功"}

service.share.removeMsg

调用方法:
zqtbridge.call("service.share.removeMsg",{"msgId":"c48696bb-cb5a-4e5f-80ec-b0477c58269e",}, function (v){
                           alert(v)
                           });
参数说明:
  • msgId 消息Id
返回结果:
无

results matching ""

    No results matching ""