Kunden erstellen

Kunden erstellen #

Erstellt einen neuen Kunden-Tenant

POST /v1.0/customers

Beispiel #

Diese Anfrage erstellt einen neuen Kunden mit folgenden Details:

  • Name: "Neuer Kunde"
  • Beschreibung: "Das ist mein neuer Kunde"
  • Quelle: "ABC00001"
  • Aktiviert: falsch
  • Zeitzone: "Amerika/Los_Angeles",
  • Ländercode: "US"
  • PbxConnectionProfile
    • Crossbar Rest API: "https://hostrest"
    • Blackhole Websocket API: "wss//:hostwebsocket"
    • ~.pbx.kazoo.name.~ AccountId: "accountid"
    • ~.pbx.kazoo.name.~ Api Key: "apikey"
    • monitorSubAccounts: Falsch
  • sendenNeuerNutzerE-Mail: Falsch
  • sendenVerbindenWillkommenE-Mail: Falsch
  • tenantProfileType: "{TENANT_PROFILE_ID}"
  • Testdauer: "0"
Color Wand tip
Wird der TenantProfileType nicht angegeben, wird das Standard-Mieterprofil des Resellers verwendet.

Anfrage # 

POST <https://api.uk.myreports.cloud/api/v1.0/customers> HTTP/1.1
Inhaltstyp: application/json
Akzeptanz-Gebühren: Wahr
Autorisierung: Inhaber {TOKEN}
Verbindung: am Leben bleiben
{
	"name": "Neuer Kunde",
	"Beschreibung": "Das ist mein neuer Kunde",
	"Referenz": "ABC00001",
	"aktiviert": falsch,
	"Zeitzone": "Amerika/Los_Angeles",
	"countryCode": "US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsocket",
		"accountId": "accountid",
		"apiKey": "apikey",
		"monitorSubAccounts": falsch
	},
	"sendNewUserEmail": falsch,
	"sendConnectWelcomeEmail": falsch,
	"Trialduration" : "0"
}

Reaktion # 

HTTP/1.1 201 erstellt
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
Ort: <https://api.uk.myreports.cloud/api/v1.0/customers/{NEW_CUSTOMER_TENANT_ID}>
{
	"data": {
		"id": "{NEW_CUSTOMER_TENANT_ID}",
		"name": "Neuer Kunde",
		"Beschreibung": "Das ist mein neuer Kunde",
		"aktiviert": falsch,
		"parentTenantId": "{PARENT_ACCOUNT_TENANT_ID}"
	},
	"Status": "Erfolg",
	"Zeitstempel": "2019-01-01T10:00:00.6829447Z"
}

Fehler #

Unautorisiert #

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

HTTP/1.1 401 Unautorisiert

Schlechte Anfrage (1) #

Wenn du eine Testphase anforderst, hat dein Reseller-Konto keine Berechtigung. 

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": "Testkunden sind für Ihr Konto nicht aktiviert."
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}

Schlechte Anfrage (2) #

Wenn Sie eine Testphase über die festgelegte maximale Testdauer hinaus beantragen. 

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": "Die Testphase des Kunden überschreitet die maximal zulässige Dauer Ihres Kontos."
	"status": "fehler",
	"Zeitstempel": "2020-02-06T12:45:27.5903465Z"
}