Dokumentation

Cloud-PBX API

Mit dem Cloud-PBX API können Sie Cloud-PBX Benutzer neu anlegen, aktualisieren oder die Konfiguration abfragen.

Konfiguration von Cloud-PBX Benutzern abfragen:

Mit dieser Methode können Sie die Konfiguration von Cloud-PBX Benutzern abfragen.

POST	https://api.tenios.com/cloud-pbx/list

Anfrageparameter:

access_key	Der Zugriffsschlüssel (Access Key) für das API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/ Allgemeine Einstellungen im Abschnitt API gefunden werden.
page	Die Seite der Konfiguration, die abgerufen werden soll.
page_size	Die Seitengröße bzw. die maximale Anzahl an Cloud-PBX Benutzern, die zurückgeliefert werden sollen.

Antwortparameter:

success	true bei Erfolg, ansonsten eine Fehlermeldung.
items[ ]	Ein array mit Cloud-PBX User Objekten. Bitte beachten Sie, dass das hinterlegte „Passwort“ nicht enthalten ist.
total_items	Anzahl aller verfügbaren Items.
page_size	Anzahl der Items pro Seite.
page	Seitenzahl (startet mit 1)

Items:

user_name	Der Benutzername des Cloud-PBX Benutzers.
password	Das Passwort des Cloud-PBX Benutzers.
first_name	Der Vorname des Cloud-PBX Benutzers.
last_name	Der Nachname des Cloud-PBX Benutzers.
internal_extension	Die interne Nebenstelle des Cloud-PBX Benutzers.
outbound_allowed	Ein Flag, das angibt, ob der Cloud-PBX Benutzer ausgehende Anrufe tätigen darf.
sip_login_enabled	Ein Flag, das angibt, ob der Cloud-PBX Benutzer sich am PBX-Portal (https://pbx.tenios.com) anmelden darf.
call_history_enabled	Ein Flag, das angibt, ob die Anrufhistorie im PBX-Portal (https://pbx.tenios.com) angezeigt werden soll.
email	Die E-Mail Adresse des Cloud-PBX Benutzers.

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "page": 1,
   "page_size": 2
}

API Response:

HTTP Status Code: 200 (OK)

{
   "success": true,
   "items": [
      {
         "user_name": "+49221234567",
         "first_name": "Toni",
         "last_name": "Tester",
         "internal_extension": "",
         "outbound_allowed": false,
         "sip_login_enabled": true,
         "call_history_enabled": true,
         "email": "tt@test.com"
      },
      {
         "user_name": "+49221235655",
         "first_name": "Alice",
         "last_name": "Example",
         "internal_extension": "",
         "outbound_allowed": true,
         "sip_login_enabled": false,
         "call_history_enabled": false,
         "email": "ae@test.com"
      }
   ],
   "total_items": 10,
   "page_size": 2,
   "page": 1
}

Beispiele für fehlerhafte Anfragen:

BAD_CREDENTIALS

Dieser Code wird zurückgegeben, wenn ein ungültiger Zugriffsschlüssel (access_key) angegeben wurde.

Request:

{
   "access_key": "12345676",
   "page": 1,
   "page_size": 10
}

API Response:

HTTP Status Code: 403 (Forbidden)

{
   "error_code": "BAD_CREDENTIALS",
   "error_message": "Bad credentials",
   "fields": []
}

FIELD_NEGATIVE_OR_ZERO

Dieser Fehler wird zurückgegeben, wenn das Feld page_size einen neutralen oder negativen Wert hat.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "page": 1,
   "page_size": -1
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "FIELD_NEGATIVE_OR_ZERO",
   "error_message": "Parameter 'page_size' value can not be negative or equal to zero",
   "fields": [
      "page_size"
   ]
}

{ "error_code": "FIELD_NEGATIVE_OR_ZERO", "error_message": "Parameter 'page_size' value can not be negative or equal to zero", "fields": [ "page_size" ] }

Konfiguration von Cloud-PBX Benutzern anlegen oder ändern:

Mit dieser Methode können Sie die Konfiguration von Cloud-PBX Benutzern ändern oder anlegen.

Der Parameter user_name muss eine gültige Cloud-PBX-Telefonnummer sein.

