Receba SMS e mensagens do WhatsApp por uma única API.

1. 1

   Crie uma chave de API

   Copie o segredo quando ele aparecer, pois ele não será mostrado novamente.

2. 2

   Reserve um número

   O NumPort devolve o número e o token de acesso da inbox.

3. 3

   Aguarde ou extraia o código

   Use a espera da API com uma expressão regular para receber somente o OTP esperado.

pip install numport

curl -X POST "$NUMPORT_API_URL/v1/inboxes" \  -H "Authorization: Bearer $NUMPORT_API_KEY" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{    "country": "US",    "channel": "sms",    "ttl_seconds": 900,    "content_ttl_seconds": 86400  }'
curl --get "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/messages/wait" \  -H "Authorization: Bearer $INBOX_TOKEN" \  --data-urlencode "timeout=120" \  --data-urlencode "since=0" \  --data-urlencode 'match=\d{6}'

A resposta traz id,phone_number eaccess_token. Guarde esses três valores enquanto a inbox estiver ativa, pois o token só aparece nesta resposta.

• Você pode definir ttl_seconds entre 60 e 1.800 segundos. Se não informar um valor, usamos 900 segundos.
• O campo content_ttl_seconds aceita valores entre 60 e 86.400 segundos e define quando a chave do conteúdo será destruída. Ele não prolonga a reserva nem a validade do token.
• A extensão não consome outro crédito e só pode ocorrer uma vez.
• A liberação manual é opcional. Sem ela, a inbox continua contando no limite de simultaneidade até expirar.

curl "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID" \  -H "Authorization: Bearer $INBOX_TOKEN"
curl -X POST "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/extend" \  -H "Authorization: Bearer $INBOX_TOKEN"
curl -X POST "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/token/rotate" \  -H "Authorization: Bearer $INBOX_TOKEN"
curl -X DELETE "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID" \  -H "Authorization: Bearer $INBOX_TOKEN"

Se você quiser esperar pela próxima mensagem, use GET /messages/wait e escolha um prazo entre 1 e 300 segundos. O parâmetro match aceita uma expressão regular de até 200 caracteres. Quando o padrão é encontrado, o trecho aparece em extracted.match, enquanto o texto completo continua disponível em untrusted_content.

Quando o prazo termina sem uma mensagem correspondente, a API responde com 204 No Content. Isso não é um erro. Você pode iniciar outra espera usando o mesmo cursor.

curl --get "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/messages" \  -H "Authorization: Bearer $INBOX_TOKEN" \  --data-urlencode "since=0" \  --data-urlencode 'match=code: \d{6}'
curl --get "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/messages/wait" \  -H "Authorization: Bearer $INBOX_TOKEN" \  --data-urlencode "since=0" \  --data-urlencode "timeout=120"

curl -c cookies.txt -X POST \  "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/stream-session" \  -H "Authorization: Bearer $INBOX_TOKEN"
curl -N -b cookies.txt \  "$NUMPORT_API_URL/v1/inboxes/$INBOX_ID/events" \  -H "Last-Event-ID: 0"

O evento avisa que uma nova mensagem chegou e traz seq e message_id. Em seguida, leia o conteúdo pelo endpoint autenticado. Se a conexão cair, o navegador envia Last-Event-ID, e o servidor entrega os eventos que ficaram para trás antes de continuar o stream.

Nesta primeira versão, a API recebe somente texto. Ela ainda não envia mensagens e não recebe mídia ou chamadas de voz.

Cada chave tem um nome e uma lista de permissões. Se quiser, você também pode limitar o gasto por hora e o número de inboxes abertas ao mesmo tempo. O segredo aparece apenas na criação. Ao revogar uma chave, somente ela deixa de funcionar; as demais credenciais da conta continuam ativas.

curl --get "$NUMPORT_API_URL/v1/pool/status" \  -H "Authorization: Bearer $NUMPORT_API_KEY" \  --data-urlencode "country=US"
curl "$NUMPORT_API_URL/v1/account/usage" \  -H "Authorization: Bearer $NUMPORT_API_KEY"

A resposta separa os créditos que vieram com o plano daqueles que foram comprados. Ela também mostra quanto foi usado no ciclo e na hora atual, além das datas do período e dos limites da conta. Os nomes exatos de cada campo aparecem no exemplo acima.

• Um upgrade entra em vigor assim que o pagamento é confirmado.
• Um downgrade ou cancelamento é agendado para o fim do ciclo atual, sem interromper o plano antes da data prevista.
• Primeiro usamos os créditos incluídos no plano. Quando eles acabam, o consumo passa para os créditos comprados.
• O plano gratuito reserva um número temporário por até 10 minutos. Nos planos pagos, a reserva inicial pode chegar a 30 minutos.
• No console, você pode escolher um valor sugerido ou digitar qualquer outro valor. A quantidade equivalente de créditos aparece antes do checkout.

As compras e mudanças de plano são feitas pelo console autenticado. O servidor confere novamente os valores e a quantidade de créditos antes de concluir cada operação. Voltar da página de checkout, sozinho, nunca adiciona créditos à conta.

Em cada seção, use as abas para escolher entre uma chamada HTTP direta, Python ou Node.js. Os exemplos seguem os nomes dos métodos e os tipos publicados por cada pacote.

curl -i -X POST "$NUMPORT_API_URL/v1/inboxes" \  -H "Authorization: Bearer $NUMPORT_API_KEY" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{"country":"US","channel":"sms"}'
# HTTP/1.1 503 Service Unavailable# Retry-After: 30# {"error":{"code":"POOL_EXHAUSTED","message":"..."}}

A conexão pode terminar durante POST /v1/inboxes mesmo que a inbox já tenha sido criada. Nesse caso, repita a mesma chamada com a mesma Idempotency-Key. O servidor devolve o resultado original sem cobrar outro crédito.