Ir para o conteúdo

SetSettings#

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

Ao chamar este método, a conta é reiniciada.

Solicitação#

Para definir as configurações da conta, você precisa fazer uma solicitação para o seguinte endereço: 

POST https://api.green-api.com/waInstance{{idInstance}}/SetSettings/{{apiTokenInstance}}

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

Parâmetros da solicitação#

Os parâmetros podem ser especificados de forma seletiva. Pelo menos um parâmetro deve ser especificado.

Parâmetro Tipo Obrigatório Descrição
countryInstance string Não Código do país da conta de acordo com o padrão ISO 3166-2
webhookUrl string Não URL para envio de notificações. Se você precisa desativar a recepção de notificações, especifique uma string vazia
webhookUrlToken string Não Token para acessar seu servidor de notificações, se não for necessário, especifique uma string vazia
delaySendMessagesMilliseconds integer Não Intervalo de envio de mensagens em milissegundos. Valor mínimo 500 ms
markIncomingMessagesReaded string Não Marcar mensagens recebidas como lidas ou não, possíveis valores: yes, no. Ignorado se markIncomingMessagesReadedOnReply estiver definido como 'yes'.
markIncomingMessagesReadedOnReply string Não Marcar mensagens recebidas como lidas ao enviar uma mensagem para o chat via API, possíveis valores: yes, no. Se o valor for 'yes', a configuração markIncomingMessagesReaded é ignorada.
outgoingWebhook string Não Receber notificações sobre o status de envio/entrega/leitura de mensagens enviadas, possíveis valores: yes, no
outgoingMessageWebhook string Não Receber notificações sobre mensagens enviadas do telefone, possíveis valores: yes, no
stateWebhook string Não Receber notificações sobre a mudança no estado de autorização da conta, possíveis valores: yes, no
incomingWebhook string Não Receber notificações sobre mensagens e arquivos recebidos, possíveis valores: yes, no
deviceWebhook string Não Receber notificações sobre o dispositivo (telefone) e o nível de bateria, possíveis valores: yes, no
statusInstanceWebhook string Não Receber notificações sobre a mudança no status da conexão do socket da conta, possíveis valores: yes, no
sendFromUTC string Não Definir a configuração da conta para enviar a partir do intervalo de tempo ESPECIFICADO (Atenção, o tempo é especificado em UTC), necessário se sendToUTC estiver definido, possíveis valores: 09:00
sendToUTC string Não Definir a configuração da conta para enviar ATÉ o intervalo de tempo ESPECIFICADO (Atenção, o tempo é especificado em UTC), necessário se sendFromUTC estiver definido, possíveis valores: 12:00

Exemplo de corpo de solicitação#

{
    "countryInstance": "ru",
    "webhookUrl": "https://mysite.com/webhook/green-api/",
    "webhookUrlToken": "",
    "delaySendMessagesMilliseconds": 1000,
    "markIncomingMessagesReaded": "no",
    "markIncomingMessagesReadedOnReply": "no",
    "outgoingWebhook": "yes",
    "outgoingMessageWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes",
    "deviceWebhook": "no",
    "statusInstanceWebhook": "yes" 
}

Exemplo de corpo de solicitação para definir um intervalo de tempo#

É obrigatório indicar os parâmetros sendFromUTC e sendToUTC juntos, caso contrário, ocorrerá um erro. Se você precisa enviar mensagens apenas no intervalo das 12:00 às 18:00 MSK, então você precisa especificar esses valores dos parâmetros:

{
    "sendFromUTC": "09:00",
    "sendToUTC": "15:00"
}

Resposta#

Campos de resposta#

Campo Tipo Descrição
saveSettings boolean Indicador que as configurações foram salvas

Exemplo de corpo de resposta#

{
    "saveSettings": true
}

Erros do SetSettings#

Veja 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}}/setSettings/{{apiTokenInstance}}"

payload = "{rnt"countryInstance": "ru",rnt"webhookUrl": "https://mysite.ru",rnt"delaySendMessagesMilliseconds": 1000,rnt"markIncomingMessagesReaded": "no",rnt"outgoingWebhook": "yes",rnt"stateWebhook": "yes",rnt"incomingWebhook": "yes",rnt"deviceWebhook": "no"rn}"
headers = {
  'Content-Type': 'application/json'
}

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

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