Pular para o conteúdo principal

Validação de número de telefone - Amplia Reg

O Amplia Reg envia mensagens de texto ao titular, como a chave de emissão 2 quando o pedido é aprovado, por isso o telefone do pedido precisa ser válido. A criação do pedido rejeita um telefone inválido. Para detectar o problema antes, por exemplo enquanto o cliente ainda preenche o seu formulário, confira o número com a API de validação antes de criar o pedido.

dica

Certifique-se de que já realizou os Primeiros passos

Qualquer chave de API pode chamar esta API: ela não exige nenhum papel específico.

Validando um número​

Em .NET:

bool isValid = await ampliaRegService.ValidatePhoneNumberAsync("+5511999990000");
if (!isValid) {
	// Peça ao cliente que corrija o número de telefone
}

Via API:

GET /api/users/phone-number/validation?phoneNumber=%2B5511999990000

O corpo da resposta é true se o número for válido e false caso contrário.

observação

Codifique o número na query string: o + do prefixo internacional precisa ser enviado como %2B, senão é lido como espaço. A client lib .NET faz essa codificação por você.

O que é verificado​

A API aplica a mesma verificação que a criação do pedido aplica aos campos phone e alternativePhone de contact. Um número aceito pela API também é aceito na criação do pedido.

  • Código do país: o número precisa incluir o código do país, como em +5511999990000. O + inicial é opcional, mas o código do país não: sem ele, os primeiros dígitos do número são lidos como código do país, então 11999990000 seria lido como um número do código de país 1 (Estados Unidos e Canadá) e rejeitado.
  • Plano de numeração: o número precisa ser válido no país, com o tamanho certo e um DDD e um prefixo válidos.
  • Paraguai: números de celular paraguaios (+595 9XX XXX XXX) também são aceitos quando o plano de numeração ainda não os reconhece.
  • Formatação: espaços, parênteses e hífens são permitidos, como em +55 (11) 99999-0000.

A verificação não confirma que a linha existe nem que pertence ao titular.

aviso

Um phoneNumber vazio ou ausente devolve true, porque a API só rejeita números que consegue identificar como errados. Verifique valores vazios por conta própria.

Dicas​

  • Peça um número de celular no campo phone. Um telefone fixo válido passa na verificação, mas os códigos de uso único que o Amplia Reg envia por SMS, por exemplo para o titular entrar em uma videoconferência ou iniciar uma vídeo identificação, só podem ir para um celular.
  • Envie o número no formato E.164 (+5511999990000, só dígitos depois do +). Pedidos comuns guardam o telefone nesse formato independentemente da entrada, mas os pedidos pré-aprovados o guardam como foi enviado.

Veja também​

Ver em Markdown