SetSettings#
ÐеÑод пÑедназнаÑен Ð´Ð»Ñ ÑÑÑановки наÑÑÑоек инÑÑанÑа.
ÐоÑле ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ð¸Ð½ÑÑанÑа вÑе наÑÑÑойки по ÑмолÑÐ°Ð½Ð¸Ñ Ð²ÑклÑÑенÑ.
ÐÑи вÑзове данного меÑода инÑÑÐ°Ð½Ñ Ð¿ÐµÑезапÑÑкаеÑÑÑ.
ÐаÑÑÑойки пÑименÑÑÑÑÑ Ð² ÑеÑение 5 минÑÑ Ð¿Ð¾Ñле вÑзова меÑода setSettings.
ÐÐ»Ñ Ð¼ÐµÑода иÑполÑзÑÑÑÑÑ Ð¾Ð³ÑаниÑÐµÐ½Ð¸Ñ Ð½Ð° ÑаÑÑоÑÑ Ð·Ð°Ð¿ÑоÑов в ÑекÑндÑ.
ÐапÑоÑ#
ÐÐ»Ñ ÑÑÑановки наÑÑÑоек инÑÑанÑа ÑÑебÑеÑÑÑ Ð²ÑполниÑÑ Ð·Ð°Ð¿ÑÐ¾Ñ Ð¿Ð¾ адÑеÑÑ:
{{apiUrl}}/waInstance{{idInstance}}/setSettings/{{apiTokenInstance}}
ÐÑеÑÐ¸ÐºÑ v3 ÑÑал необÑзаÑелÑнÑм паÑамеÑÑом запÑоÑа
ÐÐ»Ñ Ð²Ð°Ñего ÑдобÑÑва ÑниÑиÑиÑовали ÑоÑÐ¼Ð°Ñ Ð·Ð°Ð¿ÑоÑов меÑодов API Ð´Ð»Ñ Ð²ÑеÑ
меÑÑенджеÑов.
ÐодÑобнее о пÑавилаÑ
вÑзова меÑодов ÑиÑайÑе в ÑÑаÑÑе ÐÑполнение запÑоÑов.
ÐÐ»Ñ Ð¿Ð¾Ð»ÑÑÐµÐ½Ð¸Ñ Ð¿Ð°ÑамеÑÑов запÑоÑа apiUrl, idInstance и apiTokenInstance обÑаÑиÑеÑÑ Ðº ÑÐ°Ð·Ð´ÐµÐ»Ñ ÐеÑед наÑалом ÑабоÑÑ.
ÐаÑамеÑÑÑ Ð·Ð°Ð¿ÑоÑа#
ÐопÑÑкаеÑÑÑ ÑказÑваÑÑ Ð¿Ð°ÑамеÑÑÑ Ð²ÑбоÑоÑно. ХоÑÑ Ð±Ñ Ð¾Ð´Ð¸Ð½ паÑамеÑÑ Ð´Ð¾Ð»Ð¶ÐµÐ½ бÑÑÑ Ñказан.
| ÐаÑамеÑÑ | Тип | ÐбÑзаÑелÑнÑй | ÐпиÑание |
|---|---|---|---|
webhookUrl | string | ÐÐµÑ | URL Ð´Ð»Ñ Ð¾ÑпÑавки Ñведомлений. ÐÑли ÑÑебÑеÑÑÑ Ð¾ÑклÑÑиÑÑ Ð¿Ð¾Ð»ÑÑение Ñведомлений, Ñо ÑкажиÑе пÑÑÑÑÑ ÑÑÑокÑ. ÐÑи полÑÑении Ñведомлений ÑÐµÑ Ð½Ð¾Ð»Ð¾Ð³Ð¸ÐµÐ¹ HTTP API, поле должно бÑÑÑ Ð¿ÑÑÑÑм. ÐпиÑание ÑабоÑÑ Ð¿Ð¾Ð»Ñ |
webhookUrlToken | string | ÐÐµÑ | Ðаголовок авÑоÑизаÑии Ð´Ð»Ñ Ð¾ÑпÑавки Ñведомлений, еÑли не ÑÑебÑеÑÑÑ, Ñо ÑкажиÑе пÑÑÑÑÑ ÑÑÑокÑ. ÐпиÑание ÑабоÑÑ Ð¿Ð¾Ð»Ñ. |
delaySendMessagesMilliseconds | integer | ÐÐµÑ | ÐнÑеÑвал оÑпÑавки ÑообÑений в миллиÑекÑндаÑ
. ÐинималÑное знаÑение: 500 мÑек (0.5 ÑекÑндÑ) ÐакÑималÑное знаÑение: 600000 мÑек (10 минÑÑ). РекомендÑеÑÑÑ ÑÑÑанавливаÑÑ Ð¸Ð½ÑеÑвал не более 300000 мÑек (5 минÑÑ). |
markIncomingMessagesReaded | string | ÐÐµÑ | ÐÑмеÑаÑÑ Ð²Ñ
одÑÑие ÑообÑÐµÐ½Ð¸Ñ Ð¿ÑоÑиÑаннÑми, возможнÑе знаÑениÑ: yes, no. ÐгноÑиÑÑеÑÑÑ, еÑли markIncomingMessagesReadedOnReply в знаÑении 'yes'. |
markIncomingMessagesReadedOnReply | string | ÐÐµÑ | ÐÑмеÑаÑÑ Ð²Ñ
одÑÑие ÑообÑÐµÐ½Ð¸Ñ Ð¿ÑоÑиÑаннÑми пÑи оÑпÑавке ÑообÑÐµÐ½Ð¸Ñ ÑеÑез API, возможнÑе знаÑениÑ: yes, no. ÐÑли в знаÑении 'yes', Ñо наÑÑÑойка markIncomingMessagesReaded игноÑиÑÑеÑÑÑ. |
outgoingWebhook | string | ÐÐµÑ | ÐолÑÑаÑÑ ÑÐ²ÐµÐ´Ð¾Ð¼Ð»ÐµÐ½Ð¸Ñ Ð¾ ÑÑаÑÑÑаÑ
оÑпÑавленнÑÑ
ÑообÑений, возможнÑе знаÑениÑ: yes, no. |
outgoingMessageWebhook | string | ÐÐµÑ | ÐолÑÑаÑÑ ÑÐ²ÐµÐ´Ð¾Ð¼Ð»ÐµÐ½Ð¸Ñ Ð¾ ÑообÑениÑÑ
, оÑпÑавленнÑÑ
Ñ ÑелеÑона, web веÑÑии и desktop веÑÑии, возможнÑе знаÑениÑ: yes, no |
outgoingAPIMessageWebhook | string | ÐÐµÑ | ÐолÑÑаÑÑ ÑÐ²ÐµÐ´Ð¾Ð¼Ð»ÐµÐ½Ð¸Ñ Ð¾ ÑообÑениÑÑ
, оÑпÑавленнÑÑ
ÑеÑез API, возможнÑе знаÑениÑ: yes, no. ÐÑи оÑпÑавке ÑообÑÐµÐ½Ð¸Ñ Ð½Ð° неÑÑÑеÑÑвÑÑÑий аккаÑÐ½Ñ Ð¼ÐµÑÑенджеÑа MAX, Ñведомление не пÑидеÑ. |
stateWebhook | string | ÐÐµÑ | ÐолÑÑаÑÑ ÑÐ²ÐµÐ´Ð¾Ð¼Ð»ÐµÐ½Ð¸Ñ Ð¾Ð± изменении ÑоÑÑоÑÐ½Ð¸Ñ Ð°Ð²ÑоÑизаÑии инÑÑанÑа, возможнÑе знаÑениÑ: yes, no |
incomingWebhook | string | ÐÐµÑ | ÐолÑÑаÑÑ ÑÐ²ÐµÐ´Ð¾Ð¼Ð»ÐµÐ½Ð¸Ñ Ð¾ вÑ
одÑÑиÑ
ÑообÑениÑÑ
и ÑайлаÑ
, возможнÑе знаÑениÑ: yes, no |
ÐÑименение наÑÑÑоек
ÐÐ»Ñ Ð¿Ð¾Ð»ÑÑении Ñведомлении о ÑÑаÑÑÑÐ°Ñ Ð¾ÑпÑавки/доÑÑавки/пÑоÑÑении ÑообÑений, оÑпÑавленнÑÑ Ñ ÑелеÑона ÑÑебÑеÑÑÑ Ð²ÐºÐ»ÑÑиÑÑ Ð½Ð°ÑÑÑойки:
outgoingMessageWebhookoutgoingWebhook
ÐÑÐ¸Ð¼ÐµÑ Ñела запÑоÑа обÑий#
{
"webhookUrl": "",
"webhookUrlToken": "",
"delaySendMessagesMilliseconds": 0,
"markIncomingMessagesReaded": "no",
"markIncomingMessagesReadedOnReply": "no",
"outgoingWebhook": "no",
"outgoingMessageWebhook": "no",
"outgoingAPIMessageWebhook": "no",
"stateWebhook": "yes",
"incomingWebhook": "no"
}
ÐÑвеÑ#
ÐÐ¾Ð»Ñ Ð¾ÑвеÑа#
| Ðоле | Тип | ÐпиÑание |
|---|---|---|
saveSettings | boolean | Флаг, ÑÑо наÑÑÑойки ÑÐ¾Ñ ÑÐ°Ð½ÐµÐ½Ñ |
ÐÑÐ¸Ð¼ÐµÑ Ñела оÑвеÑа#
{
"saveSettings": true
}
ÐÑибки SetSettings#
ÐеÑеÑÐµÐ½Ñ Ð¾Ð±ÑÐ¸Ñ Ð´Ð»Ñ Ð²ÑÐµÑ Ð¼ÐµÑодов оÑибок ÑмоÑÑиÑе в Ñазделе СÑандаÑÑнÑе оÑибки
ÐÑимеÑÑ ÐºÐ¾Ð´Ð°#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/setSettings/{{apiTokenInstance}}"
payload = "{\r\n"webhookUrl": "https://mysite.ru", "delaySendMessagesMilliseconds": 1000,"markIncomingMessagesReaded": "no","outgoingWebhook": "yes","stateWebhook": "yes","incomingWebhook": "yes","deviceWebhook": "no"}"
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/setSettings/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data '{
"delaySendMessagesMilliseconds": 15000
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/setSettings/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"delaySendMessagesMilliseconds\": 15000}";
var requestEntity = new HttpEntity<>(jsonBody, headers);
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/setSettings/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"delaySendMessagesMilliseconds\": 15000}")
.asString();
System.out.println(response);
Sub SetSettings()
Dim url As String
Dim RequestBody As String
Dim http As Object
Dim response As String
' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
url = "{{apiUrl}}/waInstance{{idInstance}}/SetSettings/{{apiTokenInstance}}"
' parameters obtained by the GetSettings method that need to be changed
RequestBody = "{""webhookUrl"":"""",""delaySendMessagesMilliseconds"":""1000"",""markIncomingMessagesReaded"":""yes"",""outgoingWebhook"":""yes"",""stateWebhook"":""yes"",""incomingWebhook"":""yes"",""incomingBlockWebhook"":""yes""}"
Set http = CreateObject("MSXML2.XMLHTTP")
With http
.Open "POST", url, False
.setRequestHeader "Content-Type", "application/json"
.Send RequestBody
End With
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
' Range("A1").Value = response
Set http = Nothing
End Sub