團隊端點

團隊代表可指派給專員的分組，然後指派給佇列。每個物件代表一個團隊。

共有三個團隊端點：

  • /team - 提取團隊清單。

  • /team/tree - 以樹狀結構提取團隊。

  • /team/{:id} - 提取單一團隊資源。

請查看下列模型，判斷哪些欄位可能含有 PII。

[
  {
    "id": 0,
    "name": "string",
    "parent_id": 0,
    "position": 0,
    "deleted": true,
    "agents_count": 0,
    "assignees": {
      "id": 0,
      "name": "string", // This may be considered PII
      "last_name": "string", // This may be considered PII
      "first_name": "string", // This may be considered PII
      "agent_number": "string", // This may be considered PII
      "avatar_url": "string"
    }
  }
]

小組清單

參數 必填 資料類型 定義
sort_column FALSE 字串 根據回應物件中的任何欄位排序回應。
sort_direction FALSE ASC 或 DESC 註明排序方向，是遞增還是遞減
頁面 FALSE 字串 搭配「per」使用，註明記錄的頁面。舉例來說，如果 per 設為 200，而 page 設為 2，則回應會包含記錄 201 到 400，因為第 1 頁會包含記錄 1 到 200。
/ FALSE 字串 與頁面配對，記錄一頁記錄中會包含多少筆記錄。舉例來說，如果 per 設為 200，而 page 設為 2，則回應會包含記錄 201 到 400，因為第 1 頁會包含記錄 1 到 200。
agents_count[from] FALSE 數字 建立代理程式計數字段的下限。系統會傳回輸入值之後的所有記錄。
agents_count[to] FALSE 數字 建立代理程式計數欄位的上限。傳回的所有記錄都會早於輸入值。
id[] FALSE Array[String] 字串陣列。要搜尋及傳回的記錄 ID
名稱 [] FALSE Array[String] 根據資源名稱傳回記錄。
parent_id[] FALSE Array[String] 根據指定記錄的父項 ID 傳回記錄
position[] FALSE Array[String] 根據選單所在位置傳回記錄
with_deleted FALSE 布林值 傳回已刪除的記錄 (True)，或不傳回已刪除的記錄 (False)

端點：

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams

更多要求/回應範例：

要求範例：團隊名單

內文：無

回覆範例：團隊清單

[
  {
    "id": 11,
    "name": "Forest Moon of Endor Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 19,
        "agent_number": "77",
        "name": "Storm Trooper 1",
        "last_name": "Storm",
        "first_name": "Trooper 1"
      },
      {
        "id": 20,
        "agent_number": "78",
        "name": "Storm Trooper 2",
        "last_name": "Storm",
        "first_name": "Trooper 2"
      },
      {
        "id": 21,
        "agent_number": "79",
        "name": "Storm Trooper 3",
        "last_name": "Storm",
        "first_name": "Trooper 3"
      }
    ]
  },
  {
    "id": 12,
    "name": "Death Star Team",
    "parent_id": null,
    "position": 28,
    "agents_count": 3,
    "deleted": false,
    "assignees": [
      {
        "id": 34,
        "agent_number": "80",
        "name": "Storm Trooper 5",
        "last_name": "Storm",
        "first_name": "Trooper 5"
      },
      {
        "id": 35,
        "agent_number": "81",
        "name": "Storm Trooper 6",
        "last_name": "Storm",
        "first_name": "Trooper 6"
      },
      {
        "id": 36,
        "agent_number": "82",
        "name": "Storm Trooper 7",
        "last_name": "Storm",
        "first_name": "Trooper 7"
      }
    ]
  }
]

狀態碼：200

單一團隊

參數 必填 資料類型 定義
record_id FALSE 字串 根據 ID 傳回特定記錄
with_deleted FALSE 布林值 傳回已刪除的記錄 (True)，或不傳回已刪除的記錄 (False)

端點：

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams/{​{team_id}​}

更多要求/回應範例：

要求範例：單一團隊

內文：無

回覆範例：單一團隊

    {
        "id": 11,
        "name": "Forest Moon of Endor Team",
        "parent_id": null,
        "position": 28,
        "agents_count": 3,
        "deleted": false,
        "assignees": [
            {
                "id": 19,
                "agent_number": "77",
                "name": "Storm Trooper 1",
                "last_name": "Storm",
                "first_name": "Trooper 1"
            },
            {
                "id": 20,
                "agent_number": "78",
                "name": "Storm Trooper 2",
                "last_name": "Storm",
                "first_name": "Trooper 2"
            },
            {
                "id": 21,
                "agent_number": "79",
                "name": "Storm Trooper 3",
                "last_name": "Storm",
                "first_name": "Trooper 3"
            }
        ]
    }

狀態碼：200

團隊樹狀結構

端點：

Method: GET
Type: 
URL: https://{​{subdomain}​}.{​{domain}​}/manager/api/v1/teams/tree

更多要求/回應範例：

要求範例：團隊樹狀結構

內文：無

回覆範例：團隊樹狀結構

[
  {
    "id": 147,
    "name": "Storm Trooper Reigment",
    "parent_id": null,
    "position": 1,
    "agents_count": 9,
    "deleted": false,
    "children": [
      {
        "id": 34,
        "name": "Storm Trooper 1st Regiment",
        "parent_id": 147,
        "position": 1,
        "agents_count": 2,
        "deleted": false,
        "children": []
      }
    ]
  }
]

狀態碼：200