Documentação da API REST
API REST de consulta de encaminhamento LRN
Consulte o número de encaminhamento e as informações de operadora disponíveis para um número de telefone norte-americano a um preço fixo.
Escolha a API e a credencial em conjunto
As contas aprovadas de Programadores e Automação, Empresas e Prestadores de Comunicações podem integrar os serviços ativados. Um programador individual não precisa de se apresentar como uma empresa. O envio de SMS/MMS por aplicações exige a aprovação de envio e o registo aplicáveis. O serviço para Particulares e famílias não tem uma API de envio de mensagens acessível ao cliente.
| Família de API | URL base | Autenticação e resultado |
|---|---|---|
| Comunicações v3 | https://api.multitel.net/v3 | Credenciais Basic aprovadas; tokens provisionados elegíveis apenas para operações que os suportem. JSON status e response. |
| Registo de emergência | https://api.multi.tel/emergency | Credenciais Basic aprovadas ou acesso bearer provisionado especificamente. JSON code, message e data. |
| Integrações REST do portal | Host e operação indicados na referência de desenvolvimento da sua conta | Use a credencial, os âmbitos (scopes) e o esquema documentados dessa operação. Os pedidos de sessão do navegador são uma superfície separada. |
Defina MULTITEL_API_USERNAME e MULTITEL_API_PASSWORD através da configuração de segredos do seu servidor antes de usar os exemplos. Nunca os incorpore em JavaScript público de navegador, em URLs ou no controlo de versões. As credenciais dedicadas são geridas em Definições de integração da API.
Consultar um número
GET /v3/lrn/{number} aceita o número de destino no caminho. Pode indicar-se opcionalmente um número de origem como /v3/lrn/{number}/{ani} para informação que dependa da origem. Use dígitos norte-americanos com o indicativo do país, quando aplicável; os exemplos usam números fictícios reservados.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Executar uma consulta com credenciais válidas é faturável. A tarifa é de US$ 0,00025 por consulta: US$ 0,25 por 1.000 ou US$ 250 por milhão. Não há descontos por volume. Trata-se de uma consulta de informação de encaminhamento; não efetua uma chamada telefónica.
Ler o resultado
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Este exemplo inventado demonstra apenas a forma da resposta; não é um resultado de encaminhamento medido. Verifique status.code antes de usar response. O campo cost é uma string com prefixo de moeda, não um número JSON.
| Campo | Significado |
|---|---|
lrn | Location Routing Number usado para identificar o destino de encaminhamento. |
ported | Indicador de portabilidade fornecido por esta consulta: normalmente 0 ou 1. Não o use como prova de titularidade nem de elegibilidade para o serviço. |
ocn | Operating Company Number, quando fornecido. |
lata | Local Access and Transport Area, quando fornecida. |
rc | Rate center, quando fornecido. |
city, state, lec, lectype, jurisdiction, local | Detalhes adicionais de localização, operadora ou relacionados com a origem, quando disponíveis. Podem estar ausentes ou em branco. |
Não exija que todos os campos de encaminhamento estejam presentes. Em particular, os resultados de números gratuitos (toll-free) podem omitir detalhes do rate center local e do código da operadora. Um LRN devolvido não é uma garantia em tempo real de alcançabilidade nem um teste de qualidade de chamada.
Use as consultas no seu fluxo de encaminhamento
- Valide e normalize o número pedido antes de o enviar.
- Inspecione o status HTTP e o status da aplicação. Mantenha um registo, com dados sensíveis removidos, do número, da hora e do resultado para diagnóstico.
- Use apenas os campos relevantes para a sua regra de encaminhamento e trate explicitamente os valores ausentes.
- Limite as novas tentativas após uma resposta incerta. Repetir uma consulta pode gerar outra cobrança; este endpoint não tem chave de idempotência documentada.
Consulte o produto LRN e o preço fixo. O caminho OpenAPI público inclui um segmento ANI; a implementação LRN em produção também aceita o pedido mais curto sem ANI. lrninfo é uma operação separada e não deve ser usada como substituto deste endpoint.
Tratar erros e novas tentativas
- Falha de autenticação ou de permissão
- Verifique se a credencial da API está ativada, o serviço permitido e a restrição de IP de origem. Um cookie de sessão do portal não é uma credencial de integração.
- Crédito insuficiente ou aprovação pendente
- Resolva o saldo da conta, a aprovação de envio ou o requisito de documentos antes de repetir a operação.
- Sem resultado
- Trate um inventário vazio ou a ausência do nome do chamador como um resultado normal. Não presuma que um número sintaticamente válido tenha todos os serviços.
- Tempo limite de rede ou falha do serviço
- Use novas tentativas limitadas com espera progressiva (backoff) para leituras. Numa compra, envio ou registo, verifique primeiro o estado da operação; repetir um pedido aceite pode duplicar uma ação faturável.
O suporte a idempotência depende de cada família de API. A API de emergência suporta chaves de repetição; isso não torna idempotentes pedidos v3 arbitrários. Guarde os carimbos de data/hora, os IDs devolvidos e as respostas com dados sensíveis removidos para o suporte.
Continue com a referência da sua conta
A referência com sessão iniciada filtra as operações de acordo com as suas permissões e os serviços ativados. Utilize o respetivo host, o tipo de credencial, os campos de pedido e o esquema de resposta exatos. As consolas podem executar operações reais, incluindo compras e mensagens.