Smstools

© 2024 Wszystkie prawa zastrzeżone, Smstools.

Webhooki

Otrzymuj czasowe wywołania zwrotne dotyczące aktualizacji w Smstools.

Czym są webhooks?

Czym są webhooks?

Webhooki są rozszerzeniem interfejsu API, ale zamiast twój kod żądać danych od Smstools, Smstools wysyła dane do ciebie. Dane przychodzą w żądaniu sieciowym do twojej aplikacji. Webhooki są również używane do powiadamiania twojej aplikacji o zdarzeniach, takich jak przychodzące połączenie lub wiadomość. Ponieważ serwery Smstools muszą być w stanie wysyłać dane do twojej aplikacji za pomocą webhooków, musisz skonfigurować serwer sieciowy, aby otrzymywać przychodzące żądania HTTP. Musisz również określić URL każdego webhooka na swoim serwerze sieciowym, aby dane mogły być wysyłane do każdego.

Czym są webhooks?

Przegląd dostępnych webhooków

Typ Opis
delivery_report Raport dostarczenia po każdej wysłanej wiadomości. Czasami może być 2 webhooki: najpierw status „przesłano”, a później status „dostarczono” lub „nie dostarczono”. Czasami dostępne są dodatkowe szczegóły, gdy wiadomość nie została dostarczona.
read_report Potwierdzenie odczytu po przeczytaniu wiadomości. Potwierdzenie odczytu jest dostępne tylko dla Wiadomości społecznych lub poprzez użycie linku „Poproś o raport odczytu”.
inbox_message Wiadomość przychodząca. Dostępne tylko w przypadku korzystania z Wiadomości społecznych lub numeru wirtualnego.

Kody raportów dostarczenia

Kody szczegółów raportu dostarczenia Status Wyjaśnienie
0 SUBMITTED Ta wiadomość została dostarczona przez operatora, ale nie otrzymaliśmy raportu dostarczenia.
1 DELIVERED Ta wiadomość została pomyślnie dostarczona.
2 NOT DELIVERED Ta wiadomość nie została dostarczona. Możliwy powód: odbiorca znajduje się poza zasięgiem sieci, problemy z siecią, odbiorca za granicą.
3 BUFFERED Ta wiadomość została dostarczona przez operatora, ale nie do odbiorcy.
4 REJECTED Ta wiadomość została odrzucona przez operatora.
5 REJECTED Szczegóły poniżej!
9 UNKNOWN Brak dostępnych raportów dostarczenia dla tej wiadomości.

Kody szczegółów raportu dostarczenia

Status Wyjaśnienie
10 Numer odbiorcy jest nieprawidłowy lub nieznany
11 Odbiorca tymczasowo znajduje się poza zasięgiem operatora sieciowego
12 Problem związany z telefonem.
13 Problem z siecią operatora
14 Wiadomość wygasła - powód nieznany
15 Odbiorca figuruje na czarnej liście
16 Problem z treścią wiadomości
17 Odbiorca nie może zostać uregulowany
18 Operator odrzucił to z powodu spamu
19 Abonent nie może odbierać wiadomości premium (zablokowane przez operatora)

Kody szczegółów raportu dostarczenia dla kodu odpowiedzi 5

Status Wyjaśnienie
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

Przykład: raport dostarczenia

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

Przykład: wiadomość przychodząca

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

Przykład: raport potwierdzenia odczytu

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