1. Home
  2. Docs
  3. Gateway
  4. HTTP Api
  5. Absenderkennungen

Absenderkennungen

Die API zur Validierung von Absenderkennungen ermöglicht es Ihnen, automatisch Caller IDs für die Voice API zu validieren. Nach Aufruf dieser API erhalten Sie bei Erfolg einen Code zurück. Gleichzeitig wird die angegebene Rufnummer einen Anruf von uns erhalten. Hier muss dann der zurückgegebene Code über die Tastatur des Telefons per DTMF eingegeben werden.

Setzen Sie Ihren Request an folgende URL ab:

https://gateway.sms77.io/api/validate_for_voice

Zusätzlich zu den Daten zur Authentifizierung werden folgende Parameter benötigt:

Benötigte Parameter

ParameterBeschreibungMögliche Werte
numberDie zu validierende Rufnummer. Das Format ist nahezu beliebig – unser Gateway formatiert die Nummer automatisch korrekt.491632429751
00491632429751
0163-2429751

Optionale Parameter

ParameterBeschreibungMögliche Werte
callbackCallback URL, die aufgerufen werden soll, sobald die Validierung erfolgreich durchgeführt wurde.https://ihre-domain.de/validate.php?...

Rückgabe

Im Erfolgsfall und sofern die Rufnummer noch nicht für Ihren Account validiert wurde, erhalten Sie ein JSON-Object mit dem Code zurück.

{
"success": true,
"code": "699350",
"error": null
}

Sofern ein Fehler aufgetreten ist, erhalten Sie ein JSON-Objekt wie das folgende:

Beispiel Rufnummer ungültig

{
    "id": null,
    "sender": "4917600000....",
    "formatted_output": null,
    "success": false,
    "error": "Empf\u00e4ngernummer ung\u00fcltig",
    "voice": false
}

Beispiel Rufnummer bereits validiert

{
    "id": 12345,
    "sender": "4917600000....",
    "formatted_output": "+49 176 00000...",
    "success": true,
    "error": "Die Absenderkennung ist bereits gespeichert.",
    "voice": true
}

Callback

Die per Parameter callback angegebene URL wird aufgerufen, sobald die Validierung erfolgreich abgeschlossen wurde. Hierbei werden Ihrer URL zusätzlich folgende Parameter per HTTP GET angefügt:

ParameterBeschreibungBeispiel
idInterne ID der Caller ID.12345
senderRufnummer international491632429751
formatted_outputRufnummer formatiert+49 163 2429751
successAbfrage erfolgreich1 – bei erfolgreichem Request oder falls bereits validiert

0 – bei Fehler

errorFehlermeldungLeer bei Erfolg, ansonsten die Fehlermeldung
voiceRufnummer international formatiert1 – Kann als Caller ID gesetzt werden

0 – Kann nicht als Caller ID gesetzt werden

 

Was this article helpful to you? Yes No
Menü