Taxas

Taxas #

Quando um pedido é feito através do API que pode incorrer em quaisquer encargos adicionais, este irá retornar com um HTTP resposta de estado de:

402 Payment Required

O pedido não terá sido atendido. Para fazer isso, uma solicitação idêntica deve ser feita com um valor de cabeçalho adicional de:

accept-charges: true

Exemplo #

Este pedido tentará criar um novo Cliente com os seguintes detalhes sem aceitar encargos:

  • Nome: "Novo cliente"
  • Descrição: "Este é o meu novo cliente"
  • Ativado: false
  • Fuso Horário: "America/Los_Angeles",
  • Cultura: "en-US"
  • PbxConnectionProfile
    • Crossbar Api Rest: "https://hostrest"
    • Blackhole Api Websocket: "wss//:hostwebsocket"
    • ~.pbx.kazoo.name.~ AccountId: "accountid"
    • ~.pbx.kazoo.name.~ Api Key: "apikey"

Solicitar #

POST /api/v1.0/clientes HTTP/1.1
Tipo de conteúdo: application/json
Autorização: Portador {TOKEN}
Conexão: keep-alive
{
	"nome": "Novo cliente",
	"descrição": "Este é o meu novo cliente",
	"habilitado": false,
	"fuso horário": "America/Los_Angeles",
	"cultura": "en-US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsokcet",
		"accountId": "accountid",
		"apiKey": "apikey"
	}
}

Resposta #

HTTP/1.1 402 Pagamento Necessário
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{
	"nome": "Novo cliente",
	"descrição": "Este é o meu novo cliente",
	"habilitado": false,
	"fuso horário": "America/Los_Angeles",
	"cultura": "en-US",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsokcet",
		"accountId": "accountid",
		"apiKey": "apikey"
	}
}