聆客开放平台
批量创建已办
创建已办
删除已办
批量创建待办
结束待办
创建待办
暂停待办
恢复待办

# 批量创建已办

POST /api/done/batch_create

批量创建待办事项

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
params TaskHistoryParam[ ] Y body 已办请求列表

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfTaskBatchOperateResult 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/done/batch_create
Content-Type: application/json

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "data" : {                        //请求返回的数据
    "success" : [ {
      "id" : "string",              //平台待办ID
      "appTaskId" : "string"        //各应用系统待办的唯一标识
    } ],
    "error" : [ {
      "id" : "string",              //平台待办ID
      "message" : "string",         //失败原因
      "appTaskId" : "string"        //各应用系统待办的唯一标识
    } ]
  },
  "code" : "integer",               //结果码 200:成功
  "message" : "string"              //当状态码不是200时，错误信息
}

# 创建已办

POST /api/done/create

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
param TaskHistoryParam Y body 已办请求参数

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfSimpleTaskInfo 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/done/create
Content-Type: application/json

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

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "data" : {                      //请求返回的数据
    "id" : "string",              //平台待办ID
    "appTaskId" : "string"        //各应用系统待办的唯一标识
  },
  "code" : "integer",             //结果码 200:成功
  "message" : "string"            //当状态码不是200时，错误信息
}

# 删除已办

POST /api/done/remove

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
todoTaskId string Y query 平台待办ID

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfstring 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/done/remove?todoTaskId={todoTaskId}
Content-Type: application/json

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "code" : "integer",         //结果码 200:成功
  "data" : "string",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 批量创建待办

POST /api/todo/batch_create

批量创建待办事项

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
params TaskParam[ ] Y body 待办请求列表

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfTaskBatchOperateResult 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/todo/batch_create
Content-Type: application/json

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "data" : {                        //请求返回的数据
    "success" : [ {
      "id" : "string",              //平台待办ID
      "appTaskId" : "string"        //各应用系统待办的唯一标识
    } ],
    "error" : [ {
      "id" : "string",              //平台待办ID
      "message" : "string",         //失败原因
      "appTaskId" : "string"        //各应用系统待办的唯一标识
    } ]
  },
  "code" : "integer",               //结果码 200:成功
  "message" : "string"              //当状态码不是200时，错误信息
}

# 结束待办

POST /api/todo/complete

结束一条待办

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
param TaskCompleteParam Y body 结束待办请求

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfstring 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/todo/complete
Content-Type: application/json

{
  "endComment" : "string",       //处理备注
  "todoTaskId" : "string",       //当前处理的待办的id
  "endType" : "integer",         //结束类型（1：完成，2：撤回），默认1
  "endResult" : "string"         //处理结果
}

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "code" : "integer",         //结果码 200:成功
  "data" : "string",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 创建待办

POST /api/todo/create

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
param TaskParam Y body 待办请求参数

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfSimpleTaskInfo 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/todo/create
Content-Type: application/json

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

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "data" : {                      //请求返回的数据
    "id" : "string",              //平台待办ID
    "appTaskId" : "string"        //各应用系统待办的唯一标识
  },
  "code" : "integer",             //结果码 200:成功
  "message" : "string"            //当状态码不是200时，错误信息
}

# 暂停待办

POST /api/todo/parse

暂停一条待办，用户无法查看，无法处理

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
todoTaskId string Y query 平台待办ID

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfstring 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/todo/parse?todoTaskId={todoTaskId}
Content-Type: application/json

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "code" : "integer",         //结果码 200:成功
  "data" : "string",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 恢复待办

POST /api/todo/resume

恢复一条待办

# 请求类型：Content-Type

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
todoTaskId string Y query 平台待办ID

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfstring 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /api/todo/resume?todoTaskId={todoTaskId}
Content-Type: application/json

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "code" : "integer",         //结果码 200:成功
  "data" : "string",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

← 徽章管理 →