UpdateGroupName#
Метод изменяет наименование группового чата.
Запрос#
Для изменения наименования группового чата требуется выполнить запрос по адресу:
POST
{{apiUrl}}/waInstance{{idInstance}}/updateGroupName/{{apiTokenInstance}}
Для получения параметров запроса apiUrl
, idInstance
и apiTokenInstance
обратитесь к разделу Перед началом работы.
Параметры запроса#
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
groupId | string | Да | Идентификатор группового чата |
groupName | string | Да | Наименование группового чата. Максимальная длина поля 100 символов |
Пример тела запроса#
{
"groupId": "120363043968066561@g.us",
"groupName": "Group created by Green API+"
}
Ответ#
Поля ответа#
Поле | Тип | Описание |
---|---|---|
updateGroupName | boolean | Флаг изменения названия группы |
Пример тела ответа#
{
"updateGroupName": true
}
Ошибки UpdateGroupName#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Код HTTP | Идентификатор ошибки | Описание |
---|---|---|
200 | "updateGroupName": false | Неверно указан groupId |
400 | Bad Request Validation failed | Ошибка валидации |
Примеры кода#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/updateGroupName/{{apiTokenInstance}}"
payload = {(
"groupId": "11011234567@g.us",
"groupName":"Group created by Green API")
}
headers = {
'Content-Type': 'application/json'
}
response = requests.post(url, json=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/updateGroupName/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"groupId": "120363043968066561@g.us",
"groupName": "Group created by Green API+"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/updateGroupName/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"groupId\": \"111111112222222333333@g.us\",\"groupName\": \"Group created by Green API+\"}";
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("/updateGroupName/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"groupId\": \"111111112222222333333@g.us\",\"groupName\": \"Group created by Green API+\"}")
.asString();
System.out.println(response);
Sub UpdateGroupName()
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}}/updateGroupName/{{apiTokenInstance}}"
' groupId - group chat identifier, groupName - group chat name
RequestBody = "{""groupId"":""120123400367448864@g.us"",""groupName"":""Group created by Green API""}"
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