Ir para o conteúdo

GetSettings#

O método é destinado a obter as configurações atuais da conta.

Requisição#

Para obter as configurações atuais da conta, é necessário enviar uma solicitação para o seguinte endereço:

GET https://api.green-api.com/waInstance{{idInstance}}/GetSettings/{{apiTokenInstance}}Para obter os parâmetros de solicitação `idInstance` e `apiTokenInstance`, consulte a seção [Antes de começar](../../before-start.md#parameters).

Resposta#

Campos da resposta#

Campo Tipo Descrição
wid string Identificador da conta no WhatsApp
countryInstance string Código do país da conta de acordo com o padrão ISO 3166-2
typeAccount string Tipo da conta, valores possíveis: trial, production, vip
webhookUrl string URL para receber notificações de entrada
webhookUrlToken string Token para se conectar ao seu servidor de webhook
delaySendMessagesMilliseconds integer Intervalo de envio de mensagens em milissegundos
markIncomingMessagesReaded string Marcar as mensagens recebidas como lidas ou não, valores possíveis: yes, no. Ignorado se markIncomingMessagesReadedOnReply for definido como 'yes'.
markIncomingMessagesReadedOnReply string Marcar as mensagens recebidas como lidas ao enviar uma mensagem para o chat via API, valores possíveis: yes, no. Se definido como 'yes', a configuração markIncomingMessagesReaded é ignorada.
outgoingWebhook string Receber notificações sobre o status de envio/entrega/leitura de mensagens de saída, valores possíveis: yes, no
outgoingMessageWebhook string Receber notificações sobre mensagens enviadas do telefone, valores possíveis: yes, no
stateWebhook string Receber notificações sobre mudanças no estado de autorização da conta, valores possíveis: yes, no
incomingWebhook string Receber notificações sobre mensagens e arquivos recebidos, valores possíveis: yes, no
deviceWebhook string Receber notificações sobre o dispositivo (telefone) e o nível de carga da bateria, valores possíveis: yes, no
statusInstanceWebhook string Receber notificações sobre mudanças no estado da conexão do socket da conta, valores possíveis: yes, no
sendFromUTC string Obter a configuração da conta para enviar intervalo da fila a partir do horário especificado (Atenção, o horário é especificado em UTC), valores possíveis: 09:00
sendToUTC string Obter a configuração da conta para enviar intervalo da fila até o horário especificado (Atenção, o horário é especificado em UTC), valores possíveis: 12:00

Exemplo de corpo de resposta#

{
    "wid": "11001234567@c.us", 
    "countryInstance": "ru",
    "typeAccount": "vip",
    "webhookUrl": "https://mysite.com/webhook/green-api/",
    "webhookUrlToken": "",
    "delaySendMessagesMilliseconds": 3000,
    "markIncomingMessagesReaded": "yes",
    "markIncomingMessagesReadedOnReply": "no",
    "outgoingWebhook": "yes",
    "outgoingMessageWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes",
    "deviceWebhook": "no",
    "statusInstanceWebhook": "yes",
    "sendFromUTC": "12:00",
    "sendToUTC": "18:00"
}

Erros do GetSettings#

Consulte a lista de erros comuns a 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}}/getSettings/{{apiTokenInstance}}"

payload = {}
headers= {}

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

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