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?

Visão geral dos webhooks disponíveis

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.

Códigos de relatório de entrega

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.

Códigos de detalhes do relatório de entrega

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)

Códigos de detalhes do relatório de entrega no código de resposta 5

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": "svt1jtrmekgb67ratwa31ptupc",
		"webhook_type": "delivery_report",
		"username": "myusername",
		"message": {
			"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
			"datetime": "2019-01-01 00:00:00",
			"content": "here comes your message body",
			"sender": "yoursender",
			"receiver": "32470123456",
			"reference": "yourref",
			"delivery_code": "1",                                       [Possible values: 0,1,2,3,4,9]
			"delivery_status": "delivered"                              [code explanation]
			"delivery_code_detail": "10",                               [delivery code with additional details]
			"delivery_code_detail_description": "Unknown Subscriber"    [detailed explanation]
		}
	}
]

Exemplo: mensagem recebida

								[
	{
		"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
		"webhook_type": "inbox_message",
		"username": "myusername",
		"message": {
			"id": "12345678",
			"date": "2019-01-01 00:00:00",
			"sender": "sendernumber",
			"receiver": "12345678",
			"content": "message content",
			"type": "sms"                       [Possible values: sms,whatsapp]
		}
		"isreply": {							[The isreply content will only be added when the message was replied to another message]
			"reply": true,						
			"orig_message_content": "original message content",
			"orig_messageid": "985zvqipp73csuuha2079fbshx",
			"orig_messagedate": "2019-01-01 00:00:00",
			"orig_sender": "32471123456",
			"orig_receiver": "12345678",
			"orig_reference": ""
		}
	}
]

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

								[
	{
		"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
		"webhook_type": "read_report",
		"username": "myusername",
		"message": {
			"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
			"datetime": "2019-01-01 00:00:00",
			"content": "here comes your message body",
			"sender": "yoursender",
			"receiver": "32470123456",
			"reference": "yourref",
			"delivery_code": "1",
			"delivery_status": "delivered"
			"read_status": "message_read",
			"read_datetime": "2019-01-01 00:01:00"
		}
	}
]

Webhooks

Smstools
Webhooks Smstools Webhooks
5 de 5 baseado em 2469 avaliações de usuários.
WEBHOOKS WEBHOOKS1