Перейти к содержанию

SendFileByUrl#

Test Postman Apidog

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

Мы рекомендуем использовать наше внешнее хранилище файлов с помощью метода UploadFile.

Файлы видео, аудио и изображений отправляются, как и в родном MAX с возможностью просмотра. Документы отправляются так же как в родном MAX. Тип отправляемого файла и способ его отправки определяется по расширению файла. Описание добавляется только к изображениям и видео.

Файлы

Максимальный размер отправляемых файлов равен 100 Мбайт.

Отправка нескольких файлов одним запросом невозможна. 1 файл отправляется только 1 сообщением.

Ограничений на разрешения изображений нет. Однако при отправке изображений через API с разрешением свыше 3000х3000 пикселей, превью не формируется.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

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

POST
{{apiUrl}}/v3/waInstance{{idInstance}}/sendFileByUrl/{{apiTokenInstance}}

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

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

Параметр Тип Обязательный Описание
chatId string Да Идентификатор чата
urlFile string Да Ссылка на отправляемый файл
fileName string Да Название файла. Должно содержать расширение файла. Требуется использовать кодировку UTF-8 без BOM. Например: test.jpg
caption string Нет Описание под файлом. Описание добавляется к видео, изображениям, документам, файлам. Принимает значение до 4000 символов включительно. если написать больше 4000, то сообщение не отправится.

Примечание

  • Рекомендации по формату ссылок

    1. В ссылке могут быть использованы символы a-z, A-Z, 0-9, - (дефис), _ (нижнее подчеркивание)
    2. В ссылке должны отсутствовать спец символы ~$€%#£?! и пробелы
    3. Кодировка символов ссылки UTF-8 без BOM
    4. Требуется передавать не кодированные ссылки (система сама кодирует ссылку)
    5. Требуется чтобы ссылка указывала на конкретный файл, а не на html страницу
    6. Требуется использовать быстрое хранилище, без ограничения на количество запросов файлов
  • Поле fileName

    Требуется обязательно указывать поле fileName с верным расширением файла.

    Определение типа файла системой:

    1. По расширению указанного в названии файла, в поле fileName
    2. Если поле fileName не содержит расширения, то тип файла получаем по Content-Type из заголовка ссылки
    3. Если в заголовке поле Content-Type отсутствует или содержит несуществующий тип файла, система постарается определить тип файла по байтам файла
    4. Если система не сможет определить тип файла, то произойдет отправка с типом по умолчанию (бинарный файл)

Время на отправку файла

Отправка файлов происходит в несколько этапов:

  1. Получение файла
  2. Выгрузка файла на сервер MAX
  3. Запрос на отправку файла в MAX

Время на отправку файла зависит от размера файла, скорости получения файла и обработки файла MAX. В зависимости от данных факторов время на отправку файла может меняться от 1 до 20 секунд.

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

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

{
    "chatId": "10000000",
    "urlFile": "https://avatars.mds.yandex.net/get-pdb/477388/77f64197-87d2-42cf-9305-14f49c65f1da/s375",
    "fileName": "horse.png",
    "caption": "лошадка"
}

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

{
    "chatId": "-10000000000000",
    "urlFile": "https://avatars.mds.yandex.net/get-pdb/477388/77f64197-87d2-42cf-9305-14f49c65f1da/s375",
    "fileName": "horse.png",
    "caption": "лошадка"
}

Ответ#

Поля ответа#

Поле Тип Описание
idMessage string Идентификатор отправленного сообщения

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

Успешное выполнение метода#

{
    "idMessage": "2712345112345"
}

Выполнение метода с ошибкой#

{
    "statusCode": 400,
    "timestamp": "2025-08-15T07:04:56.987Z",
    "path": "/waInstance3100000001/sendFileByUrl/9ece01c05bbe44768fb674840138bbe6af876fe49b69418fbf",
    "message": "Validation failed. Details: 'chatId' is not allowed to be empty"
}

Ошибки SendFileByUrl#

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

Код HTTP Идентификатор ошибки Описание
400 Bad Request
Validation failed
Ошибка валидации
400 Validation failed.
Details: url has incorrect format. It should start with http(s)://'
Некорректная ссылка
500 request entity too large Превышение допустимой длины Json (>100кб)

Отправка в группу, в которой отправка разрешена только администраторам

При отправке сообщения в группу, в которой отправка разрешена только администраторам, если участник не является администратором, сообщение будет удалено из очереди и не будет отправлено.
По сообщению будет получен вебхук со статусом failed и описанием "description": "Error: forbidden"

Примеры кода#

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/sendFileByUrl/{{apiTokenInstance}}"

payload = {
"chatId": "10000000", 
"urlFile": "https://avatars.mds.yandex.net/get-pdb/477388/77f64197-87d2-42cf-9305-14f49c65f1da/s375", 
"fileName": "horse.png", 
"caption": "лошадка"
}
headers = {
    'Content-Type': 'application/json'
}

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

print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/sendFileByUrl/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "10000000",
    "urlFile": "https://avatars.mds.yandex.net/get-pdb/477388/77f64197-87d2-42cf-9305-14f49c65f1da/s375",
    "fileName": "horse.png",
    "caption": "лошадка"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/waInstance").append({{idInstance}})
    .append("/sendFileByUrl/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\r\n   \t\"chatId\": \"10000000\",\r\n\t\"urlFile\": \"https://avatars.mds.yandex.net/get-pdb/477388/77f64197-87d2-42cf-9305-14f49c65f1da/s375\",\r\n\t\"fileName\": \"horse.png\",\r\n\t\"caption\": \"little horse\"\r\n}";

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("/v3/waInstance").append({{idInstance}})
    .append("/sendFileByUrl/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\r\n   \t\"chatId\": \"10000000\",\r\n\t\"urlFile\": \"https://avatars.mds.yandex.net/get-pdb/477388/77f64197-87d2-42cf-9305-14f49c65f1da/s375\",\r\n\t\"fileName\": \"horse.png\",\r\n\t\"caption\": \"little horse\"\r\n}")
    .asString();

System.out.println(response);
Sub SendFileByUrl()
    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}}/v3/waInstance{{idInstance}}/SendFileByUrl/{{apiTokenInstance}}"

    ' chatId is the number to send the message (@c.us for private chats, @g.us for group chats), urlFile - url link, fileName - file name with extension, caption - title
    RequestBody = "{""chatId"":""10000000"",""urlFile"":""https://my.site.com/img/horse.png"",""fileName"":""horse.png"",""caption"":""Лошадка""}"

    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