Documentação da API REST

APIs REST de chamadas de emergência

Registe um número e uma morada de serviço, acompanhe o estado de ativação e mantenha o registo atualizado quando a localização mudar.

Abrir a referência específica da conta Programadores e Automação

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.

Ler a cobertura sem registar um número

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency também é suportado. Nenhum dos URLs base de emergência contém /v3. A cobertura lista países internacionais, tipos de número suportados e preços; a elegibilidade para E911 norte-americano é verificada durante o registo.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

Isto ilustra apenas o envelope. Leia o esquema de data de cada operação no guia publicado da API de emergência.

Registar, acompanhar o estado e depois configurar as chamadas

Para os EUA/Canadá e as restantes regiões de E911 norte-americano suportadas, indique o número, o endereço E911 e as confirmações de consentimento exigidas. O E911 norte-americano é apenas para produção.
Para um número internacional próprio e suportado, indique uma referência de Documento guardada ou a identidade e o endereço do utilizador final. Reveja primeiro os requisitos do país e do tipo de número.
Envie um único pedido POST /registrations. Uma Idempotency-Key opcional identifica uma mutação lógica; conserve-a, bem como o payload exato, em todas as novas tentativas.
Leia GET /registrations/:number. Inspecione o ciclo de vida, pending e actionRequired; resolva as correções exigidas. Aceitação ou pendência não equivale a serviço ativo.
Após a ativação, configure o identificador de chamador de emergência correto e a rota de marcação específica do país. Use o procedimento de verificação do serviço que não envolve chamadas de emergência.

Os registos internacionais em sandbox são isolados e não ativam chamadas de emergência reais. São necessárias credenciais da conta principal para o E911 norte-americano; o guia explica o suporte limitado de subcontas internacionais.

Configuração e verificação no portal Cobertura por país e dígitos de emergência Guia público completo de pedidos, campos, estado e novas tentativas

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.

Catálogo de endpoints específico da conta Consola REST de comunicações Documento OpenAPI público de comunicações Guia de integração OAuth