Skip to main content

Integração

Para usar a API, você deve realizar uma requisição POST para o endpoint /verify, enviando um array de números de telefone no corpo da requisição.

Regras para os números de telefone

  • Os números devem ser enviados no formato DDI + Número de Telefone.
    • Exemplo: +5511999999999 para um número no Brasil.
  • O array pode conter até 1000 números por chamada.
  • Todos os números devem ser únicos, ou seja, não podem haver repetições no mesmo array.

Regras de concorrência

  • Não é permitido realizar chamadas simultâneas para este endpoint utilizando o mesmo PrivateToken.
  • Se uma requisição estiver em andamento para um determinado PrivateToken e outra requisição for feita antes da conclusão da primeira, a segunda será bloqueada e retornará o seguinte status HTTP
423 Locked

Base Url

https://api.robbu.global/v1/verify

Autenticação

Para acessar os endpoints da API da Robbu, você precisa autenticar suas requisições utilizando dois tipos de token:
  1. PrivateToken: Um token de acesso privado fornecido pela Robbu.
  2. Authorization: Um token no formato Bearer que valida sua identidade.
Ambos os tokens devem ser incluídos como cabeçalhos na requisição HTTP.
Clique aqui para obter o Private Token do seu ambiente.

Obteção de Tokens

Token Privado

Para consumir esta API, é necessário possuir o token privado da conta configurada no Invenio. Esse token pode ser localizado ao final da página de configurações da conta dentro do Invenio Center.

Para localizar as configurações da conta, siga o caminho:

Invenio Center → Configurações → Conta Clique para acessar as Configurações da Conta tokens

Authorization

Além do token privado, é obrigatória a inclusão de um token de autorização nas requisições. Esse token de autorização deve ser obtido por meio da API de login e enviado no header da requisição para validação de acesso. Abaixo estão as instruções para geração do token. Endpoint de Login Para gerar o token de autorização, realize a autenticação conforme o exemplo abaixo: Método: POST URL: https://api.robbu.global/v1/login
Body
{
    "Company": "#####",
    "Username": "#####",
    "Password": "#####"
}
Parâmetros da Requisição
ParâmetroTipoObrigatórioDescriçãoExemplo
CompanystringSimNome da empresa no ambiente Invenio.Robbu
UsernamestringSimNome de usuário para autenticação.usuario_teste
PasswordstringSimSenha associada ao usuário.senha_secreta

Modelo de Requisição

Headers
PrivateToken
string
required
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Authentication
string
required
Bearer TOKEN
Body
PhoneNumbers
array
required
Lista de números de telefone para validação. Deve conter no máximo 1000 números, todos no formato DDI + Número e sem repetições. | ["+5511941709999", "+5511999999999"]
Exemplo
curl --location 'https://api.robbu.global/v1/verify' \
--header 'Content-Type: application/json' \
--header 'PrivateToken: teste' \
--header 'Authorization: Bearer TOKEN' \
--data '{
    "PhoneNumbers": [
        "14128880043",
        "56971332420",
        "17077878069",
        "18176475163",
        "50431999232",
        "51941700660",
        "18057965469",
        "18402846702",
        "15097929172"
    ]
}
request.json
{
    "PhoneNumbers": [
        "+5511941709999",
        "5511941709999",
        "11941709999",
        "941709999",
        "11999999999"
    ]
}

Modelo de Resposta

response.json
{
    "numbersVerified": [
        {
            "exists": true,
            "jid": "551145679999@s.whatsapp.net",
            "name": "Mauricio da Silva",
            "number": "+5511941709999"
        },
        {
            "exists": true,
            "jid": "551145679999@s.whatsapp.net",
            "name": "Joao Teste",
            "number": "5511941709999"
        },
        {
            "exists": false,
            "jid": "119417099990@s.whatsapp.net",
            "number": "11941709999"
        },
        {
            "exists": false,
            "jid": "941709999@s.whatsapp.net",
            "number": "941709999"
        },
        {
            "exists": false,
            "jid": "11999999999@s.whatsapp.net",
            "number": "11999999999"
        }
    ]
}
ParâmetroTipoDescriçãoExemplo
numbersVerifiedarrayLista de números verificados contendo os detalhes de cada número enviado.Ver descrição abaixo
numbersVerified[].existsbooleanIndica se o número está ativo no WhatsApp.true ou false
numbersVerified[].jidstringIdentificador do número no WhatsApp no formato JID (Jabber ID)."5511941709999@s.whatsapp.net"
numbersVerified[].namestringNome associado ao número no WhatsApp (caso exista)."Usuario Teste"
numbersVerified[].numberstringNúmero de telefone no formato enviado."+5511941709999"

HTTP Status Codes

StatusDescrição
200Sucesso. A requisição foi processada corretamente.
400Erro no request. Verifique os parâmetros enviados na requisição.
401Não autorizado. O token de autenticação é inválido ou está ausente.
403Sem permissão. O cliente não possui autorização para acessar este recurso.
423Não é permitido realizar chamadas simultâneas para este endpoint utilizando o mesmo PrivateToken.
500Erro interno. Entre em contato com o suporte.

⁉️ Perguntas Frequentes (FAQ)

O Robbu Verify é um serviço que permite verificar se um número de telefone está ativo no WhatsApp, ideal para sistemas que precisam confirmar a presença no WhatsApp antes de interagir com o usuário.
Você precisa entrar em contato com o seu Gerente de Contas da Robbu para ativar o serviço na sua conta.
Entre em contato com a equipe comercial da Robbu para detalhes sobre custos e planos disponíveis.