A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.
/v1/users
Use o nó users
para gerenciar a autenticação e acessar o cliente da API Local do WhatsApp Business.
O cliente da API Local do WhatsApp Business tem uma conta-padrão: o nome de usuário é admin
, e a senha é secret
. Não é possível remover nem excluir essa conta do sistema. Por motivos de segurança, é necessário alterar a senha do administrador imediatamente.
Se você esquecer a senha, entre em contato com o Suporte Direto para solicitar ajuda com a redefinição.
admin
da conta pode criar ou excluir usuários.admin
apenas para criar ou excluir usuários.Para criar uma conta com acesso à API do WhatsApp Business para um usuário da empresa, envie o nome de usuário e a senha ao cliente da API Local do WhatsApp Business usando o ponto de extremidade /users
. Ele validará o nome de usuário e a senha e criará uma nova conta se já não existir outra conta com esse nome de usuário. A senha é processada com um hash unidirecional e armazenada em um volume de dados. Os parâmetros username
e password
são obrigatórios.
Para criar um usuário, envie uma solicitação semelhante a esta:
POST /v1/users Authorization: Bearer your-auth-token { "username": "username", "password": "password" }
Se a solicitação for bem-sucedida e a conta de usuário for criada, você receberá o código de status HTTP 201 Created
e a seguinte carga:
{ "users": [{ "username": "username" }] }
Se a solicitação não for bem-sucedida, você receberá um código de status HTTP e um código de erro do WhatsApp. Caso você envie um nome de usuário duplicado, a resposta de erro será semelhante a esta:
{ "errors": [{ "code": 1014, "title": "Internal error", "details": "Unable to create user. Already exist?" }] }
Nome | Descrição |
---|---|
| Obrigatório. Deve ter no mínimo 4 e no máximo 32 caracteres. |
| Obrigatório. Deve ter entre 8 e 64 caracteres com pelo menos uma letra maiúscula, uma minúscula, um número e um caractere especial:
!\/'"#$%&()*+-.,:;_<>=?@[]{}^`|~
|
| Obrigatório. Token de autenticação para o administrador que executa a solicitação. Para ver mais informações, consulte a documentação sobre login e autenticação – tokens. |
As seguintes bordas estão relacionadas ao nó:
Borda | Descrição |
---|---|
Use essa borda para fazer login no cliente da API Local do WhatsApp Business. | |
Use essa borda para desconectar do cliente da API Local do WhatsApp Business. | |
Use essa borda para recuperar, atualizar ou excluir a conta de um usuário. |
Código de status HTTP | Motivo |
---|---|
|
Envie a solicitação novamente com um nome de usuário/senha de tamanho correto. |
| Você não usou a conta |
| Não foi possível criar a conta, provavelmente porque ela já existe. |
Se ocorrerem outros erros na resposta, consulte estas fontes para mais informações: Códigos de erro e Código de status HTTP.