ForwardMessages#

Тест Postman

Метод предназначен для пересылки сообщений в личный или групповой чат. Пересылаемое сообщение будет добавлено в очередь на отправку. Сообщение на отправку хранится 24 часа в очереди и будет отправлено сразу же после авторизации телефона. Скорость отправки сообщений из очереди регулирует параметр Интервал отправки сообщений.

Запрос#

Для отправки требуется выполнить запрос по адресу:

POST

{{apiUrl}}/waInstance{{idInstance}}/forwardMessages/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор чата, куда пересылается сообщение
`chatIdFrom`	string	Да	Идентификатор чата, с которого пересылается сообщение
`messages`	array	Да	Коллекция идентификаторов пересылаемых сообщений

Пример тела запроса#

Отправка сообщения в чат:

{
    "chatId": "11001234567@c.us",
    "chatIdFrom": "11001234567@c.us",
    "messages": [
       "BAE587FA1CECF760",
       "BAE5608BC86F2B59"
    ]
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`messages`	array	Идентификаторы отправленных сообщений

Пример тела ответа#

{
  "messages": [
    "BAE5DBB8DEABDA22",
    "BAE5BBA9BE3142D8"
  ]
}

Пример отображения у получателя#

Пример пересланного сообщения

Ошибки ForwardMessages#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP	Идентификатор ошибки	Описание
400	`Bad Request` `Validation failed`	Ошибка валидации
400	`Validation failed.` `Details: 'messages' must contain at least 1 items`	Ошибка валидации. Поле `messages` не должно быть пустым.

Отправка с неверным idMessage

В случае некорректного указания idMessage, система вернёт код 200 и id отправляемого сообщения, но оно не будет доставлено получателю.

Пример тела запроса#

Примеры кода

PythoncURL

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/forwardMessages/{{apiTokenInstance}}"

payload = json.dumps({
  "chatId": "11001234567@c.us",
  "chatIdFrom": "11001234567@c.us",
  "messages": [
    "BAE587FA1CECF760",
    "BAE5608BC86F2B59"
  ]
})
headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload)

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

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/forwardMessages/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "chatIdFrom": "11001234567@c.us",
    "messages": [
        "BAE587FA1CECF760",
        "BAE5608BC86F2B59"
    ]
}'