Erhalten Sie PBX PBX Instanz

Erhalten Sie PBX PBX Instanz #

Dieser Endpunkt wird verwendet, um zu überprüfen, ob das Ziel-PBX bereits irgendwo im System mit einem Kundentenant verknüpft ist.

GET /v1.0/pbxs?instanceId={PBX_INSTANCE_ID}

Je nach Pbx-Typ müssen folgende Werte als {PBX_Instance_ID} übermittelt werden:

  • ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ Konto-ID
  • Teams => Microsoft Tenant-ID
  • 3CX => 3CX Lizenzschlüssel

Beispiel #

Diese Anfrage erhält die spezifischen PbxConnectionProfiles innerhalb des Kunden-Mandanten.

Anfrage # 

GET <https://api.uk.myreports.cloud/api/v1.0/pbxs?instanceId={PBX_INSTANCE_ID}> HTTP/1.1
Autorisierung: Inhaber {TOKEN}

Antwort (Existiert) # 

HTTP/1.1 200 OK
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
{
	"data": {
        "existiert": wahr,
        "instanceId": "{PBX_INSTANCE_ID}",
        "id": "{PBX_ID}",
        "tenantId": "{CUSTOMER_TENANT_ID}"
    },
    "Status": "Erfolg",
    "Zeitstempel": "2025-02-20T14:57:51.2818600Z"
}

Antwort (Existiert nicht) # 

HTTP/1.1 200 OK
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
{
	"data": {
        "existiert": falsch,
        "instanceId": "{PBX_INSTANCE_ID}"
    },
    "Status": "Erfolg",
    "Zeitstempel": "2025-02-20T14:57:51.2818600Z"
}

Fehler #

Unautorisiert #

Wenn der Token nicht bereitgestellt wird, ungültig oder abgelaufen ist 

HTTP/1.1 401 Unautorisiert

Schlechte Anfrage #

Wenn die angegebene Mieter-ID nicht im richtigen Format ist 

HTTP/1.1 400 Bad Request
Datum: Do, 06. Feb 2020 12:45:27 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 149
{
	"error":400,
	"message": "Der Wert '<tenant id>'ist nicht gültig.",
	"status":"fehler",
	"Zeitstempel":"2020-02-06T12:45:27.5903465Z"
}

Nicht gefunden #

Wenn es keine Kunden gibt, die eine passende Mieter-ID haben, oder Benutzer mit der Benutzer-ID 

HTTP/1.1 404 Nicht gefunden
Datum: Do, 06. Feb 2020 12:46:58 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 95
{
	"error":404,
	"message": "Nicht gefunden",
	"status":"fehler",
	"Zeitstempel":"2020-02-06T12:46:58.7669535Z"
}