API do PBX alojado: contas de cliente (tenants)

Utilize HTTPS e autenticação HTTP Basic com credenciais de API aprovadas. Mantenha as credenciais no servidor da sua aplicação. Estes endpoints do Hosted PBX utilizam /hpbx/ em api.multitel.net; não insira /v3. Verifique tanto o resultado HTTP como o estado da aplicação na resposta JSON.

Listar as instâncias PBX da conta

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/tenants/list/0"

A operação de listagem devolve os tenants da conta autenticada. O último segmento de marcador de posição satisfaz a assinatura da rota; a operação de listagem não o utiliza para selecionar outra conta.

Resposta de lista ilustrativa

{
  "status": {
    "code": "200",
    "msg": "List data"
  },
  "response": [
    {
      "billing_code": "EXAMPLE_BILLING_CODE",
      "isocode": "US",
      "continent_iso": "NA",
      "continent_name": "North America"
    }
  ]
}

Criar e alterar uma instância de PBX (tenant)

A criação de uma instância de cliente de PBX (tenant) é uma ação de subscrição e pode gerar custos de ativação e recorrentes. Leia primeiro os planos de serviço disponíveis. Utilize a referência atual autorizada para a sua conta para selecionar um plano, uma localização e um perfil de encaminhamento; não reutilize um ID de exemplo como seleção de conta.

Campo de criaçãoSignificado
hosted_pbx_services_idO ID de serviço retornado para um plano disponível.
te_rp_idO perfil de roteamento de chamadas aprovado.
timezoneUm fuso horário IANA, como America/Detroit.
te_location_idUm ID de localização disponível para a conta, quando necessário.
te_maxextensions / te_maxhunts / te_maxconferences / te_maxvoicemails / te_maxivrsAs capacidades de recursos estão limitadas pelo serviço selecionado; não permitem alterar arbitrariamente os limites contratados.

Verifique o código de faturação resultante e o estado de provisionamento antes de configurar as extensões. Para novas integrações e esquemas exatos de mutação, utilize a referência atual de subscrições.

Pesquisar documentação