使用範本建立任務

POST - /api/v1/task/create

參數

{
  "apiKey": "string",
  "name": "string",
  "initiatorName": "string",
  "emailSubject": "string",
  "expiredDate": "2023-01-05T07:12:04.579Z",
  "isOverlay": true,
  "isParallel": false,
  "returnUrl": "string",
  "sendDoneMailToSigner": true,
  "cc": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "data": {
    "option": {
      "datas": [
        {
          "groupLabel": "string",
          "label": "string",
          "value": "string"
        }
      ]
    },
    "person": [
      {
        "email": "string",
        "name": "string",
        "phone": "string",
        "needVideo": false,
        "isFace": false,
        "isNeedOtp": false,
        "hostEmail": "string",
        "hostName": "string"
      }
    ],
    "reviewer": [
      {
        "email": "string",
        "name": "string",
        "personIndex": 0
      }
    ],
    "replaceFiles": [
      {
        "base64Content": "string",
        "contentType": "string",
        "fileName": "string"
      }
    ],
    "templateId": "string"
  }
}

apiKey - API 金鑰
name - 任務名稱
initiatorName - 發起人名稱
emailSubject - 簽署信件主旨
cc (陣列) - 副本收件人，在完成任務後收到簽核結果
- email - 副本收件人 email
- name - 副本收件人名稱
expiredDate - 文件簽署期限，有設定請給 UTC+0 時區時間(Ex: 2022-12-02T07:00:17.300Z)，沒有請給 null
isOverlay - 下一個人是否要看到上一個人的簽署內容
isParallel - true 爲不設定簽核順序，當簽核成員有「只審核」的成員（AUDITOR）時要是 false（要有簽核順序）
returnUrl - 簽署完成跳回頁面 (SI 用戶)
sendDoneMailToSigner - 是否寄送完成信件給簽署者 (預設為true)
data - 範本資料
- option - 額外資料
  - datas (陣列) - 需要預先填入的值，對應欄位的標籤
    - groupLabel - 群組標籤
    - label - 對應欄位的標籤
    - value - 對應欄位預先填入的值
- person (陣列) - 簽核成員，順序對應 templateList 的 signPeople
  - email - 簽核成員的 email，現場簽(isFace=true)不用提供
  - name - 簽核成員的名字
  - phone - 簽核成員的電話，如果填寫將用簡訊寄送簽署連結 (請確保公司點數符合簡訊點數要求)
  - ~~otpType - 要求文件密碼方式~~ (已棄用，請改使用isNeedOtp)
    - ~~NONE - 不要求~~
    - ~~EMAIL_READ - 讀取文件時以電子郵件寄送~~
  - isFace - 是否為現場簽
  - isNeedOtp - 是否需要 OTP
  - hostEmail - 現場簽指定主持人 email (預設為發起人)
  - hostName - 現場簽指定主持人名字 (預設為發起人)
  - culture - 信件語系目前支援 zh-TW、en
- reviewer (陣列) - 額外的審核人員
  - email - 審核人員的 email
  - name - 審核人員的名字
  - personIndex - 安插在哪一個簽核成員前面
- replaceFiles (陣列) - 替換檔案，數量需要對應範本檔案的數量
  - base64Content - 替換檔案 Base64 String
  - contentType - 替換檔案的 Mime Type (Ex: application/pdf)
  - fileName - 替換檔案的檔案名稱
- templateId - 範本 Id

回傳

{
  "body": {
    "instanceId": "string",
    "signUrl": "string"
  },
  "errorCode": 0,
  "message": "string"
}

instanceId - 任務 Instance Id
signUrl - 簽署連結，當發起人為現場簽主持人時，會回傳簽署連結

使用範本建立任務

參數

回傳

預填資料

額外審核人員

errorCode 錯誤代碼