Exemplos de pedidos de ligação
Chamadas completas para listar, consultar, criar, atualizar e excluir pedidos de ligação em /api/2.0.
Os pedidos de ligação permitem que os clientes peçam um retorno da equipe de suporte. Esta página mostra chamadas práticas para cada operação da forma API 2.0.
Obter todos os pedidos de ligação
Retorna a lista de todos os pedidos de ligação com suas propriedades. Você pode usar parâmetros de consulta, como status ou date_range, para filtrar o resultado.
/api/2.0/call_requestsAdminRetorna todos os pedidos de ligação
Exemplo de requisição
curl "$BASE_URL/api/2.0/call_requests" \
-u "$EMAIL:$API_KEY"Obter um pedido de ligação específico
Retorna um pedido de ligação pelo ID. Este exemplo retorna o pedido com request_id=1 e todas as suas propriedades.
/api/2.0/call_requests/{id}AdminRetorna um pedido de ligação específico
Parâmetros de caminho
idintegerobrigatórioExemplo de requisição
curl "$BASE_URL/api/2.0/call_requests/1" \
-u "$EMAIL:$API_KEY"Criar um novo pedido de ligação
Cria um novo pedido de ligação no sistema. É obrigatório informar pelo menos email ou phone.
/api/2.0/call_requestsAdminCria um novo pedido de ligação
Corpo da requisição
emailstringphone não for informado.phonestringemail não for informado.namestringtime_fromstringtime_tostringuser_idintegerorder_idintegerproduct_idintegertimestampintegerstatusstringnotesstringcart_productsarrayExemplo de requisição
Este exemplo cria um novo pedido de ligação de John Doe, que pede para ser contatado entre 9h e 10h no telefone informado.
curl -X POST "$BASE_URL/api/2.0/call_requests" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "+7(999)111-22-33",
"name": "John Doe",
"time_from": "9:00",
"time_to": "10:00"
}'Resposta
{
"request_id": 5
}Atualizar um pedido de ligação
Atualiza um pedido de ligação existente. Os campos que você pode alterar são user_id (ID do usuário associado), order_id (ID do pedido associado), product_id (ID do produto associado), status (status atual do pedido de ligação) e notes (observações adicionais).
/api/2.0/call_requests/{id}AdminAtualiza um pedido de ligação existente
Parâmetros de caminho
idintegerobrigatórioExemplo de requisição
Este exemplo muda o status do pedido de ligação com request_id=5 para "No Answer" (sem resposta) e adiciona a observação correspondente.
curl -X PUT "$BASE_URL/api/2.0/call_requests/5" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "no_answer",
"notes": "John didn'\''t answer the call"
}'Resposta
{
"request_id": 5
}Excluir um pedido de ligação
Exclui um pedido de ligação específico do sistema. Este exemplo exclui o pedido com request_id=5.
/api/2.0/call_requests/{id}AdminExclui um pedido de ligação
Parâmetros de caminho
idintegerobrigatórioExemplo de requisição
curl -X DELETE "$BASE_URL/api/2.0/call_requests/5" \
-u "$EMAIL:$API_KEY"Erros
| Status | Descrição |
|---|---|
204 No Content | O pedido de ligação foi excluído com sucesso. |
400 Bad Request | Não foi possível excluir o pedido de ligação. |
404 Not Found | O pedido de ligação informado não existe. |