Buscar registro de chamada por unidade

curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "search": "<string>",
    "operator": "<string>",
    "date": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "nDays": 123
  },
  "pagination": {
    "page": 123,
    "pageSize": 123
  },
  "orderBy": {
    "column": "<string>",
    "direction": "<string>"
  }
}
'

import requests

url = "https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}"

payload = {
    "filters": {
        "search": "<string>",
        "operator": "<string>",
        "date": "<string>",
        "startDate": "<string>",
        "endDate": "<string>",
        "nDays": 123
    },
    "pagination": {
        "page": 123,
        "pageSize": 123
    },
    "orderBy": {
        "column": "<string>",
        "direction": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: {
      search: '<string>',
      operator: '<string>',
      date: '<string>',
      startDate: '<string>',
      endDate: '<string>',
      nDays: 123
    },
    pagination: {page: 123, pageSize: 123},
    orderBy: {column: '<string>', direction: '<string>'}
  })
};

fetch('https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        'search' => '<string>',
        'operator' => '<string>',
        'date' => '<string>',
        'startDate' => '<string>',
        'endDate' => '<string>',
        'nDays' => 123
    ],
    'pagination' => [
        'page' => 123,
        'pageSize' => 123
    ],
    'orderBy' => [
        'column' => '<string>',
        'direction' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}"

	payload := strings.NewReader("{\n  \"filters\": {\n    \"search\": \"<string>\",\n    \"operator\": \"<string>\",\n    \"date\": \"<string>\",\n    \"startDate\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"nDays\": 123\n  },\n  \"pagination\": {\n    \"page\": 123,\n    \"pageSize\": 123\n  },\n  \"orderBy\": {\n    \"column\": \"<string>\",\n    \"direction\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {\n    \"search\": \"<string>\",\n    \"operator\": \"<string>\",\n    \"date\": \"<string>\",\n    \"startDate\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"nDays\": 123\n  },\n  \"pagination\": {\n    \"page\": 123,\n    \"pageSize\": 123\n  },\n  \"orderBy\": {\n    \"column\": \"<string>\",\n    \"direction\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {\n    \"search\": \"<string>\",\n    \"operator\": \"<string>\",\n    \"date\": \"<string>\",\n    \"startDate\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"nDays\": 123\n  },\n  \"pagination\": {\n    \"page\": 123,\n    \"pageSize\": 123\n  },\n  \"orderBy\": {\n    \"column\": \"<string>\",\n    \"direction\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "items": [
    {
      "message": "<string>",
      "id": "<string>",
      "callId": "<string>",
      "callName": "<string>",
      "unityId": "<string>",
      "successEvaluation": true,
      "botId": "<string>",
      "audioFileUrl": "<string>",
      "agentRecordingUrl": "<string>",
      "userRecordingUrl": "<string>",
      "endCallType": "<string>",
      "callType": "<string>",
      "dateFormatted": "<string>",
      "costBreakdown": {},
      "duration": 123,
      "phone": "<string>",
      "callDate": "<string>",
      "dataStructure": {},
      "durationFormatted": "<string>",
      "transcription": [
        {}
      ],
      "metadata": {},
      "callTime": "<string>",
      "totalCost": 123,
      "summary": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pagination": {
    "currentPage": 123,
    "hasNextPage": true,
    "hasPreviousPage": true,
    "pageSize": 123,
    "totalItems": 123,
    "totalPages": 123
  }
}

POST

api

voice

call-logs

{unityId}

Buscar registro de chamada por unidade

curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "search": "<string>",
    "operator": "<string>",
    "date": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "nDays": 123
  },
  "pagination": {
    "page": 123,
    "pageSize": 123
  },
  "orderBy": {
    "column": "<string>",
    "direction": "<string>"
  }
}
'

import requests

url = "https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}"

payload = {
    "filters": {
        "search": "<string>",
        "operator": "<string>",
        "date": "<string>",
        "startDate": "<string>",
        "endDate": "<string>",
        "nDays": 123
    },
    "pagination": {
        "page": 123,
        "pageSize": 123
    },
    "orderBy": {
        "column": "<string>",
        "direction": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: {
      search: '<string>',
      operator: '<string>',
      date: '<string>',
      startDate: '<string>',
      endDate: '<string>',
      nDays: 123
    },
    pagination: {page: 123, pageSize: 123},
    orderBy: {column: '<string>', direction: '<string>'}
  })
};

