Dokumentation

Number cancellation API

Kunden können über die TENIOS-API auch eine Rufnummern kündigen.

Kündigung einer Rufnummer:

Der Anfrage sollte den entsprechenden Zugangsschlüssel und die zugehörige Telefonnummer für die Kündigung enthalten.

POSThttps://api.tenios.com/number/cancel

 

Anfrageparameter:

access_key StringDer Zugriffsschlüssel (Access Key) für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/ Allgemeine Einstellungen im Abschnitt API gefunden werden.
phone_type StringRufnummer, die gekündigt werden soll
Derzeit wird nur der Rufnummerntyp GEOGRAPHICAL unterstützt.

Beispiel für eine erfolgreiche Anfrage:

Request:

{     "access_key":"XXXXX-XXXX-XXXXXX",      "phone_number": "+49888888" }

API Response:

HTTP Status Code: 200 (OK)

{ "cancellation_date":"2019-01-01" }

Eine erfolgreiche Antwort enthält dieorder_id der erstellten Rufnummernanfrage.  

Beispiele für fehlerhafte Anfragen:

 

NUMBER_CANCEL_NO_SUBSCRIPTION_FOUND
Dieser Fehler wird ausgegeben, wenn für die angegebene Telefonnummer kein Abonnement gefunden wurde.

Request:

{ "access_key":"XXXXX-XXXX-XXXXXX", "phone_number": "+49888888" }

API Response:

HTTP Status Code: 400 (Bad Request)

{ "error_code": "NUMBER_CANCEL_NO_SUBSCRIPTION_FOUND", "error_message": "No active subscription found for provided phonenumber.", "fields": [] }
FIELD_IS_REQUIERED

Dieser Fehler wird ausgegeben, wenn keine Telefonnummer angegeben wurde.

Request:

{ "access_key":"XXXXX-XXXX-XXXXXX", "phone_number": "" }

API Response:

HTTP Status Code: 400 (Bad Request)

{ "error_code": "FIELD_IS_REQUIRED", "error_message": "Parameter 'phone_number' is required", "fields": ["phone_number"] }
NUMBER_CANCEL_PHONE_NUMBER_NOT_VALID
Dieser Fehler wird ausgegeben, wenn die eingegebene Telefonnummer ungültig ist.

Request:

{ "access_key":"XXXXX-XXXX-XXXXXX", "phone_number": "abcdefg" }

API Response:

HTTP Status Code: 400 (Bad Request)

{ "error_code": "NUMBER_CANCEL_PHONE_NUMBER_NOT_VALID", "error_message": "Provided phone number is not valid. It should contain only digits.", "fields": [] }

Dieser Fehler wird ausgegeben, wenn die eingegebene Telefonnummer ungültig ist.

NUMBER_CANCEL_ILLEGAL_NUMBER_TYPE

Dieser Fehler wird ausgegeben, wenn der Rufnummerntyp nicht akzeptiert wird.

Request:

{ "access_key":"XXXXX-XXXX-XXXXXX", "phone_number": "+80087897" }

API Response:

HTTP Status Code: 400 (Bad Request)

{ "error_code": "NUMBER_CANCEL_ILLEGAL_NUMBER_TYPE", "error_message": "Only 'GEOGRAPHICAL' number type is acceptable.", "fields": [] }
NUMBER_CANCEL_SUBSCRIPTION_ALREADY_CANCELLED

Request:

{ "access_key":"XXXXX-XXXX-XXXXXX", "phone_number": "+49888888" }

API Response:

HTTP Status Code: 400 (Bad Request)

{ "error_code": "NUMBER_CANCEL_SUBSCRIPTION_ALREADY_CANCELLED", "error_message": "You have already cancelled subscription for provided phone number.", "fields": [] }