Relatórios da campanha

Os seguintes métodos da Calls API podem ser usados para obter relatórios JSON da campanha:

• POST https://ds.tovie.ai/api/calls/campaign/{token}/callJob/getReport para o relatório de números.
  
• POST https://ds.tovie.ai/api/calls/campaign/{token}/callAttempt/getReport para o relatório de tentativas.

Corpo da solicitação

O corpo das solicitações para esse método contém um JSON com qualquer uma das seguintes propriedades:

• phones — uma matriz de números de telefone que devem ter as chamadas para eles canceladas.
• ids — uma matriz de IDs de trabalho de chamada que devem ser cancelados.

dica

Você também pode aprovar as duas propriedades em uma solicitação.

Exemplo de solicitação

curl --request POST 'https://ds.tovie.ai/api/calls/campaign/8231.7056.1b131df1/callJob/getReport' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phones": [
        551123456780
    ],
    "ids": [
        12345,
        67890
    ]
}'

Conteúdo do relatório

A resposta será uma matriz de objetos contendo informações variadas sobre trabalhos de chamada ou tentativas de chamada. Entre os mais utilizados deles estão:

• startedAt e finishedAt — hora Unix de início e término da chamada, em milissegundos.
• callDuration — a duração total da chamada, em segundos.
• callResult — o resultado da chamada.
• reportData — dados relatados no script.
• jobStatus — o status do trabalho de chamada no momento da geração do relatório.

Status do trabalho de chamada

Valor da propriedade	Descrição
canceled	A chamada foi cancelada.
inProcess	A chamada está em andamento.
longCallWithNoResult	A chamada foi concluída e não tem nenhum conjunto de resultados.
longCallWithResult	A chamada foi concluída e tem um conjunto de resultados.
noAnswer	Todas as tentativas de chamada não foram atendidas pelo cliente.
nonexistentNumber	A chamada foi feita para um número de telefone inexistente.
notDone	A chamada não foi concluída, mas a campanha foi interrompida.
onRetry	Uma nova tentativa de chamada está em andamento.
planned	A chamada está na fila, por exemplo, porque todas as linhas estão ocupadas.