Smstools

© 2025 All rights reserved, Smstools.

Webhooks

Receba chamadas de retorno em tempo real sobre atualizações no Smstools.

O que são webhooks?

O que são webhooks?

Webhooks são uma extensão de uma API, mas em vez de o seu código solicitar dados do Smstools, o Smstools envia dados para você. Os dados chegam em uma solicitação web para sua aplicação. Os webhooks também são usados para notificar sua aplicação sobre eventos como uma chamada ou mensagem recebida. Como os servidores do Smstools precisam ser capazes de enviar dados para sua aplicação por meio de webhooks, você precisa configurar um servidor web para receber as solicitações HTTP recebidas. Você também precisa especificar a URL de cada webhook em seu servidor web para que os dados possam ser enviados para cada um.

O que são webhooks?

Tipo Descrição
delivery_report Relatório de entrega após cada mensagem enviada. Às vezes, pode haver 2 webhooks: primeiro um status 'enviado' e depois um status 'entregue' ou 'não entregue'. Às vezes, há detalhes adicionais disponíveis quando a mensagem não é entregue.
read_report Confirmação de leitura após a leitura da mensagem. Uma confirmação de leitura está disponível apenas para Mensagens Sociais ou usando o link 'Solicitar um relatório de leitura'.
inbox_message Mensagem recebida. Disponível apenas se você estiver usando Mensagens Sociais ou um número virtual.
call_forwarding Reencaminhamento de chamadas. Disponível apenas se estiver a utilizar Mensagens Sociais ou um número virtual.
add_contact 1 contato foi adicionado via API ou software
delete_contact 1 contato foi removido via API ou software
add_group Um grupo foi adicionado via API ou software
delete_group Um grupo foi removido via API ou software
add_optout Um contato foi adicionado à lista de opt-out via API ou software
delete_optout Um contato foi removido da lista de opt-out via API ou software
funds_purchased A conta concluiu uma nova compra de créditos
insufficient_funds A conta não possui mais créditos disponíveis
email2sms_received Email2Sms recebeu um e-mail e tentou enviá-lo via SMS

Códigos de detalhes do relatório de entrega Status Explicação
0 SUBMITTED Esta mensagem foi entregue com o operador, mas não recebemos nenhum relatório de entrega.
1 DELIVERED Esta mensagem foi entregue com sucesso.
2 NOT DELIVERED Esta mensagem não foi entregue. Possível motivo: o destinatário está fora do alcance da rede, problemas de rede, destinatário em país estrangeiro.
3 BUFFERED Esta mensagem foi entregue com o operador, mas não entregue ao destinatário.
4 REJECTED Esta mensagem foi recusada pelo operador.
5 REJECTED Informações estendidas abaixo!
9 UNKNOWN Não há relatórios de entrega disponíveis para esta mensagem.

Status Explicação
10 O número do destinatário é inválido ou desconhecido
11 O destinatário está temporariamente fora do alcance do operador de rede
12 Problema relacionado ao telefone.
13 Problema de rede do operador
14 Mensagem expirada - motivo desconhecido
15 O destinatário está listado em uma lista negra
16 Problema de conteúdo da mensagem
17 O destinatário não pode ser resolvido
18 O operador recusou isso devido a spam
19 O assinante não pode receber mensagens premium (bloqueado pelo operador)

Status Explicação
2000 INSUFFICIENT_FUNDS
2001 TOO_LONG
2002 TOO_SHORT
2003 TIMEOUT
2004 GATEWAY_ISSUES
2005 INVALID_SENDER
2006 INVALID_NUMBER
4000 UNKNOWN
4001 EMPTY_MESSAGE
4002 EMPTY_CLIENT
4003 LOCKED
4004 BLOCKED
4005 JOB_FAILED
4006 DUPLICATE
4007 INVALID_CONTENT

Exemplo: relatório de entrega

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "delivery_report",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"message": {
	  "messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
	  "datetime": "2019-01-01 00:00:00",
	  "datetime_utc": "2019-01-01 00:00:00",
	  "content": "here comes your message body",
	  "sender": "yoursender",
	  "receiver": "32470123456",
	  "reference": "yourref",
	  "delivery_code": "1",
	  "delivery_status": "delivered",
	  "delivery_status_datetime": "2019-01-01 00:00:00",
	  "delivery_code_detail": "10",
	  "delivery_code_detail_description": "Unknown Subscriber"
	}
  }
]

Exemplo: mensagem recebida

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "inbox_message",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"message": {
	  "id": "12345678",
	  "date": "2019-01-01 00:00:00",
	  "date_utc": "2019-01-01 00:00:00",
	  "sender": "sendernumber",
	  "receiver": "12345678",
	  "content": "message content",
	  "type": "sms",
	  "file": null,
	  "processed": 0
	},
	"isreply": {
	  "reply": true,
	  "orig_message_content": "original message content",
	  "orig_messageid": "985zvqipp73csuuha2079fbshx",
	  "orig_messagedate": "2019-01-01 00:00:00",
	  "orig_messagedate_utc": "2019-01-01 00:00:00",
	  "orig_sender": "32471123456",
	  "orig_receiver": "12345678",
	  "orig_reference": ""
	}
  }
]

