Aktualisieren Sie Benutzergerät #

Dieser Endpunkt erlaubt es, bestehenden Geräten als Softphone-Geräte für einen Benutzer für ~.UcClient.~ Desktop, Mobile & WebRTC.

Ein Gerät zuweisen

PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign

Entweisen eines Geräts

PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign

Die Body der Anfrage muss eine einzelne Eigenschaft JSON enthalten, um anzuzeigen, welchem Clienttyp das Gerät zugewiesen wird:

{
	"clientType": "desktop"
}

Gültige ClientType-Werte:

Schreibtisch
Mobil
WebRTC
CRM

Das angegebene {DEVICE_ID} sollte die ID des Geräts auf der Kommunikationsplattform sein, z. B. ~.pbx.kazoo.name.~.

note
Das als Softphone zugewiesene Gerät muss bereits dem Benutzer auf der Kommunikationsplattform zugewiesen sein.

tip
Wenn die bereitgestellte Geräte-ID bereits einem anderen Client-Typ zugewiesen ist, würde eine erneute Zuweisung dazu führen, dass sie von einem Client zum anderen verschoben wird.

Bemerkungen #

Wenn Sie einem Benutzer ein Softphone-Gerät zuweisen, stellen Sie sicher, dass der Benutzer zunächst die richtigen Rollen zugewiesen wurde. Beide folgenden Riles sind Voraussetzungen, um ein Softphone-Gerät zuweisen zu können:

customer_user_uc
customer_user_uc_softphone

Beispiel-Zuweisung #

Anfrage #

POST <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign> HTTP/1.1
Inhaltstyp: application/json
Akzeptanz-Gebühren: Wahr
Autorisierung: Inhaber {TOKEN}
Verbindung: am Leben bleiben
{
	"clientType": "desktop"
}

Reaktion #

HTTP/1.1 201 erstellt
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
Standort: <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign>
{
	"Status": "Erfolg",
	"Zeitstempel": "2019-11-29T16:03:23.9251680Z"
}

Beispiel: Zuweisung entziehen #

Anfrage #

POST <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign> HTTP/1.1
Inhaltstyp: application/json
Akzeptanz-Gebühren: Wahr
Autorisierung: Inhaber {TOKEN}
Verbindung: am Leben bleiben

Reaktion #

HTTP/1.1 201 erstellt
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
Standort: <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign>
{
	"Status": "Erfolg",
	"Zeitstempel": "2019-11-29T16:03:23.9251680Z"
}

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
{
	"Fehler": 400,
	"Nachricht": "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

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,
	"Nachricht": "Nicht gefunden",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:46:58.7669535Z"
}

Wenn das referenzierte Gerät nicht bereits dem Benutzer auf der Kommunikationsplattform zugewiesen ist.

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,
	"nachricht": "Gerät nicht gefunden",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:46:58.7669535Z"
}

Zahlung erforderlich #

Wenn dieser Antrag zusätzliche Kosten verursachen könnte, siehe Charges.

HTTP/1.1 402 Zahlung erforderlich
Datum: Do, 06. Feb 2020 13:01:00 GMT
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: 274
{
	"data": {
	"clientType": "desktop"
	},
	"Fehler": 402,
	"Nachricht": "Zusätzliche Kosten fallen an",
	"status": "fehler",
	"Zeitstempel": "2020-02-06T13:01:01.1302340Z"
}