arctos-SDK 程式開發arctos-SDK 程式開發
回到官網
Okuma視訊應用
arctos視訊協作
聯絡我們
  • English
  • 繁體中文
回到官網
Okuma視訊應用
arctos視訊協作
聯絡我們
  • English
  • 繁體中文
  • 指導

    • 起始
  • 規格

    • 點對點直連
    • 中繼伺服器
  • Api

    • 概述
    • 授權
    • 任務
      • createBlankTask
      • createTaskModerator
      • createTaskPublisher
      • updateTaskStatus
    • 商業
    • 房間
  • 點對點直連

    • 概述
    • 安裝
    • 主要項目

      • 初始設定
      • 房間
      • 攝影機
      • 會議
      • 麥克風
      • 喇叭
      • 分享畫面
      • 繪圖板
      • 錄影
      • 圖層
  • 中繼伺服器

    • 概述
    • 安裝
    • 主要項目

      • 初始設定
      • 攝影機
      • 麥克風
      • 喇叭
      • 分享畫面
      • 繪圖板
      • 廣播訊息
      • 切換模板
      • 視訊濾鏡

任務

createBlankTask

此 API 端點允許您通過指定預約時間、預約人的詳細信息和主辦方組織的詳細信息來創建新的預約。API 將安排預約並包括主辦方和預約人的所有相關詳細信息。

/images/skip-forward_brown.svg /api/task/do_add
/images/transfers_orange.svg POST

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登錄後,服務器返回的授權令牌。stringYBearer
BODY
business_id業務流程 IDnumberY
out_task_num外部可訪問的唯一標識符stringY
out_task_type外部可訪問的類型標識符stringN
task_type案件分類stringYnormal: 一般預約
custom: 客戶服務案件
task_notify創建通知booleanYfalse是否發送通知
task_time預定的視頻預約時間stringN如果未提供,默認為當前時間。如果 room_type 為 normal 則必填
task_remarks備註stringN
branch_code預約所在部門或單位的唯一代碼。stringY
business_code負責任務的辦公室或部門類型。stringN
room_type視頻預約類型enumYrealtime: 實時視頻房間
normal: 預定視頻房間
video預約或會議是否需要視頻通話stringY
true
false

Response:

{
    "status": 1,
    "message": "success",
    "info": {
        "task_num": "202312210000001"
    }
}
參數含義類型存在默認值描述
BODY
status回應狀態stringY0: 失敗
1: 成功
2: 警告
message信息stringY錯誤信息應在有錯誤時顯示。
info返回信息objectY
task_num任務編號stringY

錯誤代碼:

以下是 API 返回的錯誤信息表。

代碼狀態錯誤信息
2001success
0錯誤信息
404資源未找到
403不允許訪問請求的資源

createTaskModerator

將用戶包含在具有主持人角色的案件中

/images/skip-forward_brown.svg /api/task/service/do_add
/images/transfers_orange.svg POST

Request:

範例

{
    "task_num": "202402220000021",
    "business_code": "2",
    "branch_code": "85",
    "emp_id":"unique_id"
}
參數含義類型必填默認值描述
HEADERS
Authorization登錄後,服務器返回的授權令牌。stringYBearer
BODY
task_num任務編號stringY
business_code負責任務的辦公室或部門類型。stringN
branch_code負責任務的辦公室或部門。stringN
emp_id主持人的唯一標識符,
使用 getAuthCode 函數時,需要傳遞 user_id 作為參數。user_id 可以用於 emp_idstringN如果未提供 emp_id 字段,主持人登錄令牌將寫入主持人加入案件。
QUERY

Response:

{
    "status": 1,
    "message": "service member success"
}
參數含義類型存在默認值描述
BODY
status回應狀態stringY0: 失敗
1: 成功
2: 警告
message信息stringY“”錯誤信息應在有錯誤時顯示。

錯誤代碼:

以下是 API 返回的錯誤信息表。

代碼狀態錯誤信息
2001service member success
0錯誤信息
404資源未找到
403不允許訪問請求的資源

createTaskPublisher

將一個或多個參與者添加到案件中。

/images/skip-forward_brown.svg /api/task/customer/do_add
/images/transfers_orange.svg POST

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登錄後,服務器返回的授權令牌。stringYBearer
BODY
task_num任務編號stringY
customer將推送發布者添加到任務中arrayY
customer.customer_title客戶稱謂string
customer.customer_name客戶姓名stringY
customer.customer_id_num客戶的唯一標識符stringY
customer.customer_country_code客戶電話國碼string
customer.customer_phone客戶電話號碼string
customer.customer_email客戶電子郵件string

Response:

{
    "status": 1,
    "message": "customer member success"
}
參數含義類型存在默認值描述
BODY
status回應狀態stringY0: 失敗
1: 成功
2: 警告
message信息stringY“”錯誤信息應在有錯誤時顯示。

錯誤代碼:

以下是 API 返回的錯誤信息表。

代碼狀態錯誤信息
2001customer member success
0錯誤信息
404資源未找到
403不允許訪問請求的資源

updateTaskStatus

將案件的狀態設置為新值。只有具有主持人權限的用戶才能修改案件狀態。

/images/skip-forward_brown.svg /api/task/do_save
/images/transfers_orange.svg POST

Request:

範例

{
    "task_num":"202406060000001",
    "task_status":"finished"
}
參數含義類型必填默認值描述
HEADERS
Authorization登錄後,服務器返回的授權令牌。stringYBearer
BODY
task_num任務編號stringY
task_status任務狀態stringYfinished: 案件處理完成
canceled: 取消案件
QUERY

Response:

{
    "status": 1,
    "message": "success"
}
參數含義類型存在默認值描述
BODY
status回應狀態stringY0: 失敗
1: 成功
2: 警告
message信息stringY“”錯誤信息應在有錯誤時顯示。

錯誤代碼:

以下是 API 返回的錯誤信息表。

代碼狀態錯誤信息
2001success
0錯誤信息
404資源未找到
403不允許訪問請求的資源

Prev
授權
Next
商業