Kompatible API
API ist das Protokoll für die Interaktion zwischen deiner Software und unserem Aktivierungsserver. API wird benötigt, um den SMS-Empfangsprozess auf deiner Seite zu automatisieren. Um mit API zu arbeiten, musst du deinen API-Schlüssel verwenden, den du nach einer einfachen Registrierung in deinem Profilbereich erhältst. Unsere API ist vollständig kompatibel mit den Websites von Mitbewerbern.
API-Protokoll Beschreibung
Alle Anfragen müssen an https://api.sms-man.com/stubs/handler_api.php POST- oder GET-Anfragen gehen. Alle Anfragen müssen den API-Schlüssel in Form des Parameters api_key enthalten. Alle Antworten im json-Format
Kontostand anfordern
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getBalance |
api_key | String | Ja | Dein API-Schlüssel |
Ergebnis
ACCESS_BALANCE:$balance(wobei$balanceder Saldo deines Kontos ist)
Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
Erhalten Sie aktuelle Preise
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getPrices |
api_key | String | Ja | Dein API-Schlüssel |
country | Number | Nein | |
service | String | Nein |
Ergebnis
{
"0": {"vk":{"cost":"15","count":6455},"wb":{"cost":"50","count":124}},
"1": {"fb":{"cost":"6","count":1000}}
}Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
Telefonnummer erhalten
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getNumber |
api_key | String | Ja | Dein API-Schlüssel |
country | Number | Ja | |
service | String | Ja | |
maxPrice | Number | Nein | Ihr gewünschter Wert |
currency | String | Nein | RUB/USD/EUR |
ref | String | Nein | Übergabe Empfehlungs-ID |
Ergebnis
ACCESS_NUMBER:$id:$number$id- Aktivierungs-ID$number- Telefonnummer
Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
NO_NUMBERS | Keine Telefonnummern, versuche es später noch einmal |
NO_BALANCE | Niedriges Guthaben |
Aktivierungsstatus abrufen
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getStatus |
api_key | String | Ja | Dein API-Schlüssel |
id | Number | Ja | Aktivierungs-ID |
Ergebnis
STATUS_WAIT_CODE- ausstehende smsSTATUS_WAIT_RETRY:$lastcode- Warten auf Code-Präzisierung (wobei$lastcode- letzter, fehlgeschlagener Code)STATUS_WAIT_RESEND— Warten auf den erneuten Versand einer SMS (die Software sollte den erneuten Versand der SMS einleiten und eine Änderung des Status auf 6 vornehmen)STATUS_CANCEL— die Aktivierung wird abgebrochenSTATUS_OK:$code— Code erhalten (wobei$codeder Aktivierungscode ist)
Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
NO_ACTIVATION | Es gibt keine Aktivierung |
Aktivierungsstatus abrufen V2
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getStatusV2 |
api_key | String | Ja | Dein API-Schlüssel |
id | Number | Ja | Aktivierungs-ID |
Ergebnis
{
"verificationType": 0,
"sms": {"dateTime":"0000-00-00 00:00:00","code":"code","text":"sms text"}
}
STATUS_CANCEL
STATUS_WAIT_CODEMögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
NO_ACTIVATION | Es gibt keine Aktivierung |
Aktivierungsstatus ändern
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | setStatus |
api_key | String | Ja | Dein API-Schlüssel |
id | Number | Ja | Aktivierungs-ID |
status | Number | Ja | Aktivierungsstatus |
Mögliche Status
-1— Aktivierung abbrechen1— Benachrichtigen, dass die SMS gesendet wurde (optional)3— Anderen Code anfordern6— die Aktivierung abschließen (wenn der Status "Code erhalten" war - markiert das den Erfolg und schließt die Aktivierung ab, wenn der Status "Vorbereitung" war - löscht und markiert das den Fehler, wenn der Status "Warten auf Wiederholung" war - verändert das die Aktivierung in "Warten auf SMS")8— teilt mit, dass die Telefonnummer benutzt wird und hebt die Aktivierung auf
Ergebnis
ACCESS_READY- Bereitschaft der Telefonnummer ist bestätigtACCESS_RETRY_GET- Warte auf eine neue SMSACCESS_ACTIVATION- der Service wurde erfolgreich aktiviertACCESS_CANCEL- Aktivierung wird abgebrochenEARLY_CANCEL_DENIED- Es ist nicht erlaubt, eine Nummer innerhalb der ersten 2 Minuten zu stornieren.
Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
NO_ACTIVATION | Die Aktivierungs-ID existiert nicht |
BAD_STATUS | Fehlerhafter Status |
Liste aller Länder anzeigen
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getCountries |
api_key | String | Ja | Dein API-Schlüssel |
Ergebnis
[
{"id":0,"name":"Россия","name_en":"Russia"},
{"id":3,"name":"Китай","name_en":"China"}
]Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
Liste aller Services abrufen
Parameter
Parameter | Typ | Erforderlich | Wert |
|---|---|---|---|
action | String | Ja | getServices |
api_key | String | Ja | Dein API-Schlüssel |
Ergebnis
[
{"id":"vk","name":"Вконтакте"},
{"id":"wb","name":"WeChat"},
{"id":"tg","name":"Telegram"}
]Mögliche Fehler
Fehler | Beschreibung |
|---|---|
BAD_KEY | Fehlerhafter API-Schlüssel |
BAD_ACTION | Fehlerhafte Aktion |
