聆客开放平台

# 模型定义

# ApiResultCollectionOfTaskInfo

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
total integer N 数据总数
message string N 当状态码不是200时,错误信息
count integer N 请求返回的数据总数
data TaskInfo[ ] N 请求返回的数据

# ApiResultOfSimpleTaskInfo

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data SimpleTaskInfo N 请求返回的数据
message string N 当状态码不是200时,错误信息

# ApiResultOfTaskBatchOperateResult

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data TaskBatchOperateResult N 请求返回的数据
message string N 当状态码不是200时,错误信息

# ApiResultOfTaskInfo

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data TaskInfo N 请求返回的数据
message string N 当状态码不是200时,错误信息

# ApiResultOfboolean

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data boolean N 请求返回的数据
message string N 当状态码不是200时,错误信息

# ApiResultOfint

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data integer N 请求返回的数据
message string N 当状态码不是200时,错误信息

# ApiResultOfobject

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data object N 请求返回的数据
message string N 当状态码不是200时,错误信息

# ApiResultOfstring

API调用的结果集

# 属性定义

属性名 数据类型 必填 属性说明
code integer Y 结果码 200:成功
data string N 请求返回的数据
message string N 当状态码不是200时,错误信息

# FailLog

失败记录

# 属性定义

属性名 数据类型 必填 属性说明
appTaskId string N 各应用系统待办的唯一标识
id string N 平台待办ID
message string N 失败原因

# QuickDealParam

快速处理参数

# 属性定义

属性名 数据类型 必填 属性说明
todoTaskIds string[ ] Y 待办ID列表
endResult string Y 处理结果
endComment string N 处理备注

# SimpleTaskInfo

简单待办信息

# 属性定义

属性名 数据类型 必填 属性说明
id string N 平台待办ID
appTaskId string N 各应用系统待办的唯一标识

# TaskBatchOperateResult

批量操作结果

# 属性定义

属性名 数据类型 必填 属性说明
error FailLog[ ] N
success SimpleTaskInfo[ ] N

# TaskCompleteParam

结束待办参数

# 属性定义

属性名 数据类型 必填 属性说明
todoTaskId string Y 当前处理的待办的id
endResult string N 处理结果
endComment string N 处理备注
endType integer N 结束类型(1:完成,2:撤回),默认1

# TaskHistoryParam

已办请求参数

# 属性定义

属性名 数据类型 必填 属性说明
title string Y 任务标题
tags string N 任务分类或标签,以json数组格式存储,如:['报销','协同办公']
appTaskId string Y 待办id,各应用系统待办的唯一标识
appData string N 当前任务参数,以json的map存储
creatorId string N 发送人id
creatorName string N 发送人姓名
procCreatorId string N 流程创建者Id
procCreatorName string N 流程创建者姓名
procInstId string N 如属流程id
procInstStatus string N 流程状态,如:pending/finish
procInstTitle string N 所属流程名称
assigneeLoginId string Y 处理人账号
action string Y 点击处理动作信息,以json格式保存,支持不同端的处理,如:{"android":"[OpenApp]\nappCode=xxx\nappUrl=xxx","ios":"[OpenApp]\nappCode=xxx\nappUrl=xxx","pc":"[OpenUrl]\nurl=xxx","web":"[OpenUrl]\nurl=xxx"}
status integer Y 任务状态:1:已办,4:已阅,5:撤回
quickDeal boolean N 是否对待阅进行快速处理(打开待阅消息时由终端请求统一待办服务的快速处理接口,成功执行后将消息设置成已阅状态,不需要第三方应用设置),true:不支持,false:支持
quickDealCallback string N 快速处理时,系统回调通知,通知业务系统处理结果,仅回调成功后,该处理才生效,POST请求,回调参数为TaskInfo
degree integer N 紧急程度,0:一般,1:紧急,2:超急
source string N 来源
endResult string N 处理结果
endComment string N 处理备注

# TaskInfo

待办信息

# 属性定义

属性名 数据类型 必填 属性说明
id string N 待办id,创建成功后,由系统生成
title string N 任务标题
tags string N 任务分类或标签,以json数组格式存储,如:['报销','协同办公']
appTaskId string N 待办id,各应用系统待办的唯一标识
appData string N 当前任务参数,以json的map存储
creatorId string N 发送人id
createdTime string N 创建时间
creatorName string N 发送人姓名
assigneeId string N 处理人id
assigneeName string N 处理人姓名
action string N 点击处理动作信息,以json格式保存,支持不同端的处理,如:{"android":"[OpenApp]\nappCode=xxx\nappUrl=xxx","ios":"[OpenApp]\nappCode=xxx\nappUrl=xxx","pc":"[OpenUrl]\nurl=xxx","web":"[OpenUrl]\nurl=xxx"}
status integer N 任务状态:0:待办,1:已办,2:待阅,4:已阅
quickDeal boolean N 是否对待阅进行快速处理(打开待阅消息时由终端请求统一待办服务的快速处理接口,成功执行后将消息设置成已阅状态,不需要第三方应用设置),0:不支持,1:支持
quickDealCallback string N 快速处理时,系统回调通知,通知业务系统处理结果,仅回调成功后,该处理才生效,回调参数见系统设计
degree integer N 紧急程度,0:一般,1:紧急,2:超急
notifyStatus integer N 消息通知状态,0:未发送消息,1:消息发送成功,-1:消息发送失败
notifyTime string N 最后消息通知时间
source string N 来源
notifyLog string N 消息通知日志
endTime string N 处理时间
endResult string N 处理结果
endComment string N 处理意见
procCreatorId string N 流程创建者Id
procCreatorName string N 流程创建者姓名
procInstId string N 如属流程id
procInstTitle string N 所属流程名称
procInstStatus string N 流程状态,如:pending/finish

# TaskParam

待办请求参数

# 属性定义

属性名 数据类型 必填 属性说明
title string Y 任务标题
tags string N 任务分类或标签,以json数组格式存储,如:['报销','协同办公']
appTaskId string Y 待办id,各应用系统待办的唯一标识
appData string N 当前任务参数,以json的map存储
creatorId string N 发送人id
creatorName string N 发送人姓名
procCreatorId string N 流程创建者Id
procCreatorName string N 流程创建者姓名
procInstId string N 如属流程id
procInstStatus string N 流程状态,如:pending/finish
procInstTitle string N 所属流程名称
assigneeLoginId string Y 处理人账号
action string Y 点击处理动作信息,以json格式保存,支持不同端的处理,如:{"android":"[OpenApp]\nappCode=xxx\nappUrl=xxx","ios":"[OpenApp]\nappCode=xxx\nappUrl=xxx","pc":"[OpenUrl]\nurl=xxx","web":"[OpenUrl]\nurl=xxx"}
status integer Y 任务状态:0:待办,2:待阅
quickDeal boolean N 是否对待阅进行快速处理(打开待阅消息时由终端请求统一待办服务的快速处理接口,成功执行后将消息设置成已阅状态,不需要第三方应用设置),true:不支持,false:支持
quickDealCallback string N 快速处理时,系统回调通知,通知业务系统处理结果,仅回调成功后,该处理才生效,POST请求,回调参数为TaskInfo
degree integer N 紧急程度,0:一般,1:紧急,2:超急
source string N 来源