Anklagen

Anklagen #

Wenn eine Anfrage über das API mit zusätzlichen Kosten verbunden werden kann, erhält dies eine HTTP Statusantwort von:

402 Payment Required

Der Antrag wird nicht bearbeitet worden sein. Um dies zu bewirken, sollte eine identische Anfrage mit einem zusätzlichen Headerwert gestellt werden:

accept-charges: true

Beispiel #

Diese Anfrage versucht, einen neuen Kunden mit folgenden Angaben zu erstellen, ohne Gebühren zu akzeptieren:

  • Name: "Neuer Kunde"
  • Beschreibung: "Das ist mein neuer Kunde"
  • Aktiviert: falsch
  • Zeitzone: "Amerika/Los_Angeles",
  • Kultur: "en-US"
  • PbxConnectionProfile
    • Crossbar Rest API: "https://hostrest"
    • Blackhole Websocket API: "wss//:hostwebsocket"
    • ~.pbx.kazoo.name.~ AccountId: "accountid"
    • ~.pbx.kazoo.name.~ Api Key: "apikey"

Anfrage #

POST /api/v1.0/customers HTTP/1.1
Inhaltstyp: application/json
Autorisierung: Inhaber {TOKEN}
Verbindung: am Leben bleiben
{
	"name": "Neuer Kunde",
	"Beschreibung": "Das ist mein neuer Kunde",
	"aktiviert": falsch,
	"Zeitzone": "Amerika/Los_Angeles",
	"Kultur": "en-US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsocket",
		"accountId": "accountid",
		"apiKey": "apikey"
	}
}

Reaktion #

HTTP/1.1 402 Zahlung erforderlich
Inhaltstyp: application/json; charset=utf-8
Inhalt-Länge: xx
{
	"name": "Neuer Kunde",
	"Beschreibung": "Das ist mein neuer Kunde",
	"aktiviert": falsch,
	"Zeitzone": "Amerika/Los_Angeles",
	"Kultur": "en-US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsocket",
		"accountId": "accountid",
		"apiKey": "apikey"
	}
}