Obtener PBX PBX Instancia

Obtener PBX PBX Instancia #

Este punto de conexión se utiliza para comprobar si el destino PBX ya está asociado a un inquilino del cliente en algún lugar del sistema.

GET /v1.0/pbxs?instanceId={PBX_INSTANCE_ID}

Dependiendo del tipo de Pbx, se deben pasar los siguientes valores como {PBX_Instance_ID}:

  • ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ ID de cuenta
  • Teams => Microsoft Id. de inquilino
  • 3CX => 3CX Clave de licencia

Ejemplo #

Esta solicitud obtendrá el PbxConnectionProfiles específico dentro del inquilino del cliente.

Pedir # 

GET <https://api.na.myreports.cloud/api/v1.0/pbxs?instanceId={PBX_INSTANCE_ID}> HTTP/1.1
Autorización: portador {TOKEN}

Respuesta (existe) # 

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
	"datos": {
        "existe": verdadero,
        "instanceId": "{PBX_INSTANCE_ID}",
        "id": "{PBX_ID}",
        "tenantId": "{CUSTOMER_TENANT_ID}"
    },
    "status": "éxito",
    "timestamp": "2025-02-20T14:57:51.2818600Z"
}

Respuesta (no existe) # 

HTTP/1.1 200 OK
Tipo de contenido: application/json; charset=utf-8
Longitud del contenido: xx
{
	"datos": {
        "existe": falso,
        "instanceId": "{PBX_INSTANCE_ID}"
    },
    "status": "éxito",
    "timestamp": "2025-02-20T14:57:51.2818600Z"
}

Errores #

Desautorizado #

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

HTTP/1.1 401 No autorizado

Mala solicitud #

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"
}

No encontrado #

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

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"
}