团队端点

团队表示可以分配给代理的分组，然后可以分配给队列。每个对象代表一个团队。

有三个团队端点：

  • /team - 拉取团队列表。

  • /team/tree - 以树形结构拉取团队。

  • /team/{:id} - 拉取单个团队资源。

请查看以下模型，以确定哪些字段可能包含个人身份信息。

[
  {
    "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 字符串 与“每”搭配使用，以注明记录的页码。例如，如果“每”设置为 200，而“页面”设置为 2，则响应将包含记录 201-400，因为第 1 页将包含 1-200。
每 FALSE 字符串 与“页面”搭配使用，以注明记录页中包含的记录数。例如，如果“每”设置为 200，而“页面”设置为 2，则响应将包含记录 201-400，因为第 1 页将包含 1-200。
agents_count[from] FALSE 数字 创建代理计数字段的下限。返回的所有记录都将大于输入的值。
agents_count[to] FALSE 数字 创建代理计数字段的上限。返回的所有记录都将小于输入的值。
id[] FALSE 数组 [字符串] 数组 [字符串]。要搜索和返回的记录的 ID
name[] FALSE 数组 [字符串] 根据资源名称返回记录。
parent_id[] FALSE 数组 [字符串] 根据给定记录的父级 ID 返回记录
position[] FALSE 数组 [字符串] 根据菜单所处的位置返回记录
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