Obter PBX PBX Exemplo

Obter PBX PBX Exemplo #

Esse ponto de extremidade é usado para verificar se o destino 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 de Pabx, os seguintes valores precisam ser passados como o {PBX_Instance_ID}:

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

Exemplo #

Essa solicitação obterá o PbxConnectionProfiles específico no locatário do cliente.

Pedir # 

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: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 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: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
{
	"dados": {
        "existe": falso,
        "instanceId": "{PBX_INSTANCE_ID}"
    },
    "status": "sucesso",
    "carimbo de data/hora": "2025-02-20T14:57:51.2818600Z"
}

Erros #

Desautorizado #

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

HTTP/1.1 401 Não autorizado

Solicitação incorreta #

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

Não encontrado #

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

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