Programadores

GET/v3/getpriceinfo/{visible_uuid}

Consultar um plano de preços guardado para um número

Obtenha os preços guardados específicos da conta e trate resultados desatualizados, vazios ou ambíguos antes de fazer um pedido.

Nesta página
  1. Consultar um plano de preços guardado
  2. Pedido
  3. Resposta
  4. Campos de preço
  5. Tratar vários registos correspondentes
  6. Respostas vazias e erros
  7. Efeitos e limites

Consultar um plano de preços guardado

Consulte os registos de preços guardados para a sua conta de API depois de pesquisar os números de telefone disponíveis. Use o uuid da opção de preço na lista price do número selecionado, e não o próprio número, o ID do prefixo ou o ID da área. Mantenha o número selecionado e a opção de preço associados.

Esta é uma consulta de preços guardados para fins de compatibilidade. Não atualiza a disponibilidade nem os preços, não reserva um número, não faz um pedido nem garante o valor de uma compra futura. Reveja a opção de preço devolvida por uma nova pesquisa de números antes de fazer um pedido.

Pedido

Use a sua conta de API ativada através de HTTPS, a partir de um endereço IP autorizado. Defina PRICE_ID com o ID exato da opção de preço que recebeu. O método lê um argumento no caminho e não lê corpo nem parâmetros de data ou paginação.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getpriceinfo/$PRICE_ID"

Esta consulta deve ser feita pela mesma conta que obteve a opção de preço. Não crie um ID, não use o número de um registo da base de dados nem substitua a seleção pela de outra conta. O método legado procura correspondências apenas pelo ID visível do preço.

Resposta

O exemplo fictício seguinte apresenta apenas alguns campos destinados ao cliente. As respostas reais devolvem registos guardados completos e podem incluir metadados adicionais da conta, do fornecedor e dos preços internos. Mantenha a resposta completa no seu servidor e exponha apenas os valores destinados ao cliente de que a sua aplicação necessita.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "visible_uuid": "PRICE_FROM_SEARCH",
      "setup_price": "2.00",
      "monthly_price": "4.50",
      "per_minute": "0.0100",
      "free_minutes": "100",
      "channels": "2"
    }
  ]
}

response é uma lista, mesmo quando contém apenas um registo. status.results indica o número de registos devolvidos. Os valores numéricos da base de dados podem ser cadeias de caracteres. O endpoint não adiciona um campo de moeda nem converte moedas; confirme a moeda de faturação da conta em vez de a deduzir a partir deste exemplo.

Campos de preço

Campos selecionados do plano de preços
CampoSignificado
visible_uuidIdentificador visível da opção de preço guardada. Use o ID original da opção para estabelecer a correspondência com a consulta.
setup_pricePreço de ativação único guardado para esta opção.
monthly_pricePreço mensal recorrente guardado.
per_minute, free_minutesTarifa por minuto de chamadas recebidas e quantidade de minutos incluídos guardadas. Estes valores não constituem uma cotação para chamadas efetuadas nem para todas as possíveis sobretaxas.
channelsQuantidade de canais guardada para esta opção; não constitui uma verificação em tempo real da capacidade ou do registo.
yearly_pricePode estar presente um campo adicional de preço anual guardado. Não deduza que um preço mensal diferente de zero e um campo anual com valor zero representam um plano anual gratuito.

Tratar vários registos correspondentes

Uma consulta pode devolver mais de um registo guardado. O método não garante uma ordenação, não seleciona o registo mais recente nem disponibiliza um filtro por número ou prefixo. Não escolha silenciosamente o primeiro ou o último registo. Compare o contexto devolvido com o número e a opção de preço originalmente selecionados; se continuar ambíguo ou desatualizado, repita a pesquisa de números em vez de tratar esta resposta como uma cotação para um pedido.

O fluxo de revisão de pedidos do portal realiza verificações adicionais de seleção e validade. Não presuma que esta consulta legada implementa essas verificações ou aceita todos os identificadores que o portal aceita.

Respostas vazias e erros

Se nenhum registo guardado corresponder, o processador atual não emite qualquer resultado JSON nem uma resposta explícita de não encontrado. Um corpo vazio não significa um preço zero, um plano disponível ou uma consulta cujo sucesso esteja confirmado. Verifique tanto a resposta HTTP como a estrutura JSON; não faça pedidos com base em dados de preços ausentes ou que não possam ser analisados.

A autenticação, as restrições de IP de origem e as falhas da base de dados também podem impedir uma resposta utilizável. Não existe uma estrutura de erro específica deste processador para exceções da base de dados. Atualize a sua seleção ou contacte o suporte se uma consulta autenticada continuar indisponível.

Efeitos e limites

A consulta analisada executa uma operação de leitura e não efetua débitos, compras, reservas nem atualizações dos preços do fornecedor. A leitura dos preços guardados não confirma o inventário atual, a aprovação regulamentar, a permissão de compra da conta nem a faturação final.