Campos do pedido de ligação
Todos os campos de um pedido de ligação, com os métodos que os aceitam e seus valores aceitos.
Um pedido de ligação tem várias propriedades, cada uma representada por um campo. Esta página lista todos os campos que a API de Call Requests aceita. O * marca um campo obrigatório.
Referência de campos
| Campo | Descrição | Disponível nos métodos | Valores aceitos |
|---|---|---|---|
email* | E-mail do cliente que pediu a ligação. Obrigatório se não houver telefone. | GET, POST | string |
phone* | Telefone do cliente que pediu a ligação. Obrigatório se não houver e-mail. | GET, POST | string |
user_id | ID do administrador atribuído ao pedido de ligação. | GET, POST, PUT | integer |
order_id | ID do pedido associado ao pedido de ligação (feito com "Comprar agora com 1 clique"). | GET, POST, PUT | integer |
product_id | ID de um produto do pedido associado ao pedido de ligação. | GET, POST | integer |
timestamp | Carimbo de data e hora da criação. | GET, POST | Um timestamp válido, em segundos |
status | Status do pedido de ligação. | GET, POST, PUT | new, in_progress, completed, no_answer |
name | Nome do cliente que pediu a ligação. | GET, POST | string |
time_from | Início do período em que o cliente pode atender uma ligação. | GET, POST | string |
time_to | Fim do período em que o cliente pode atender uma ligação. | GET, POST | string |
notes | Observações sobre o pedido de ligação. | GET, POST | string |
cart_products | Um array com os nomes, IDs, quantidades e preços dos produtos do carrinho. Veja Produtos do carrinho. | GET, POST | array |
order_status | Status do pedido associado ao pedido de ligação. | GET | string |
product | Nome do produto que o usuário comprou com "Comprar agora com 1 clique". | GET | string |
Exemplo de uso
Criar um pedido de ligação
Esta chamada cria um novo pedido de ligação com os dados do cliente. É preciso informar email ou phone. Para a melhor experiência do cliente, colete os dois sempre que possível.
bash
curl -X POST "$BASE_URL/api/call_requests" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "customer@example.com",
"phone": "+1234567890",
"name": "John Smith",
"time_from": "14:00",
"time_to": "18:00",
"notes": "Customer has questions about product compatibility",
"product_id": 123
}'Atualizar um pedido de ligação
Esta chamada atualiza um pedido de ligação existente com um novo status.
bash
curl -X PUT "$BASE_URL/api/call_requests/123" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "completed",
"user_id": 42
}'