POST	https://api.tenios.com/cloud-pbx/upsert/{user_name}

Anfrageparameter:

access_key	Der Zugriffsschlüssel (Access Key) für das API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT->Allgemeine Einstellungen im Abschnitt API gefunden werden.
user_name	Dieser Parameter entspricht immer die Telefonnummer des Benutzers. Beachten Sie, dass dieser Parameter als Teil der URL gesendet wird.
first_name	Der Vorname des Cloud-PBX Benutzers.
last_name	Der Nachname des Cloud-PBX Benutzers.
internal_extension Optional	Die interne Nebenstelle des Cloud-PBX Benutzers.
outbound_allowed	Ein Flag, das angibt, ob der Cloud-PBX Benutzer ausgehende Anrufe tätigen darf.
sip_login_enabled	Ein Flag, das angibt, ob der Cloud-PBX Benutzer sich am PBX-Portal (https://pbx.tenios.com) anmelden darf.
email Optional	Die E-Mail Adresse des Cloud-PBX Benutzers.
call_history_enabled	Ein Flag, das angibt, ob die Anrufhistorie im PBX-Portal (https://pbx.tenios.com) angezeigt werden soll.

Antwortparameter:

success	true bei Erfolg, ansonsten eine Fehlermeldung.

Beispiel für eine erfolgreiche Anfrage:

Request:

Bsp.: https://api.tenios.com/cloud-pbx/upsert/+49221000002

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "password": "i7Lkm07",
   "outbound_allowed": "true",
   "sip_login_enabled": "true",
   "call_history_enabled": "true",
   "first_name": "Peter",
   "last_name": "Mustermann"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "success": true
}

Beispiele für fehlerhafte Anfragen:

FIELD_IS_REQUIRED

Dieser Fehler wird zurückgegeben, wenn in der Anfrage ein obligatorischer Parameter fehlt.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "outbound_allowed": "true",
   "sip_login_enabled": "true",
   "call_history_enabled": "true",
   "first_name": "Peter",
   "last_name": "Mustermann"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "FIELD_IS_REQUIRED",
   "error_message": "Parameter 'password' is required",
   "fields": [
      "password"
   ]
}

NOT_FOUND

Dieser Fehler wird zurückgegeben, wenn der angeforderte Parameter user_name nicht vorhanden ist.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "password": "i7Lkm07",
   "outbound_allowed": "true",
   "sip_login_enabled": "true",
   "call_history_enabled": "true",
   "first_name": "Peter",
   "last_name": "Mustermann"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "success": false,
   "error_code": "NOT_FOUND",
   "error_message": "Not found.",
   "fields": []
}

PASSWORD_IS_IN_BLACKLIST

Dieser Fehler wird zurückgegeben, wenn der Parameter password einen Wert hat, der in der Blacklist ist.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "password": "12345678",
   "outbound_allowed": "true",
   "sip_login_enabled": "true",
   "call_history_enabled": "true",
   "first_name": "Peter",
   "last_name": "Mustermann",
   "email": "pm@test.com"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "success": false,
   "error_code": "PASSWORD_IS_IN_BLACKLIST",
   "error_message": "The password is in the password blacklist, please choose another one.",
   "fields": [
      "password"
   ]
}

BAD_REQUEST_1

Dieser Fehler wird zurückgegeben, wenn der Parameter user_name ungültig ist. Bsp.: https://api.tenios.com/cloud-pbx/upsert/+1234564646

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "password": "i7Lkm07",
   "outbound_allowed": "true",
   "sip_login_enabled": "true",
   "call_history_enabled": "true",
   "first_name": "Peter",
   "last_name": "Mustermann"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "BAD_REQUEST",
   "error_message": "Invalid 'user_name' parameter",
   "fields": [
      "user_name"
   ]
}

BAD_REQUEST_2

Dieser Fehler wird zurückgegeben, wenn der Parameter email ungültig ist.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "password": "i7Lkm07",
   "outbound_allowed": "true",
   "sip_login_enabled": "true",
   "call_history_enabled": "true",
   "first_name": "Peter",
   "last_name": "Mustermann",
   "email": "invalid@emailadress"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "BAD_REQUEST",
   "error_message": "Invalid 'email' parameter",
   "fields": [
      "email"
   ]
}