API integracja SMS
Bramka SMS pozwala zautomatyzować dystrybucję wiadomości SMS i osadzić usługę w dowolnym projekcie
Możesz połączyć się z naszą bramką SMS za darmo, aktywacja usługi nie jest wymagana. Wszystkie dane przekazywane do interfejsu API muszą być zakodowane w UTF-8.
JSON API
*zalecana metoda
Komunikacja z Usługą odbywa się przy użyciu wysyłania żądań HTTP za pomocą metody POST do określonego adresu przy użyciu formatu tekstu wymiany danych "JSON".
Do uwierzytelnienia żądania używany jest „OAuth 2”. Przy tego typu uwierzytelnianiu musisz użyć tokena, który możesz uzyskać na swoim koncie w sekcji "Profil". Następnie odpowiednio umieść ten token w nagłówku żądania, np. jako: 'Authorization: Bearer your_token'.
Uwaga: ograniczenie częstotliwości żądań do usługi nie powinno przekraczać 9 żądań na sekundę od jednego klienta.
Wysyłanie wiadomości API
Adres usługi: https://im.smsclub.mobi/sms/send
Komunikaty wysyłane są poprzez ustawienie następujących parametrów:
src_addr
do wysłania
phone
(do 100 na żądanie)
message
integration_id
Po pomyślnym wysłaniu systemu partnera partner zwróci tablicę "Info", w którym kluczowym jest komunikat ID w naszym systemie, w którym możesz uzyskać status, a numer telefonu zostanie wysłany, do którego był wiadomość wysłano. W poniższym przykładzie "106" - ID SMS, 380989361131 - numer odbiorcy.
Przykład wysyłania wiadomości do formatu "JSON":
{
"phone" : ["380989361131"],
"message" : "test text",
"src_addr" : "VashZakaz"
}
Przykład odpowiedzi na format "JSON":
{
"success_request": {
"info": {
"106": "380989361131"
}
}
}
Uzyskanie statusu wiadomości
Adres usługi: https://im.smsclub.mobi/sms/status
Aby uzyskać statusy wiadomości, musisz przekazać jeden parametr: id_sms – tablica identyfikatorów wiadomości, dla których musisz uzyskać status, limit nie przekracza 100. Po pomyślnym żądaniu, system zwróci tablicę „info”, w której kluczem będzie id wiadomości, ale znaczenie jego statusu.
Zapytanie o status:
{
"id_sms" : ["106"],
}
Przykładowa odpowiedź w:
{
"success_request": {
"info": {
"106": "ENROUTE"
}
}
}
Stany
200 – Wniosek został pomyślnie przetworzony. Możliwe statusy wiadomości:
ENROUTE
DELIVRD
EXPIRED
UNDELIV
REJECTD
Błędy
400
401
429
453
500x
Uzyskiwanie listy nazw użytkowników alfa
Adres usługi: https://im.smsclub.mobi/sms/originator
Aby uzyskać listę dostępnych nazw Alpha, chcesz poprosić o określony adres URL bez korpusu zapytania za pomocą tylko autoryzowanych informacji o użytkowniku.
Po pomyślnym zapytaniu system zwróci listę aktywnych nazw alfa:
Przykład odpowiedzi
{
"success_request": {
"info": [
"test1",
"test2"
]
}
}
Uzyskanie równowagi użytkownika
Adres usługi: https://im.smsclub.mobi/sms/balance
Aby uzyskać saldo, musisz wysłać żądanie do powyższego adresu URL bez treści żądania, używając tylko informacji o autoryzowanym użytkowniku
Po udanej prośbie, system zwróci bilansowy bilans użytkownika, tablicę "Info", gdzie:
money - balansować
currency - Waluta konta
Przykład odpowiedzi
{
"success_request": {
"info": [
"money": "8111.1700",
"currency": "UAH"
]
}
}
Gateway SMPP.
ESME
SMSC
MSC
SMS, EMS, WAP, USSD, ets
Bramka ta spełnia wszystkie parametry protokołu SMPP v3.4. Aby przetestować naszą bramę, potrzebujesz skontaktuj się z kierownikiem.
Brama HTTP.
Bramka ta umożliwia wysyłanie żądań HTTP na podany adres usługi za pośrednictwem protokołu HTTP przy użyciu metod GET/POST. Aby przetestować naszą bramkę, musisz skontaktować się z managerem.
XML Gateway.
Ta brama umożliwia wysyłanie żądań XML do kodowania UTF-8 do określonego adresu serwisowego za pomocą protokołu HTTP za pomocą metody POST. Aby przetestować naszą bramę, musisz skontaktować się z menedżerem.
Pobierz przykłady.
Tutaj możesz pobrać przykłady skryptów, do pracy z wybraną bramą
| metoda | JSON | 1С |
|---|---|---|
| Pojedynczy |
|
|
| Cielsko |
|
|
| Balansować |
|
|
| Stany |
|
|
| Nazwy alfa |
|
