StartAuthorization#

Este método é projetado para iniciar o processo de autorização de uma instância por meio de um número de telefone.

Para autorizar uma conta, você precisa inserir um número de telefone, para o qual será enviada uma mensagem SMS com um código de confirmação.

Para obter o código, a conta deve estar em um estado não autorizado. Se a conta estiver autorizada, será necessário primeiro fazer logout da conta usando o método Logout.

Após a execução bem-sucedida do método, a conta passa para o estado pendingCode e é necessário executar o método SendAuthorizationCode para enviar o código de confirmação.

Após a autorização bem-sucedida da conta, é gerada uma notificação de entrada com o tipo Status da conta. Após a autorização bem-sucedida, a conta passa para o estado starting e depois para authorized.

Solicitação#

Para iniciar o processo de autorização, você precisa executar uma solicitação para o endereço:

GET https://api.green-api.com/waInstance{{idInstance}}/startAuthorization/{{apiTokenInstance}}

Para obter os parâmetros de solicitação idInstance e apiTokenInstance, consulte a seção Antes de começar.

Parâmetros da solicitação#

Parâmetro	Tipo	Obrigatório	Descrição
`phoneNumber`	number	Sim	Número de telefone no formato internacional
`method`	string	Sim	Método de envio do código de confirmação. Valores possíveis: `sms`, `voice` ou `app`. Se `app`, então o código de confirmação será enviado no aplicativo.
`locale`	string	Sim	Idioma do código de confirmação enviado. Valores possíveis: `ru-RU`, `en-US`.
`name`	string	Sim	Nome do usuário. Usado para definir o nome do usuário na conta do WhatsApp.

Exemplo do corpo da solicitação#

{
    "phoneNumber": 5521980090000,
    "method": "sms",
    "locale": "pt-BR",
    "name": "Your Name"
}

Resposta#

Campos da resposta#

Campo	Tipo	Descrição
`status`	boolean	Status da execução da solicitação. Valores possíveis: `true` ou `false`
`data`	object	Dados de autorização
`data.status`	string	Status de autorização. Valores possíveis: `sent`, `fail`
`data.reason`	string	Motivo da falha na autorização. Valores possíveis: `already_registered`, `invalid_phone_number`, `connection_error` . O parâmetro é retornado apenas se `data.status` for igual a `fail`
`data.retryAfter`	integer	Tempo em segundos após o qual a solicitação pode ser repetida. O parâmetro é retornado apenas se `data.status` for igual a `sent`

Exemplo do corpo da resposta#

{
    "status": true,
    "data": {
        "status": "sent",
        "retryAfter": 124
    }
}

Erros de StartAuthorization#

Veja a lista de erros comuns para todos os métodos na seção Erros comuns

Exemplo de código em Python#

import requests

url = "https://api.green-api.com/waInstance{{idInstance}}/startAuthorization/{{apiTokenInstance}}"

payload = "{rnt"phoneNumber": 79770006428,rn    "method": "sms",rn    "locale": "ru-RU",rn    "name": "Your Name"rn}rn"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))