Exemplo: reencaminhamento de chamadas

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "call_forwarding",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"message": {
	  "id": "12345678",
	  "date": "2019-01-01 00:00:00",
	  "date_utc": "2019-01-01 00:00:00",
	  "sender": "sendernumber",
	  "receiver": "12345678",
	  "content": "Incoming VOIP Call - Forwarded to XXXXX",
	  "content_type": "complete",
	  "type": "call"
	}
  }
]

Exemplo: relatório de confirmação de leitura

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "read_report",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"message": {
	  "messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
	  "datetime": "2019-01-01 00:00:00",
	  "datetime_utc": "2019-01-01 00:00:00",
	  "content": "here comes your message body",
	  "sender": "yoursender",
	  "receiver": "32470123456",
	  "reference": "yourref",
	  "delivery_code": "1",
	  "delivery_status": "delivered",
	  "delivery_status_datetime": "2019-01-01 00:00:00",
	  "read_status": "message_read",
	  "read_datetime": "2019-01-01 00:01:00"
	}
  }
]

Exemplo: Adicionar contato

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "add_contact",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"contact": {
	  "action": "add",
	  "groupid": "12345",
	  "groupname": "Groupname",
	  "receiver": "32498123456",
	  "firstname": "John",
	  "lastname": "Doe",
	  "Custom1": null,
	  "Custom2": null,
	  "Custom3": null,
	  "Custom4": null,
	  "Custom5": null,
	  "Custom6": null,
	  "Custom7": null,
	  "Custom8": null,
	  "unsubscribed": null,
	  "unsubscribe_date": null
	}
  }
]

Exemplo: Excluir contato

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "delete_contact",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"contact": {
	  "action": "delete",
	  "groupid": "12345",
	  "groupname": "Groupname",
	  "receiver": "32498123456",
	  "firstname": "John",
	  "lastname": "Doe",
	  "Custom1": null,
	  "Custom2": null,
	  "Custom3": null,
	  "Custom4": null,
	  "Custom5": null,
	  "Custom6": null,
	  "Custom7": null,
	  "Custom8": null,
	  "unsubscribed": null,
	  "unsubscribe_date": null
	}
  }
]

Exemplo: Adicionar grupo

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "add_group",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"group": {
	  "action": "add",
	  "groupid": "12345",
	  "groupname": "Groupname"
	}
  }
]

Exemplo: Excluir grupo

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "delete_group",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"message": {
	  "id": "12345678",
	  "date": "2019-01-01 00:00:00",
	  "content": "Group deleted",
	  "type": "group"
	}
  }
]

Exemplo: Adicionar opt-out

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "add_optout",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"optout": {
	  "action": "add",
	  "id": "1234",
	  "number": "32498123456",
	  "memo": "Sample opt-out",
	  "date": "2025-08-04",
	  "date_utc": "2025-08-04"
	}
  }
]

Exemplo: Excluir opt-out

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "delete_optout",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"optout": {
	  "action": "delete",
	  "number": "32498123456",
	  "date": "2025-08-04",
	  "date_utc": "2025-08-04"
	}
  }
]

Exemplo: Créditos adquiridos

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "funds_purchased",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"funds": {
	  "order_id": "1234",
	  "item_amount": 1,
	  "currency": "eur",
	  "total_price": 10,
	  "price_excl": 0,
	  "purchase_type": "credits",
	  "payment_mode": "online",
	  "reference": "Reference",
	  "date": "2025-08-04 14:33:45",
	  "date_utc": "2025-08-04 12:33:45"
	}
  }
]

Exemplo: Créditos insuficientes

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "insufficient_funds",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"funds": {
	  "item_amount": "0.000",
	  "item_type": "balance",
	  "message": "Insufficient funds",
	  "date": "2025-08-04 14:34:22",
	  "date_utc": "2025-08-04 12:34:22"
	}
  }
]

Exemplo: Disparador Email2SMS

								[
  {
	"webhook_id": "a9b56720-7adc-4c78-a04d-62521d1d3b09",
	"webhook_type": "email2sms_received",
	"username": "myusername",
	"timezone": "Europe/Brussels",
	"email2sms": {
	  "sender": "[email protected]",
	  "receiver": {
		"group": false,
		"receiver": "32498123456"
	  },
	  "result": "Success",
	  "status": "Message Sent",
	  "email_message_id": "abc123def456",
	  "sms_message_id": "985zvqipp73csuuha2079fbshx",
	  "date": "2025-01-01 00:00:00",
	  "date_utc": "2025-01-01 00:00:00"
	}
  }
]