Endpoints de atividade do agente

Os registros de atividade do agente são criados sempre que o estado do widget muda. Isso pode acontecer ao fazer login no widget, receber uma notificação de chamada deltacast ou aceitar uma chamada, entre outros status. Cada atividade cria um novo objeto. Consulte o modelo a seguir para verificar quais campos podem conter (PII):

[
  {
    "id": 0,
    "agent_id": 0,
    "whodunnit": {
      "id": 0,
      "name": "string",
      "last_name": "string",
      "first_name": "string",
      "agent_number": "string",
      "avatar_url": "string"
    },
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "started_at": "2018-06-06T21:12:24.766Z",
    "ended_at": "2018-06-06T21:12:24.766Z",
    "duration": 0,
    "activity": "login",
    "call_id": 0,
    "chat_id": 0
  }
]

A tabela a seguir contém um resumo de todas as atividades que podem resultar na criação de um registro de atividade.

Atividade Descrição
chat_picked_up Evento que ocorre quando um agente atende um agente
chat_pick_up_attempt Evento que ocorre quando um agente tenta se tornar o agente respondente
chat_notification_offered Evento que ocorre quando um usuário final solicita uma sessão de chat e uma notificação é enviada aos agentes atribuídos a essa fila.
call_notification_offered Evento que ocorre quando um usuário final liga e uma notificação de chamada multicast ou deltacast é oferecida ao agente.
call_pick_up_attempt Evento que ocorre quando um agente tenta atender uma chamada multicast ou deltacast.
call_picked_up Evento que ocorre quando um agente atende uma chamada multicast ou deltacast.
deltacast_call_notification_offered Evento que indica que um usuário final ligou para uma fila com multicast em que uma chamada deltacast é transmitida para um agente nessa fila.
deltacast_call_pick_up_attempt Evento que ocorre quando um agente tenta atender uma chamada deltacast
deltacast_call_picked_up Evento que ocorre quando um agente atende uma chamada deltacast.
deltacast_call_missed Evento que ocorre quando um agente não atende a chamada deltacast
multicast_call_notification_offered Evento que indica que um usuário final ligou para uma fila com multicast em que uma chamada multicast é transmitida para os agentes nessa fila
multicast_call_pick_up_attempt Evento que ocorre quando uma chamada multicast é tentada por um agente
multicast_call_picked_up Evento que ocorre quando uma chamada multicast é atendida por um agente
call_outbound_dialing Evento que ocorre quando um agente usa o teclado de discagem no widget para ligar para um usuário final.
user_status_changed Evento que ocorre quando um agente muda o estado do widget
login Evento que ocorre quando um agente faz logout do widget
logout Evento que ocorre quando um agente faz login no widget

Registros de atividade do agente

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, seja crescente ou decrescente
página FALSO String Emparelha com "por" para indicar qual página de registros. Por exemplo, se "por" for 200 e a página for 2, a resposta vai conter o registro 201-400, já que a página 1 vai conter 1-200.
por FALSO String Emparelha com a página para indicar quantos registros serão incluídos em uma página de registros. Por exemplo, se "por" for 200 e a página for 2, a resposta vai conter o registro 201-400, já que a página 1 vai conter 1-200.
started_at[from] FALSO Horário em UTC Cria um limite inferior do campo "iniciado em". Todos os registros retornados serão posteriores ao valor inserido.
started_at[to] FALSO Horário em UTC Cria um limite superior do campo "iniciado em". Todos os registros retornados serão anteriores ao valor inserido.
ended_at[from] FALSO Horário em UTC Cria um limite inferior do campo "terminado em". Todos os registros retornados serão posteriores ao valor inserido.
ended_at[to] FALSO Horário em UTC Cria um limite superior do campo "terminado em". Todos os registros retornados serão anteriores ao valor inserido.
duration[from] FALSO Número Cria um limite inferior do campo "duração". Todos os registros retornados serão posteriores ao valor inserido.
duration[to] FALSO Número Cria um limite superior do campo "duração". Todos os registros retornados serão anteriores ao valor inserido.
id[] FALSO Matriz[String] Matriz[Strings]. ID dos registros a serem pesquisados e retornados
agent_id[] FALSO Matriz[String] Filtra a resposta pelo ID do agente
activity[] FALSO Matriz[String] Filtra os registros pela tarefa/atividade que o agente concluiu. Os valores possíveis são: login, logout, call_outbound_dialing, deltacast_call_notification_offered, deltacast_call_pick_up_attempt, deltacast_call_picked_up, deltacast_call_projected, deltacast_call_missed, deltacast_call_bounced, multicast_call_notification_offered, multicast_call_pick_up_attempt, multicast_call_picked_up, user_status_changed, chat_notification_offered, chat_pick_up_attempt, chat_picked_up
whodunnit_id[] FALSO Matriz[String] Filtra a resposta pelo ID do agente. Whodunnit é um subconjunto do objeto do agente e usa o mesmo agent_id como chave primária
call_id[] FALSO Matriz[String] Filtra os registros pelos IDs de chamada inseridos
chat_id[] FALSO Matriz[String] Filtra os registros pelos IDs de chat inseridos

Endpoint:

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

Mais exemplos de solicitações/respostas:

Exemplo de solicitação: registros de atividade do agente

Corpo: nenhum

Exemplo de resposta: registros de atividade do agente

[
    {
        "id": 190578,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-12-22T00:54:18.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "logout",
        "whodunnit": null
    },
    {
        "id": 199548,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2018-01-09T22:54:26.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "logout",
        "whodunnit": null
    },
    {
        "id": 190577,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-12-22T00:54:18.000Z",
        "ended_at": "2018-01-08T22:54:22.000Z",
        "duration": 1548004,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 199547,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2018-01-09T22:54:26.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 190270,
        "agent_id": 118,
        "status": {
            "id": -1,
            "name": "Unavailable",
            "color": "red",
        },
        "started_at": "2017-12-21T21:34:14.000Z",
        "ended_at": "2017-12-22T00:54:18.000Z",
        "duration": 12004,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 198036,
        "agent_id": 118,
        "status": {
            "id": -1,
            "name": "Unavailable",
            "color": "red",
        },
        "started_at": "2018-01-08T22:54:22.000Z",
        "ended_at": "2018-01-09T22:54:26.000Z",
        "duration": 86404,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 22249,
        "agent_id": 129,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-06-19T18:34:39.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "login",
        "whodunnit": null
    }
]

Código de status: 200