API legada/Referência completa/Pedidos de ligação

Endpoints de pedidos de ligação

As URLs da API 2.0 de Call Requests: listar e criar pedidos, e consultar, atualizar ou excluir um pelo ID.

A API de Call Requests gerencia os pedidos de retorno de ligação dos clientes. Esta página documenta as duas URLs da API sob /api/2.0: /api/2.0/call_requests para a coleção e /api/2.0/call_requests/{id} para um pedido. As duas usam HTTP Basic com o e-mail:chave_de_api do administrador.

Listar pedidos de ligação

Retorna todos os pedidos de ligação. Use os parâmetros de paginação para limitar o resultado, veja Paginação e filtros.

GET/api/2.0/call_requestsAdmin

Retorna todos os pedidos de ligação

Parâmetros de consulta

pageintegerpadrão: 1

Página de resultados a retornar.

items_per_pageintegerpadrão: 10

Quantidade de pedidos de ligação em cada página.

Exemplo de requisição

bash

curl "$BASE_URL/api/2.0/call_requests?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Criar um pedido de ligação

Cria um novo pedido de ligação. O corpo é um objeto JSON com os dados do pedido.

POST/api/2.0/call_requestsAdmin

Cria um novo pedido de ligação

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/2.0/call_requests" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "notes": "Customer is interested in our Enterprise plan",
  "priority": "high",
  "assignee_id": 42
}'

Resposta

201Pedido de ligação criado

json

{
  "id": 12345,
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "created_at": "2025-04-16T10:25:32Z",
  "notes": "Customer is interested in our Enterprise plan",
  "status": "pending",
  "priority": "high",
  "assignee_id": 42
}

Consultar um pedido de ligação

Retorna informações detalhadas sobre o pedido de ligação informado.

GET/api/2.0/call_requests/{id}Admin

Retorna um pedido de ligação específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do pedido de ligação.

Exemplo de requisição

bash

curl "$BASE_URL/api/2.0/call_requests/12345" \
  -u "$EMAIL:$API_KEY"

Atualizar um pedido de ligação

Atualiza um pedido de ligação. O corpo é um objeto JSON com os campos a atualizar.

PUT/api/2.0/call_requests/{id}Admin

Atualiza um pedido de ligação

Parâmetros de caminho

idintegerobrigatório

O identificador único do pedido de ligação.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/2.0/call_requests/12345" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "completed",
  "notes": "Customer was contacted and purchased the Enterprise plan",
  "completed_at": "2025-04-17T15:45:22Z"
}'

Resposta

200Pedido de ligação atualizado

json

{
  "id": 12345,
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "created_at": "2025-04-16T10:25:32Z",
  "updated_at": "2025-04-17T15:45:22Z",
  "notes": "Customer was contacted and purchased the Enterprise plan",
  "status": "completed",
  "priority": "high",
  "assignee_id": 42,
  "completed_at": "2025-04-17T15:45:22Z"
}

Excluir um pedido de ligação

Remove o pedido de ligação do sistema de forma permanente.

DELETE/api/2.0/call_requests/{id}Admin

Exclui um pedido de ligação

Parâmetros de caminho

idintegerobrigatório

O identificador único do pedido de ligação.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/2.0/call_requests/12345" \
  -u "$EMAIL:$API_KEY"

Códigos de status

Status	Descrição
`200 OK`	Requisição bem-sucedida (para `GET` e `PUT`).
`201 Created`	Recurso criado com sucesso (para `POST`).
`204 No Content`	Recurso excluído com sucesso (para `DELETE`).
`400 Bad Request`	Parâmetros da requisição inválidos.
`401 Unauthorized`	Falha na autenticação ou autenticação ausente.
`403 Forbidden`	Você não tem permissão para acessar o recurso.
`404 Not Found`	O recurso solicitado não existe.
`500 Internal Server Error`	Ocorreu um erro no servidor.

Veja também

API legada/Referência completa/Pedidos de ligação

Endpoints de pedidos de ligação

As URLs da API 2.0 de Call Requests: listar e criar pedidos, e consultar, atualizar ou excluir um pelo ID.

Listar pedidos de ligação

Retorna todos os pedidos de ligação. Use os parâmetros de paginação para limitar o resultado, veja Paginação e filtros.

GET/api/2.0/call_requestsAdmin

Retorna todos os pedidos de ligação

Parâmetros de consulta

pageintegerpadrão: 1

Página de resultados a retornar.

items_per_pageintegerpadrão: 10

Quantidade de pedidos de ligação em cada página.

Exemplo de requisição

bash

curl "$BASE_URL/api/2.0/call_requests?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Criar um pedido de ligação

Cria um novo pedido de ligação. O corpo é um objeto JSON com os dados do pedido.

POST/api/2.0/call_requestsAdmin

Cria um novo pedido de ligação

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/2.0/call_requests" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "notes": "Customer is interested in our Enterprise plan",
  "priority": "high",
  "assignee_id": 42
}'

Resposta

201Pedido de ligação criado

json

{
  "id": 12345,
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "created_at": "2025-04-16T10:25:32Z",
  "notes": "Customer is interested in our Enterprise plan",
  "status": "pending",
  "priority": "high",
  "assignee_id": 42
}

Consultar um pedido de ligação

Retorna informações detalhadas sobre o pedido de ligação informado.

GET/api/2.0/call_requests/{id}Admin

Retorna um pedido de ligação específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do pedido de ligação.

Exemplo de requisição

bash

curl "$BASE_URL/api/2.0/call_requests/12345" \
  -u "$EMAIL:$API_KEY"

Atualizar um pedido de ligação

Atualiza um pedido de ligação. O corpo é um objeto JSON com os campos a atualizar.

PUT/api/2.0/call_requests/{id}Admin

Atualiza um pedido de ligação

Parâmetros de caminho

idintegerobrigatório

O identificador único do pedido de ligação.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/2.0/call_requests/12345" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "completed",
  "notes": "Customer was contacted and purchased the Enterprise plan",
  "completed_at": "2025-04-17T15:45:22Z"
}'

Resposta

200Pedido de ligação atualizado

json

{
  "id": 12345,
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "created_at": "2025-04-16T10:25:32Z",
  "updated_at": "2025-04-17T15:45:22Z",
  "notes": "Customer was contacted and purchased the Enterprise plan",
  "status": "completed",
  "priority": "high",
  "assignee_id": 42,
  "completed_at": "2025-04-17T15:45:22Z"
}

Excluir um pedido de ligação

Remove o pedido de ligação do sistema de forma permanente.

DELETE/api/2.0/call_requests/{id}Admin

Exclui um pedido de ligação

Parâmetros de caminho

idintegerobrigatório

O identificador único do pedido de ligação.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/2.0/call_requests/12345" \
  -u "$EMAIL:$API_KEY"

Códigos de status

Status	Descrição
`200 OK`	Requisição bem-sucedida (para `GET` e `PUT`).
`201 Created`	Recurso criado com sucesso (para `POST`).
`204 No Content`	Recurso excluído com sucesso (para `DELETE`).
`400 Bad Request`	Parâmetros da requisição inválidos.
`401 Unauthorized`	Falha na autenticação ou autenticação ausente.
`403 Forbidden`	Você não tem permissão para acessar o recurso.
`404 Not Found`	O recurso solicitado não existe.
`500 Internal Server Error`	Ocorreu um erro no servidor.