查詢任務資訊

GET - /api/v1/task/getInfo/{instanceId}

參數

NameParameterTypeRequired/OptionalDescription
instanceIdpathstringRequired任務 Instance Id
keyquerystringRequired公司 API Key

回傳

{
  "body": {
    "allReceivers": [
      {
        "email": "string",
        "name": "string",
        "needVideo": "false",
        "otpType": "NONE"
      }
    ],
    "data": [
      {
        "assigneeEmail": "string",
        "assigneeName": "string",
        "startTime": "2023-06-08T03:23:43.659Z",
        "endTime": "2023-06-08T03:23:43.658Z",
        "taskFirstViewedTime": "2023-06-08T03:23:43.659Z",
        "taskLastViewedTime": "2023-06-08T03:23:43.659Z",
        "result": true,
        "denyReason": "string"
      }
    ],
    "startDate": "2023-06-08T03:23:43.659Z",
    "endDate": "2023-06-08T03:23:43.659Z",
    "expiredDate": "2023-06-08T03:23:43.659Z",
    "initiatorAccount": "string",
    "initiatorName": "string",
    "name": "string",
    "result": true
  },
  "errorCode": 0,
  "message": "string"
}
  • allReceivers (陣列) 簽核成員，發起任務時填的person
    • email - 簽核成員的 email
    • name - 簽核成員的名字
    • needVideo - 完成簽核時是否需要進行聲明錄影
    • otpType - 要求文件密碼方式
      • NONE - 不要求
      • EMAIL_READ - 讀取文件時以電子郵件寄送
      • EMAIL_COMPLETE - 簽署文件時以電子郵件寄送
  • data (陣列) 簽核成員狀態
    • assigneeEmail - 簽核成員的 email
    • assigneeName - 簽核成員的名字
    • startTime - 收到任務時間
    • endTime - 簽核結束時間
    • taskFirstViewedTime - 第一次打開任務時間
    • taskLastViewedTime - 最後一次打開任務時間
    • result - 是否成功簽核，true代表成功簽核，false代表拒絕簽核
    • denyReason - 拒絕簽核理由
    • currentStatus - 當前狀態
      • WAITING - 等待中
      • PROCESSING - 進行中
      • SENT - 已寄送任務信件
      • SEND_FAIL - 寄送任務信件失敗
      • OPEN - 已開啟任務
      • DONE - 已完成任務
      • REJECT - 已拒絕任務
    • sentDate - 寄送任務信件時間
    • sendFailDate - 寄送任務失敗時間
  • startDate - 任務開始時間
  • endDate - 任務結束時間
  • expiredDate - 任務到期時間
  • initiatorAccount - 發起人帳號
  • initiatorName - 發起人名字
  • name - 任務名稱
  • result - 任務是否成功，true代表成功簽核，false代表拒絕簽核

errorCode 錯誤代碼

請參考 錯誤碼和錯誤訊息 頁面

Table of Contents