Patch PBX

Patch PBX #

Atualiza um conjunto específico de propriedades de um PbxConnectionProfile. Isso usa o JSON Formato de patch para quaisquer alterações.

PATCH /v1.0/clientes/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}

Exemplo 1 #

Essa solicitação atualizará o Nome do PbxConnectionProfile.

Pedir # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}> HTTP/1.1
Tipo de conteúdo: application/json
aceitar-encargos: verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
[ {
		"op": "substituir",
		"caminho": "/nome",
		"value": "Meu novo nome"
	}
][{
		"op": "replace",
		"path": "/name",
		"value": "My New Name"
	}
]

Resposta # 

HTTP/1.1 200 OK
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
Contexto de solicitação: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T15: 16: 54.2586208Z"
}

Exemplo 2 #

Essa solicitação habilitará o Pbx. Isso fará com que uma conexão seja feita com o Pabx e comece a coletar dados de eventos.

Pedir # 

PATCH /api/v1.0/customers/{TENANT_ID}/pbxs/{PBX_ID} HTTP/1.1
Tipo de conteúdo: application/json
aceitar-encargos: verdadeiro
Autorização: Portador {TOKEN}
Conexão: keep-alive
[ {
		"op": "substituir",
		"caminho": "/habilitado",
		"valor": "verdadeiro"
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": "true"
	}
]

Resposta # 

HTTP/1.1 200 OK
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
Contexto de solicitação: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sucesso",
	"carimbo de data/hora": "2019-11-29T15: 16: 54.2586208Z"
}

Erros #

Desautorizado #

Quando o token não é fornecido, é inválido ou expirado 

HTTP/1.1 401 Não autorizado

Solicitação incorreta (1) #

Quando a ID do locatário fornecida não está no formato correto 

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro":400,
	"message":"O valor '<tenant id>' não é válido.",
	"status":"erro",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Solicitação incorreta (2) #

Ao tentar corrigir uma propriedade inválida. 

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "O local de destino especificado pelo segmento de caminho '<invalid property>' não foi encontrado.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Não encontrado #

Quando não há clientes que tenham uma ID de locatário correspondente ou Pbx com a ID 

HTTP/1.1 404 Não encontrado
Data: Qui, 06 de fevereiro de 2020 12:46:58 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 95
{
	"erro":404,
	"message":"Não encontrado",
	"status":"erro",
	"timestamp": "2020-02-06T12: 46: 58.7669535Z"
}