Smstools

Webhooks

Ontvang realtime terugkoppelingen over updates in Smstools.

Wat zijn webhooks?

Wat zijn webhooks?

Webhooks zijn een uitbreiding van een API, maar in plaats van dat jouw code gegevens opvraagt van Smstools, stuurt Smstools gegevens naar jou. De gegevens komen aan in een webverzoek naar jouw toepassing. Webhooks worden ook gebruikt om jouw toepassing op de hoogte te stellen van gebeurtenissen zoals een inkomend gesprek of bericht. Omdat de servers van Smstools gegevens naar jouw toepassing moeten kunnen sturen via webhooks, moet je een webserver opzetten om de inkomende HTTP-verzoeken te ontvangen. Je moet ook de URL van elke webhook op jouw webserver specificeren, zodat gegevens naar elk kunnen worden verzonden.

Wat zijn webhooks?

Overzicht beschikbare webhooks

Type Omschrijving
delivery_report Rapportage na elk verzonden bericht. Soms kunnen er 2 webhooks zijn: eerst een 'ingediende' status en later een 'afgeleverde' of 'niet afgeleverde' status. Soms zijn er aanvullende details beschikbaar wanneer het bericht niet is afgeleverd.
read_report Leesbevestiging nadat het bericht is gelezen. Een leesbevestiging is alleen beschikbaar voor Sociale Berichten of door gebruik te maken van de link 'Vraag om een leesrapport'.
inbox_message Inkomend bericht. Alleen beschikbaar als je Sociale Berichten of een virtueel nummer gebruikt.

Rapportagecodes bezorging

Codes voor detailrapportage bezorging Status Uitleg
0 SUBMITTED Dit bericht is afgeleverd bij de operator maar we hebben geen bezorgrapport ontvangen.
1 DELIVERED Dit bericht is succesvol afgeleverd.
2 NOT DELIVERED Dit bericht is niet afgeleverd. Mogelijke reden: ontvanger bevindt zich buiten het bereik van het netwerk, netwerkproblemen, ontvanger in buitenland.
3 BUFFERED Dit bericht is afgeleverd bij de operator maar niet bij de ontvanger.
4 REJECTED Dit bericht is geweigerd door de operator.
5 REJECTED Uitgebreide informatie hieronder!
9 UNKNOWN Er zijn geen bezorgrapporten beschikbaar voor dit bericht.

Codes voor detailrapportage bezorging

Status Uitleg
10 Ontvangersnummer is ongeldig of onbekend
11 Ontvanger bevindt zich tijdelijk buiten het bereik van de netwerkoperator
12 Probleem met de telefoon.
13 Probleem met het netwerk van de operator
14 Bericht verlopen - reden onbekend
15 Ontvanger staat op een zwarte lijst
16 Probleem met de inhoud van het bericht
17 Ontvanger kan niet worden afgehandeld
18 Operator heeft dit geweigerd vanwege spam
19 Abonnee kan geen premiumberichten ontvangen (geblokkeerd door operator)

Codes voor detailrapportage bezorging bij responscode 5

Status Uitleg
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

Voorbeeld: bezorgrapport

								[
	{
		"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]
		}
	}
]

Voorbeeld: inkomend bericht

								[
	{
		"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": ""
		}
	}
]

Voorbeeld: leesbevestigingsrapport

								[
	{
		"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 van de 5 op basis van 2430 gebruikersbeoordelingen.
WEBHOOKS WEBHOOKS1