錯誤碼

CodeReasonDescription
200OKAPI 呼叫成功
400Bad Request缺少必填參數或是參數名稱錯誤
401Unauthorized未輸入API Key或是使用錯誤API Key,請參考開始使用取得API Key
403Forbidden沒有權限去取得請求的資料
404Not Found找不到請求的資料
422Unprocessable Entity參數數值錯誤,請參考錯誤訊息
500Internal Server Error伺服器發生錯誤

錯誤訊息

MessageDetail
API_KEY_AUTH_ERROR未輸入API Key或是使用錯誤API Key
IP_ERROR當前 IP 不在公司白名單內
REQUEST_FORBIDDEN沒有權限去取得請求的資料
TASK_NOT_COMPLETED任務尚未完成
TEMPLATE_NOT_FOUND找不到對應範本
TASK_NOT_FOUND找不到對應任務
EXPIRED_DATE_FORMAT_ERROR簽署期限格式錯誤
CC_FORMAT_ERROR副本收件人格式錯誤
DATA_PARAMS_ERRORdata欄位為空或是格式錯誤
PERSON_PARAMS_ERRORperson欄位為空或是格式錯誤
IMAGE_LIST_PARAMS_ERRORimageList欄位為空或是格式錯誤
PDF_FILE_PARAMS_ERRORpdfFile欄位為空或是格式錯誤
FILES_PARAMS_ERRORfiles欄位為空或是格式錯誤
NAME_PARAMS_ERRORname欄位為空或是格式錯誤
PERSON_PARAMS_DUPLICATEperson欄位的email在平行簽時不可重複
PERSON_PARAMS_FACE_ERRORperson欄位的isFace不可在範本簽署人不是現場簽時設定為 true
CONTENTS_PAGE_ERRORcontents欄位有包含錯誤的page數值
CONTENTS_ID_ERRORcontents欄位有包含錯誤的id數值
CONTENTS_TEXT_EMPTY_ERRORcontents欄位有必填text未填入值
CONTENTS_TEXT_EXCEED_ERRORcontents欄位有text數值超出文字maxlength設定
CONTENTS_TEXT_REGEX_ERRORcontents欄位有text數值不符合文字regex設定
CONTENTS_CHECKBOX_GROUP_ERRORcontents欄位有checkbox設定錯誤
CONTENTS_CHECKBOX_RULE_ERRORcontents欄位有checkbox不符合rule設定
CONTENTS_DATE_EMPTY_ERRORcontents欄位有必填date未填入值
CONTENTS_RADIO_GROUP_ERRORcontents欄位有radio設定錯誤
CONTENTS_RADIO_SELECTED_ERRORcontents欄位有radio選取數量錯誤
CONTENTS_DROPDOWN_OPTIONS_EMPTY_ERRORcontents欄位有dropdown選項為空
CONTENTS_DROPDOWN_SELECTED_ERRORcontents欄位有必填dropdown未選取選項
MAX_TASK_PERSON_EXCEED簽署人數量超出最大簽署人限制
NOT_SUPPORT_USE_VIDEO方案不支援螢幕錄影
MAX_TASK_EXCEED任務數量超出最大任務數
NOT_SUPPORT_USE_IN_PERSON_SIGN方案不支援現場簽
NOT_SUPPORT_USE_MULTIPLE_FILE方案不支援多檔案簽署
MAX_FILE_COUNT_EXCEED簽署檔案數量超出最大檔案數量限制
MAX_FILE_SIZE_EXCEED簽署檔案大小超出最大檔案大小限制
MAX_TOTAL_FILE_SIZE_EXCEED簽署檔案加總大小超出最大檔案加總大小限制
MAX_IMAGE_FIELD_COUNT_EXCEED文件圖片欄位超出最大圖片欄位限制
MAX_ATTACHMENT_FIELD_COUNT_EXCEED文件附件欄位超出最大附件欄位限制
CLOUD_CERTIFICATE_COUNT_ERROR雲端憑證欄位數量必須符合每個簽署者都有一個欄位