Quem pode utilizar esta funcionalidade?
Disponível no plano Enterprise.
Proprietários e Administradores.
Visão geral
Este guia irá orientá-lo ao longo do processo de compra de números de fax através da API Fax.Plus. Vai aprender a verificar o seu saldo, encontrar números disponíveis e concluir o processo de compra.
Requisitos prévios
- Uma conta Fax.Plus Enterprise ativa
- Credenciais de acesso à API
- Saldo de conta suficiente para a compra
Guia passo a passo
-
Verifique o seu saldo de conta
Antes de iniciar o processo de compra, verifique se tem fundos suficientes na sua conta. A API Fax.Plus utiliza apenas o saldo da sua conta para compras.GET /v3/shop/balance
Exemplo de resposta:{Saiba mais: Obter o saldo da conta - API Fax.Plus
"amount": 100,
"currency": "USD"
}
Dica: Certifique-se de que o seu saldo cobre o custo do número que deseja comprar. Se precisar de adicionar fundos, visite app.fax.plus
-
Veja os países disponíveis
GET /v3/shop/numbers/countries
Saiba mais: Listar países - API Fax.Plus
Atualmente, os números de fax através da API Fax.Plus estão disponíveis em:
- 🇺🇸 Estados Unidos
- 🇨🇦 Canadá
-
Encontre áreas disponíveis
Depois de selecionar um país, pode ver as áreas geográficas disponíveis onde é possível comprar números de fax.GET /v3/shop/numbers/countries/{country_code}/areas
Exemplo para áreas dos EUA:GET /v3/shop/numbers/countries/US/areas
Saiba mais: Listar áreas - API Fax.Plus -
Pesquise números disponíveis
Pesquise números de fax utilizando filtros de país e área:GET /v3/shop/numbers/countries/{country_code}/areas/{calling_code}/numbers
Exemplo de pesquisa de números em Nova Iorque (código de área 212):GET /v3/shop/numbers/countries/US/areas/212/numbers
Saiba mais: Listar números disponíveis - API Fax.Plus -
Compre um número
Depois de encontrar o número desejado, pode comprá-lo imediatamente:POST /v3/shop/numbers/purchase
Corpo{Resposta
"item_id": "<string>"
}{
"number": "<string>"
}
Notas importantes
- Requisito de saldo: certifique-se de que tem saldo suficiente antes de tentar uma compra.
- Disponibilidade geográfica: atualmente, os números só estão disponíveis nos EUA e no Canadá.
- Método de pagamento: as compras só são processadas utilizando o saldo da sua conta.
- Compras falhadas: se o seu saldo for insuficiente, a compra falhará.
Saiba mais: Comprar um número - API Fax.Plus
Resolução de problemas
Problemas comuns e soluções
-
Saldo insuficiente
- Solução: Adicione fundos através da interface web app.fax.plus.
- Número já não está disponível
- Solução: Os números são atribuídos em tempo real. Se uma compra falhar porque o número já não está disponível, efetue uma nova pesquisa e tente com um número diferente.
- Código de área inválido
- Solução: Verifique novamente o código de área utilizando o endpoint de áreas antes de pesquisar números.