更新日期:     浏览次数:

1. 任务相关接口

1.1. 1、新增任务接口

http://yunzhijia.com/gateway/cloudwork/worktask/create?accessToken=xxx

header:

Content-Type:application/json

参数:

参数 类型 注释
openId String 任务创建者的oid
content String 任务内容
endDate Long 任务结束时间戳
noticeTime int 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒)
timingNoticeTime int 任务定时提醒时间(0:不提醒、1:每天、2:每工作日、3:每周、4:每两周、5:每月)
important int 是否重要(0:不重要、1:重要)
images 文件格式 图片
files 文件格式 附件
executors 集合 执行人oid的集合
ccs 集合 抄送人oid的集合
channel String 来源渠道
createChannel String 来源渠道细分,相当于子渠道
callBackUrl String 回调地址
extApps 集合 外部跳转应用集合
  • PS:关于channel和createChannel

    例如同事圈团队,想创建一个建议的任务,那么channel就是同事圈(FEED),createChannel就是建议(SUGGEST);如果同事圈团队想创建其他类型的任务,那么channel还是同事圈(FEED),createChannel改为其他(XX)

  • callBackUrl为一个Http地址(post请求,Content-Type为application/json,不要鉴权,带有两个入参:id和method),id就代表该条业务的id,method为执行的业务方法。

  • 回调地址因为不鉴权,所以最好做好限流,避免恶意攻击
  • 在回调方法里面根据需要监听的method,来查询详情接口,然后更新您本地的数据
  • method示例
method 描述
1001 创建日程
1002 修改日程
1003 删除日程
1004 添加协作人
1005 更新协作人
1006 完成日程
1007 重新发起日程
1008 接受日程
1009 更新提醒时间
1010 标记重要工作
1011 创建重复日程
1012 修改重复日程
1013 删除重复日程
method 描述
2001 创建任务
2002 修改任务
2003 删除任务
2004 完成任务
2005 关闭任务
2006 添加协作人
2007 更新协作人
2008 删除协作人
2009 激活任务

extApps为外部应用集合,可跳转到第三方轻应用,其中,icon为应用icon,url为跳转地址,desc为对跳转的描述,appId和appName为待跳转应用的appId和appName

{
    "openId":"5bc58d65e4b0aed875a362cb",
    "content":"JUNIT测试",
    "endDate":"1556294399000",
    "noticeTime":"5",
    "timingNoticeTime":"0",
    "important":0,
    "files": [{
        "fileId": "5cc55b6fb6238e6f079ddc1f",
        "fileName": "qrcode.png",
        "fileSize": 19292,
        "fileExt": "png",
        "fileType": "png"
    }],
    "images": [{
        "fileExt": "png",
        "fileId": "5cc55b64b6238e6f079ddc16",
        "fileName": "qrcode.png",
        "fileSize": 19292,
        "fileType": "image/png"
    }],
    "executors":[
        "5bc58d65e4b0aed875a362cb","5a67f00ee4b06d73f355b6e9"
    ],
    "ccs":[
        "5bc58d65e4b0aed875a362cb"
    ],
    "channel":"FEED",
    "createChannel":"SUGGEST",
    "callBackUrl":"http://127.0.0.1/XX/XX",
    "extApps": [
        {
            "icon": "http://xxx.com/xxx.png",
            "url": "http://xxx.com/xxx/xxx",
            "desc": "跳转到审批应用",
            "appId": "123456",
            "appName": "审批"
        }
    ]
}

返回结果示例:

参数 类型 注释
workTaskId String 添加成功后任务id
{
    "data": {
        "workTaskId": "5b33291f14cada713f839b49"
    },
    "error": null,
    "errorCode": 0,
    "success": true
}

1.2. 2、查询任务详情接口

http://yunzhijia.com/gateway/cloudwork/worktask/find?accessToken=xxx

header:

Content-Type:application/json

参数:

参数 类型 注释
openId String 任务创建者的oid
id String 任务id
{
    "openId":"5bc58d65e4b0aed875a362cb",
    "id":"5cc55b6fb6238e6f079ddc1f"
}

