Parche PBX

Parche PBX #

Actualiza un conjunto específico de propiedades de PbxConnectionProfile. Para ello, se utiliza el atributo JSON Formato de parche para cualquier cambio.

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

Ejemplo 1 #

Esta solicitud actualizará el nombre de PbxConnectionProfile.

Pedir # 

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}> HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: portador {TOKEN}
Conexión: keep-alive
[ {
		"op": "reemplazar",
		"ruta": "/nombre",
		"value": "Mi nuevo nombre"
	}
][{
		"op": "replace",
		"path": "/name",
		"value": "My New Name"
	}
]

Respuesta # 

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
request-context: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "éxito",
	"marca de tiempo": "2019-11-29T15:16:54.2586208Z"
}

Ejemplo 2 #

Esta solicitud habilitará el Pbx. Esto hará que se establezca una conexión con el Pbx y comience a recopilar datos de eventos.

Pedir # 

PATCH /api/v1.0/customers/{TENANT_ID}/pbxs/{PBX_ID} HTTP/1.1
Tipo de contenido: application/json
accept-charges: true
Autorización: portador {TOKEN}
Conexión: keep-alive
[ {
		"op": "reemplazar",
		"path": "/habilitado",
		"value": "verdadero"
	}
][{
		"op": "replace",
		"path": "/enabled",
		"value": "true"
	}
]

Respuesta # 

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
request-context: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "éxito",
	"marca de tiempo": "2019-11-29T15:16:54.2586208Z"
}

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado 

HTTP/1.1 401 No autorizado

Solicitud incorrecta (1) #

Cuando el identificador de inquilino proporcionado no está en el formato correcto 

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error":400,
	"message":"El valor '<tenant id>' no es válido.",
	"status":"error",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Mala solicitud (2) #

Al intentar aplicar parches a una propiedad no válida. 

HTTP/1.1 400 Solicitud incorrecta
Fecha: Thu, 06 Feb 2020 12:45:27 GMT
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: 149
{
	"error": 400,
	"message": "La ubicación de destino especificada por el segmento de ruta '<invalid property>' no se encontró.",
	"status": "error",
	"timestamp": "2020-02-06T12:45:27.5903465Z"
}

No encontrado #

Cuando no hay clientes que tengan un identificador de inquilino o Pbx coincidente con el identificador 

HTTP/1.1 404 No encontrado
Fecha: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de contenido: application/json; charset=utf-8
Contenido-Longitud: 95
{
	"error":404,
	"message":"No encontrado",
	"status":"error",
	"timestamp":"2020-02-06T12:46:58.7669535Z"
}