任務
createBlankTask
此 API 端點允許您通過指定預約時間、預約人的詳細信息和主辦方組織的詳細信息來創建新的預約。API 將安排預約並包括主辦方和預約人的所有相關詳細信息。
Request:
範例
{
"business_id": 15,
"out_task_num": "XXXXXXXXX",
"out_task_type": "XXXXXXXXX",
"task_type": "normal",
"task_notify": false,
"task_time": "1703141398",
"task_remark": "remark_somthing",
"branch_code": 943,
"business_code": 2,
"room_type": "normal",
"video": true
}
參數 | 含義 | 類型 | 必填 | 默認值 | 描述 |
---|---|---|---|---|---|
HEADERS | |||||
Authorization | 登錄後,服務器返回的授權令牌。 | string | Y | Bearer | |
BODY | |||||
business_id | 業務流程 ID | number | Y | ||
out_task_num | 外部可訪問的唯一標識符 | string | Y | ||
out_task_type | 外部可訪問的類型標識符 | string | N | ||
task_type | 案件分類 | string | Y | normal: 一般預約 | |
custom: 客戶服務案件 | |||||
task_notify | 創建通知 | boolean | Y | false | 是否發送通知 |
task_time | 預定的視頻預約時間 | string | N | 如果未提供,默認為當前時間。 | 如果 room_type 為 normal 則必填 |
task_remarks | 備註 | string | N | ||
branch_code | 預約所在部門或單位的唯一代碼。 | string | Y | ||
business_code | 負責任務的辦公室或部門類型。 | string | N | ||
room_type | 視頻預約類型 | enum | Y | realtime: 實時視頻房間 | |
normal: 預定視頻房間 | |||||
video | 預約或會議是否需要視頻通話 | string | Y | ||
true | |||||
false |
Response:
{
"status": 1,
"message": "success",
"info": {
"task_num": "202312210000001"
}
}
參數 | 含義 | 類型 | 存在 | 默認值 | 描述 |
---|---|---|---|---|---|
BODY | |||||
status | 回應狀態 | string | Y | 0: 失敗 | |
1: 成功 | |||||
2: 警告 | |||||
message | 信息 | string | Y | 錯誤信息應在有錯誤時顯示。 | |
info | 返回信息 | object | Y | ||
task_num | 任務編號 | string | Y |
錯誤代碼:
以下是 API 返回的錯誤信息表。
代碼 | 狀態 | 錯誤 | 信息 |
---|---|---|---|
200 | 1 | success | |
0 | 錯誤信息 | ||
404 | 資源未找到 | ||
403 | 不允許訪問請求的資源 |
createTaskModerator
將用戶包含在具有主持人角色的案件中
Request:
範例
{
"task_num": "202402220000021",
"business_code": "2",
"branch_code": "85",
"emp_id":"unique_id"
}
參數 | 含義 | 類型 | 必填 | 默認值 | 描述 |
---|---|---|---|---|---|
HEADERS | |||||
Authorization | 登錄後,服務器返回的授權令牌。 | string | Y | Bearer | |
BODY | |||||
task_num | 任務編號 | string | Y | ||
business_code | 負責任務的辦公室或部門類型。 | string | N | ||
branch_code | 負責任務的辦公室或部門。 | string | N | ||
emp_id | 主持人的唯一標識符, | ||||
使用 getAuthCode 函數時,需要傳遞 user_id 作為參數。user_id 可以用於 emp_id | string | N | 如果未提供 emp_id 字段,主持人登錄令牌將寫入主持人加入案件。 | ||
QUERY |
Response:
{
"status": 1,
"message": "service member success"
}
參數 | 含義 | 類型 | 存在 | 默認值 | 描述 |
---|---|---|---|---|---|
BODY | |||||
status | 回應狀態 | string | Y | 0: 失敗 | |
1: 成功 | |||||
2: 警告 | |||||
message | 信息 | string | Y | “” | 錯誤信息應在有錯誤時顯示。 |
錯誤代碼:
以下是 API 返回的錯誤信息表。
代碼 | 狀態 | 錯誤 | 信息 |
---|---|---|---|
200 | 1 | service member success | |
0 | 錯誤信息 | ||
404 | 資源未找到 | ||
403 | 不允許訪問請求的資源 |
createTaskPublisher
將一個或多個參與者添加到案件中。
Request:
範例
{
"task_num": "202402220000021",
"customer": [{
"customer_title": "Mr.",
"customer_name": "name",
"customer_id_num": "unique_id",
"customer_country_code": "+886",
"customer_phone": "0911211211",
"customer_email": "[email protected]"
}]
}
參數 | 含義 | 類型 | 必填 | 默認值 | 描述 |
---|---|---|---|---|---|
HEADERS | |||||
Authorization | 登錄後,服務器返回的授權令牌。 | string | Y | Bearer | |
BODY | |||||
task_num | 任務編號 | string | Y | ||
customer | 將推送發布者添加到任務中 | array | Y | ||
customer.customer_title | 客戶稱謂 | string | |||
customer.customer_name | 客戶姓名 | string | Y | ||
customer.customer_id_num | 客戶的唯一標識符 | string | Y | ||
customer.customer_country_code | 客戶電話國碼 | string | |||
customer.customer_phone | 客戶電話號碼 | string | |||
customer.customer_email | 客戶電子郵件 | string |
Response:
{
"status": 1,
"message": "customer member success"
}
參數 | 含義 | 類型 | 存在 | 默認值 | 描述 |
---|---|---|---|---|---|
BODY | |||||
status | 回應狀態 | string | Y | 0: 失敗 | |
1: 成功 | |||||
2: 警告 | |||||
message | 信息 | string | Y | “” | 錯誤信息應在有錯誤時顯示。 |
錯誤代碼:
以下是 API 返回的錯誤信息表。
代碼 | 狀態 | 錯誤 | 信息 |
---|---|---|---|
200 | 1 | customer member success | |
0 | 錯誤信息 | ||
404 | 資源未找到 | ||
403 | 不允許訪問請求的資源 |
updateTaskStatus
將案件的狀態設置為新值。只有具有主持人權限的用戶才能修改案件狀態。
Request:
範例
{
"task_num":"202406060000001",
"task_status":"finished"
}
參數 | 含義 | 類型 | 必填 | 默認值 | 描述 |
---|---|---|---|---|---|
HEADERS | |||||
Authorization | 登錄後,服務器返回的授權令牌。 | string | Y | Bearer | |
BODY | |||||
task_num | 任務編號 | string | Y | ||
task_status | 任務狀態 | string | Y | finished: 案件處理完成 | |
canceled: 取消案件 | |||||
QUERY |
Response:
{
"status": 1,
"message": "success"
}
參數 | 含義 | 類型 | 存在 | 默認值 | 描述 |
---|---|---|---|---|---|
BODY | |||||
status | 回應狀態 | string | Y | 0: 失敗 | |
1: 成功 | |||||
2: 警告 | |||||
message | 信息 | string | Y | “” | 錯誤信息應在有錯誤時顯示。 |
錯誤代碼:
以下是 API 返回的錯誤信息表。
代碼 | 狀態 | 錯誤 | 信息 |
---|---|---|---|
200 | 1 | success | |
0 | 錯誤信息 | ||
404 | 資源未找到 | ||
403 | 不允許訪問請求的資源 |