Endpoints da equipe

As equipes representam um agrupamento a que um agente pode ser atribuído e que, por sua vez, pode ser atribuído a uma fila. Cada objeto representa uma única equipe.

Há três endpoints de equipe:

• /team: extrai uma lista de equipes.

• /team/tree: extrai equipes em uma estrutura de árvore.

• /team/{:id} - extrai um único recurso de equipe.

Analise o modelo a seguir para determinar quais campos podem conter informações de identificação pessoal (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"
    }
  }
]

Lista de equipes

Parâmetro	Obrigatório	Tipo de dados	Definição
sort_column	FALSO	String	Classifica a resposta com base em qualquer campo no objeto de resposta.
sort_direction	FALSO	ASC ou DESC	Indica a direção da classificação, crescente ou decrescente.
page	FALSO	String	Emparelha com "per" para indicar qual página de registros. Por exemplo, se "per" for definido como 200 e "page" for 2, a resposta vai conter os registros 201 a 400, já que a página 1 contém os registros 1 a 200.
per	FALSO	String	Emparelha com "page" para indicar quantos registros serão incluídos em uma página de registros. Por exemplo, se "per" for definido como 200 e "page" for 2, a resposta vai conter os registros 201 a 400, já que a página 1 contém os registros 1 a 200.
agents_count[from]	FALSO	Número	Cria um limite inferior do campo de contagem de agentes. Todos os registros retornados serão posteriores ao valor inserido.
agents_count[to]	FALSO	Número	Cria um limite superior do campo de contagem de agentes. Todos os registros retornados serão anteriores ao valor inserido.
id[]	FALSO	Array[String]	Array[Strings]. ID dos registros a serem pesquisados e retornados
name[]	FALSO	Array[String]	Retorna registros com base no nome do recurso.
parent_id[]	FALSO	Array[String]	Retorna registros com base no ID pai dos registros fornecidos.
position[]	FALSO	Array[String]	Retorna registros com base na posição em que um menu está.
with_deleted	FALSO	Booleano	Retorna registros que foram excluídos (True) ou não inclui registros que foram excluídos (False).

Endpoint:

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

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: lista de equipes

Corpo: nenhum

Exemplo de resposta: lista de equipes

[
  {
    "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"
      }
    ]
  }
]

Código de status: 200

Equipe única

Parâmetro	Obrigatório	Tipo de dados	Definição
record_id	FALSO	String	Retorna um registro específico com base no ID.
with_deleted	FALSO	Booleano	Retorna registros que foram excluídos (True) ou não inclui registros que foram excluídos (False).

Endpoint:

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

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: equipe única

Corpo: nenhum

Exemplo de resposta: equipe única

    {
        "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"
            }
        ]
    }

Código de status: 200

Árvore de equipes

Endpoint:

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

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: árvore de equipes

Corpo: nenhum

Exemplo de resposta: árvore de equipes

[
  {
    "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": []
      }
    ]
  }
]

Código de status: 200