Skip to navigation
IntroduçãoExemplos de usoConsulta

Usando a API para consultar pausas

Para consultar pausas usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.

Cumprindo esse requisito, siga os passos descritos abaixo:

1. Listar todas as pausas

Este endpoint retorna todas as pausas cadastradas no sistema.

Exemplo de chamada:

curl -X GET "https://sua-conta.callix.com.br/api/v1/breaks" \
  -H "Authorization: Bearer SEU_TOKEN"

Exemplo de resposta:

{
  "meta": {
    "count": 2
  },
  "links": {
    "first": "/api/v1/breaks?page%5Blimit%5D=100&page%5Boffset%5D=0",
    "last": "/api/v1/breaks?page%5Blimit%5D=100&page%5Boffset%5D=0"
  },
  "data": [
    {
      "type": "breaks",
      "id": "1",
      "attributes": {
        "name": "Pausa 1"
      },
      "links": {
        "self": "/api/v1/breaks/1"
      }
    },
    {
      "type": "breaks",
      "id": "2",
      "attributes": {
        "name": "Pausa 2"
      },
      "links": {
        "self": "/api/v1/breaks/2"
      }
    }
  ]
}

A resposta inclui um array com todas as pausas cadastradas, seus IDs e nomes.

2. Consultar uma pausa específica

Este endpoint retorna informações detalhadas de uma pausa específica usando seu ID.

Exemplo de chamada:

curl -X GET "https://sua-conta.callix.com.br/api/v1/breaks/1" \
  -H "Authorization: Bearer SEU_TOKEN"

Exemplo de resposta:

{
  "data": {
    "type": "breaks",
    "id": "1",
    "attributes": {
      "name": "Pausa 1"
    },
    "links": {
      "self": "/api/v1/breaks/1"
    }
  }
}

Atributos

AtributoTipoDescrição
namestringNome da pausa