팀 엔드포인트

팀은 상담사가 할당될 수 있는 그룹을 나타내며, 이 그룹은 대기열에 할당될 수 있습니다. 각 객체는 단일 팀을 나타냅니다.

팀 엔드포인트는 세 가지가 있습니다.

  • /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이면 페이지 1에 1~200이 포함되므로 응답에는 레코드 201~400이 포함됩니다.
/ FALSE 문자열 레코드 페이지에 포함될 레코드 수를 나타내는 페이지와 쌍을 이룹니다. 예를 들어 per이 200이고 page가 2이면 페이지 1에 1~200이 포함되므로 응답에는 레코드 201~400이 포함됩니다.
agents_count[from] FALSE 숫자 에이전트 수 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후의 값입니다.
agents_count[to] FALSE 숫자 상담사 수 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전입니다.
id[] FALSE Array[String] Array[Strings] 검색하고 반환할 레코드의 ID
name[] 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