fetch('https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        'search' => '<string>',
        'operator' => '<string>',
        'date' => '<string>',
        'startDate' => '<string>',
        'endDate' => '<string>',
        'nDays' => 123
    ],
    'pagination' => [
        'page' => 123,
        'pageSize' => 123
    ],
    'orderBy' => [
        'column' => '<string>',
        'direction' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}"

	payload := strings.NewReader("{\n  \"filters\": {\n    \"search\": \"<string>\",\n    \"operator\": \"<string>\",\n    \"date\": \"<string>\",\n    \"startDate\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"nDays\": 123\n  },\n  \"pagination\": {\n    \"page\": 123,\n    \"pageSize\": 123\n  },\n  \"orderBy\": {\n    \"column\": \"<string>\",\n    \"direction\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {\n    \"search\": \"<string>\",\n    \"operator\": \"<string>\",\n    \"date\": \"<string>\",\n    \"startDate\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"nDays\": 123\n  },\n  \"pagination\": {\n    \"page\": 123,\n    \"pageSize\": 123\n  },\n  \"orderBy\": {\n    \"column\": \"<string>\",\n    \"direction\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://chat.api.toolzz.com.br/api/v1/voice/call-logs/search/{unityId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": {\n    \"search\": \"<string>\",\n    \"operator\": \"<string>\",\n    \"date\": \"<string>\",\n    \"startDate\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"nDays\": 123\n  },\n  \"pagination\": {\n    \"page\": 123,\n    \"pageSize\": 123\n  },\n  \"orderBy\": {\n    \"column\": \"<string>\",\n    \"direction\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "items": [
    {
      "message": "<string>",
      "id": "<string>",
      "callId": "<string>",
      "callName": "<string>",
      "unityId": "<string>",
      "successEvaluation": true,
      "botId": "<string>",
      "audioFileUrl": "<string>",
      "agentRecordingUrl": "<string>",
      "userRecordingUrl": "<string>",
      "endCallType": "<string>",
      "callType": "<string>",
      "dateFormatted": "<string>",
      "costBreakdown": {},
      "duration": 123,
      "phone": "<string>",
      "callDate": "<string>",
      "dataStructure": {},
      "durationFormatted": "<string>",
      "transcription": [
        {}
      ],
      "metadata": {},
      "callTime": "<string>",
      "totalCost": 123,
      "summary": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pagination": {
    "currentPage": 123,
    "hasNextPage": true,
    "hasPreviousPage": true,
    "pageSize": 123,
    "totalItems": 123,
    "totalPages": 123
  }
}

Token de Acesso

string

Token de acesso (“Bearer” deve estar antes do token)

uuid

ID da unidade

object

required

Filtros aplicados na consulta.

Show Filters properties

string

Texto utilizado para busca.

string

Operador do filtro de período (ex: all_time).

string

Data específica usada no filtro.

string

Data inicial do intervalo de filtro.

string

Data final do intervalo de filtro.

number

Quantidade de dias considerada no filtro.

object

Configurações de paginação da consulta.

Show Pagination properties

number

required

Número da página atual.

number

required

Quantidade de itens por página.

object

Configurações de ordenação dos resultados.

Show OrderBy properties

string

required

Nome da coluna usada para ordenação.

string

required

Direção da ordenação (ex: ASC ou DESC).

Descrição da Resposta

Abaixo você verá a descrição da resposta da requisição com todos os registro existentes na unidade

string

required

Mensagem de retorno da operação.

array

required

Lista de logs de chamadas retornados na busca.

Show Call log properties

string

required

Mensagem de retorno do log de chamada.

string

required

Identificador único do log de chamada.

string

required

Identificador da chamada.

string

required

Nome da chamada.

string

required

Identificador da unidade associada.

boolean

required

Indica se a avaliação de sucesso da chamada foi positiva.

string

required

Identificador do bot associado à chamada.

string

URL do arquivo de áudio da chamada.

string

URL da gravação do agente.

string

URL da gravação do usuário.

string

required

Tipo de encerramento da chamada.

string

required

Tipo da chamada, como WEB ou PHONE.

string

Data formatada da chamada.

object

Detalhamento dos custos da chamada.

number

required

Duração da chamada em segundos.

string

Telefone associado à chamada.

string

required

Data e hora da chamada.

object

Estrutura de dados adicional da chamada.

string

required

Duração da chamada formatada.

array

Lista de transcrições da chamada.

object

Metadados adicionais da chamada.

string

required

Horário da chamada.

number

required

Custo total da chamada.

string

Resumo da chamada.

string

required

Data e hora de criação do registro.

string

Data e hora da última atualização do registro.

object

required

Informações de paginação da busca.

Show Pagination properties

number

required

Página atual da listagem.

boolean

required

Indica se existe próxima página.

boolean

required

Indica se existe página anterior.

number

required

Quantidade de itens por página.

number

required

Total de itens encontrados.

number

required

Total de páginas disponíveis.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.

​Token de Acesso

​Descrição da Resposta

​Segurança

Token de Acesso

Descrição da Resposta

Segurança