Obter PBX PBX Instância

Obter PBX PBX Instância #

Este ponto de extremidade é usado para verificar se o alvo PBX já está associado a um locatário do cliente em algum lugar do sistema.

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

Dependendo do tipo Pbx, os seguintes valores precisam ser passados como {PBX_Instance_ID}:

  • ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ ID da conta
  • Teams => Microsoft ID do inquilino
  • 3CX => 3CX Chave de licença

Exemplo #

Essa solicitação obterá o PbxConnectionProfiles específico dentro do locatário do Cliente.

Solicitar # 

GET <https://api.na.myreports.cloud/api/v1.0/pbxs?instanceId={PBX_INSTANCE_ID}> HTTP/1.1
Autorização: Portador {TOKEN}

Resposta (Existe) # 

HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{
	"dados": {
        "existe": verdadeiro,
        "instanceId": "{PBX_INSTANCE_ID}",
        "id": "{PBX_ID}",
        "tenantId": "{CUSTOMER_TENANT_ID}"
    },
    "status": "sucesso",
    "carimbo de data/hora": "2025-02-20T14:57:51.2818600Z"
}

Resposta (não existe) # 

HTTP/1.1 200 OK
Tipo de conteúdo: application/json; charset=utf-8
Conteúdo-Comprimento: xx
{
	"dados": {
        "existe": falso,
        "instanceId": "{PBX_INSTANCE_ID}"
    },
    "status": "sucesso",
    "carimbo de data/hora": "2025-02-20T14:57:51.2818600Z"
}

Erros #

Não autorizado #

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

HTTP/1.1 401 Não autorizado

Mau pedido #

Quando o ID do locatário fornecido não estiver no formato correto 

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

Não encontrado #

Quando não há Clientes que tenham um ID de locatário correspondente ou Usuários com o ID do usuário 

HTTP/1.1 404 Não encontrado
Data: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 95
{
	"erro":404,
	"message":"Não encontrado",
	"status":"erro",
	"carimbo de data/hora":"2020-02-06T12:46:58.7669535Z"
}