API - Realtime - Dados de Fila

Disponível a partir da versão 6.9.10

Nos cabeçalhos dos requests, é necessário incluir uma chave "token" cujo valor seja um token de API.

Recuperar dados de uma única fila

Endpoint	/api/realtime/v1/queue/{queue_id}
Method	GET

Exemplos de retorno

200	`{ "meta": { "status": 200, "message": "OK" }, "data": { "queues": {}, "agents": {}, "calls": {} } }`
200	{ "meta": { "status": 200, "message": "OK" }, "data": { "queues": { "12": { "internal_number": "4000", "description": "Descrição da Fila de Teste", "limits": { "wanted_wait_time": 10, "wanted_talk_time": 8 }, "agent_ids": [ 1, 2 ], "id": 12, "name": "Operador Teste" } }, "agents": { "1": { "pause": { "productive": true, "automatic_unpause": false, "max_allowed_duration": "", "reason": "Treinamento", "pause_start": "2018-09-10T19:52:48+00:00", "type": "" }, "name": "Teste", "calls": [ "154e7c0c-b533-11e8-99d6-eb585623297f" ], "position": "700", "login_start": "2018-08-29T17:49:36+00:00", "login": "teste", "logged": true, "id": 1 } }, "calls": { "14a06d42-b533-11e8-99b3-eb585623297f": { "uuid": "14a06d42-b533-11e8-99b3-eb585623297f", "answered_time": "2018-09-10T19:52:46+00:00", "state": "talking", "callee_name": "u:e6ebf658-eeb2-2d1a-d877-4b7475ce15e3", "agent_id": 1, "queue_id": 12, "start_time": "2018-09-10T19:52:43+00:00", "callee_number": "u:e6ebf658-eeb2-2d1a-d877-4b7475ce15e3", "direction": "inbound", "caller_name": "Fila de Teste", "caller_number": "601" } } } }
404	`{ "meta": { "status": 404, "message": "Queue not found." } }`
429	`{ "meta": { "status": 429, "message": "Too Many Requests" } }`
422	`{ "meta": { "status": 422, "message": "Queue archived." }, "errors": [ "Request well-formed but has a semantic impossibility." ] }`

Recuperar dados de múltiplas filas

Endpoint	/api/realtime/v1/queue
Method	GET

Parâmetros

queue_ids	opcional	lista com os ids das filas, exemplo: queue_ids=1,2,3
group_id	opcional	id de um grupo de fila

200

{
  "meta": {
    "status": 200,
    "message": "OK"
  },
  "data": {
    "queues": {
      "12": {
        "internal_number": "4000",
        "description": "Descrição da Fila",
        "limits": {
          "wanted_wait_time": 10,
          "wanted_talk_time": 8
        },
        "agent_ids": [
          1,
          2
        ],
        "id": 12,
        "name": "pao"
      },
      "13": {
        "internal_number": "4001",
        "description": "",
        "limits": {
          "wanted_wait_time": 10,
          "wanted_talk_time": 8
        },
        "agent_ids": [
          1,
          2
        ],
        "id": 13,
        "name": "Fila de Teste"
      }
    },
    "agents": {
      "1": {
        "pause": {},
        "name": "Operador Teste",
        "calls": [],
        "position": "700",
        "login_start": "2018-08-29T17:49:36+00:00",
        "login": "teste",
        "logged": true,
        "id": 1
      }
    },
    "calls": {}
  }
}

Descrição da estrutura

{
  "meta": { ... },
  "data": {
    "queues": {
      "<ID_DA_FILA>": { ... }
	},
	"agents": {
      "<ID_DO_AGENTE>": { ... }
    },
    "calls": {
	  "<UUID_DA_CHAMADA>": { ... }
	}
  }
}

Descrição dos campos

Queue

Campo	Descrição	Tipo
id	ID da fila	int
name	Nome da fila	strint
`internal_number`	Número da fila	string
agent_ids	Lista com dos agentes associados a está fila	list
limits	Objeto contendo as informações de SLA	object

Limits

Campo	Descrição	Tipo
`wanted_wait_time`	SLA de espera configurado na fila	int
`wanted_talk_time`	Duração do SLA configurado na fila	int

Agent

Campo	Descrição	Tipo
id	ID do agente	integer
name	Nome do agente	string
position	Número do ramal que o agente está logado	string
login_start	Data e hora que agente entrou na fila	ISO8601
login	Login do agente	string
logged	Flag que indica se o agente está logado	boolean
pause	Dados da pausa	object
calls	Lista com os uuids das chamadas atuais do agente	list

Pause

Campo	Descrição	Tipo
`productive`	Flag que indica se a pause é produtiva	boolean
`automatic_unpause`	Flag que indica se a pausa será despausda automáticamente	boolean
`max_allowed_duration`	Tempo máximo da pausa	integer
`reason`	Motivo da pausa	string
`pause_start`	Data e hora que a pausa começou	ISO8601
`type`	Tipo da pausa.	string

Call

Campo	Descrição	Tipo
`uuid`	UUID da chamada	string
`start_time`	Data e hora que a chamada começou	ISO8601
`answered_time`	Data e hora que a chamada foi atendida	ISO8601
`state`	Status da chamada. Possíveis valores: dialing, talking, ringing.	string
`queue_id`	ID da fila	int
`agent_id`	ID do agente	int
`direction`	Direção da fila, indica se foi um receptivo (inbound) ou ativo (outbound). Possíveis valores: inbound e outbound	string
`caller_number`	Número de quem está ligando	string
`caller_name`	Nome de quem está ligando	string
`callee_number`	Número de quem atendeu a chamada	string
`callee_name`	Nome de quem atendeu a chamada	string