返回结果示例:

参数 类型 注释
actors 集合 任务相关人的集合
content String 任务内容
createDate long 任务创建时间
endDate Long 任务结束时间戳
files 文件格式 附件
id String 主键ID
images 文件格式 图片
important int 是否重要(0:不重要、1:重要)
noticeTime int 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒)
openId String 任务创建者的oid
personName String 任务创建者姓名
status int 任务状态(0:未完成、1:完成、2:已关闭)
timingNoticeTime int 任务定时提醒时间(0:不提醒、1:每天、2:每工作日、3:每周、4:每两周、5:每月)

PS:关于actors actors是相关人的集合,通过source字段进行区分身份,source=1(创建人),source=2(执行人),source=3(抄送人)。

{
    "data": {
        "actors": [{
            "department": "XX科技公司",
            "eid": "6821512",
            "openId": "5bc58d65e4b0aed875a362cb",
            "personName": "张三",
            "photoUrl": "http://192.168.22.144/space/c/photo/load?id=123456",
            "progress": 0,
            "readStatus": 1,
            "source": 2,
            "status": 0,
            "userId": "5bc58d65e4b0aed875a362c4"
        }],
        "content": "JUNIT ThirdApi测试",
        "createDate": 1556417201162,
        "endDate": 1556294399000,
        "files": [],
        "id": "5cc50ab112043d558e1bfd0d",
        "images": [],
        "important": 0,
        "noticeTime": 5,
        "openId": "5bc58d65e4b0aed875a362cb",
        "personName": "张三",
        "status": 0,
        "timingNoticeTime": 0
    },
    "error": null,
    "errorCode": 0,
    "success": true
}

1.3. 3、分页查询任务列表接口

http://yunzhijia.com/gateway/cloudwork/worktask/page?accessToken=xxx

header:

Content-Type:application/json

参数:

参数 类型 注释
openId String 任务创建者的oid
pageNum int 第几页(从1开始)
pageSize int 每页多少条(最多100条)
{
    "channel":"FEED",
    "createChannel":"SUGGEST",
    "openId":"5bc58d65e4b0aed875a362cb",
    "pageNum":"1",
    "pageSize":"10"
}

返回结果示例:

参数 类型 注释
actors 集合 任务相关人的集合
content String 任务内容
createDate long 任务创建时间
endDate Long 任务结束时间戳
files 文件格式 附件
id String 主键ID
images 文件格式 图片
important int 是否重要(0:不重要、1:重要)
noticeTime int 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒)
openId String 任务创建者的oid
personName String 任务创建者姓名
status int 任务状态(0:未完成、1:完成、2:已关闭)
timingNoticeTime int 任务定时提醒时间(0:不提醒、1:每天、2:每工作日、3:每周、4:每两周、5:每月)

PS:关于actors actors是相关人的集合,通过source字段进行区分身份,source=1(创建人),source=2(执行人),source=3(抄送人)。

{
    "data": {
        "data": [{
            "actors": [{
                "department": "XX科技公司",
                "eid": "6821512",
                "openId": "5bc58d65e4b0aed875a362cb",
                "personName": "张三",
                "photoUrl": "http://192.168.22.144/space/c/photo/load?id=123456",
                "progress": 0,
                "readStatus": 1,
                "source": 2,
                "status": 0,
                "userId": "5bc58d65e4b0aed875a362c4"
            }],
            "content": "JUNIT ThirdApi测试",
            "createDate": 1556417201162,
            "endDate": 1556294399000,
            "files": [],
            "id": "5cc50ab112043d558e1bfd0d",
            "images": [],
            "important": 0,
            "noticeTime": 5,
            "openId": "5bc58d65e4b0aed875a362cb",
            "personName": "张三",
            "status": 0,
            "timingNoticeTime": 0
        }],
        "pageNum": 1,
        "pageSize": 10,
        "totalCount": 1
    },
    "error": null,
    "errorCode": 0,
    "success": true
}

results matching ""

    No results matching ""