API - Dados Realtime de Campanha

Disponível a partir da versão 6.9.13

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

Recuperar dados de uma única campanha

Endpoint	/api/realtime/v1/campaign/{campaign_id}
Method	GET

Exemplos de retorno

200	`{ "meta": { "status": 200, "message": "OK" }, "data": { "campaigns": {}, "agents": {}, "calls": {} } }`
200	{ "meta": { "status": 200, "message": "OK" }, "data": { "campaigns": { "1": { "paused": false, "running": true, "name": "teste", "stalled": false, "in_working_time": true, "agent_ids": [ 1 ], "type": "transfer", "id": 1, "subscribers": { "scheduled": 0, "talking": 1, "retry": 0, "error": 0, "completed": 0, "total": 1, "dialing": 0, "pending": 0 } } }, "agents": { "1": { "pause": {}, "name": "Teste", "calls": [ "1e6516f8-b6b3-11e8-9e3a-eb585623297f" ], "position": "700", "login_start": "2018-09-12T17:41:45+00:00", "login": "teste", "logged": true, "id": 1 } }, "calls": { "1e6516f8-b6b3-11e8-9e3a-eb585623297f": { "uuid": "1e6516f8-b6b3-11e8-9e3a-eb585623297f", "start_time": "2018-09-12T17:41:46+00:00", "campaign_id": 1, "subscriber": { "external_id": null, "name": "601", "number": "601" }, "answered_time": "2018-09-12T17:41:48+00:00", "state": "talking", "agent_id": 1 } } } }
404	`{ "meta": { "status": 404, "message": "Campaign not found." } }`
429	`{ "meta": { "status": 429, "message": "Too Many Requests" } }`
422	`{ "meta": { "status": 422, "message": "Campaign archived." }, "errors": [ "Request well-formed but has a semantic impossibility." ] }`
400	`{ "meta": { "status": 400, "message": "Invalid campaign_ids value." } }`

Recuperar dados de múltiplas campanhas

Endpoint	/api/realtime/v1/campaign
Method	GET

campaign_ids	opcional	lista com os ids das campanhas, exemplo: campaign_ids=1,2,3

200

{
  "meta": {
    "status": 200,
    "message": "OK"
  },
  "data": {
    "campaigns": {
      "2": {
        "paused": false,
        "running": false,
        "name": "Marketing",
        "stalled": false,
        "in_working_time": null,
        "agent_ids": [],
        "type": "transfer",
        "id": 2,
        "subscribers": {
          "scheduled": null,
          "talking": null,
          "retry": null,
          "error": null,
          "completed": null,
          "total": null,
          "dialing": null,
          "pending": null
        }
      },
      "3": {
        "paused": false,
        "running": false,
        "name": "Campanha de Audio",
        "stalled": false,
        "in_working_time": null,
        "agent_ids": [],
        "type": "broadcast",
        "id": 3,
        "subscribers": {
          "scheduled": null,
          "talking": null,
          "retry": null,
          "error": null,
          "completed": null,
          "total": null,
          "dialing": null,
          "pending": null
        }
      },
      "4": {
        "paused": false,
        "running": false,
        "name": "Coleta de Digitos",
        "stalled": false,
        "in_working_time": null,
        "agent_ids": [],
        "type": "ivr",
        "id": 4,
        "subscribers": {
          "scheduled": null,
          "talking": null,
          "retry": null,
          "error": null,
          "completed": null,
          "total": null,
          "dialing": null,
          "pending": null
        }
      }
    },
    "agents": {},
    "calls": {}
  }
}

Descricão da estrutura

{
  "meta": { ... },
  "data": {
    "campaigns": {
      "<ID_DA_CAMPANHA>": { ... }
    },
    "agents": {
	  "<ID_DO_AGENTE>": { ... }
	},
    "calls": {
	  "<UUID_DA_CHAMADA>": { ... }
	}
  }
}

Descrição dos campos

Campaign

Campo	Descrição	Tipo
id	ID da campanha	integer
name	Nome da campanha	string
type	Tipo da campanha. Possíveis valores: ivr, transfer, broadcast	string
paused	Flag indicando se a campanha está pausada	boolean
running	Flag indicando se a campanha está em execução	boolean
stalled	Flag indicando se a campanha está estagnada	boolean
in_working_time	Flag indicando se a campanha está no horário de trabalho	boolean
agent_ids	Lista com os ids dos agentes da campanha	list
subscribers	Objeto com as informações dos assinantes	object

Subscribers

Campo	Descrição	Tipo
`scheduled`	Número de assinantes com status "agendado"	integer
`talking`	Número de assinantes com status "em chamada"	integer
`retry`	Número de assinantes com status "rediscar"	integer
`error`	Número de assinantes com status "erro"	integer
`completed`	Número de assinantes com status "completada"	integer
`dialing`	Número de assinantes com status "discando"	integer
`pending`	Número de assinantes com status "pendente"	integer
`total`	Total de assinantes	integer

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á despausada automaticamente	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
`campaign_id`	ID da campanha	integer
`start_time`	Data e hora que a chamada começou	integer
`answered_time`	Data e hora que a chamada foi atendida	integer
`state`	Status da chamada. Possíveis valores: dialing, talking, ringing.	string
`agent_id`	ID do agente que atendeu a chamada	integer
`subscriber`	Objeto com as informações do assinante	object

Subscriber

Campo	Descrição	Tipo
`name`	Nome do assinante	string
`number`	Número do assinante	string
`external_id`	ID externo do assinante	string