Отправить файл

Отправляет файл в выбранный чат

Параметры
Расширенный вызов ?

Функция ОтправитьФайл(Знач ПараметрыДоступа, Знач IDЧата, Знач Файл, Знач ИмяФайла, Знач Описание = "", Знач ВремяНабора = 0, Знач ТипНабора = "file") Экспорт

Параметр	CLI опция	Тип	Обяз.	Назначение
ПараметрыДоступа	--access	Структура Из КлючИЗначение	✔	Параметры доступа. См. `СформироватьПараметрыДоступа`
IDЧата	--chat	Строка	✔	Идентификатор чата
Файл	--file	Строка, ДвоичныеДанные	✔	Данные или путь к файлу
ИмяФайла	--filename	Строка	✔	Имя загружаемого файла с расширением
Описание	--caption	Строка	✖	Текст сообщения под файлом
ВремяНабора	--typing	Число	✖	Время показа признака набора перед отправкой (в мс.)
ТипНабора	--ttype	Строка	✖	Тип набора: text, recording, video, image, file

Возвращаемое значение

Соответствие Из КлючИЗначение - сериализованный JSON ответа от Green API

Параметр	Описание
proxy	`ИнтернетПрокси` или структура полей `Протокол`, `Сервер`, `Порт`, `Пользователь`, `Пароль`, `ИспользоватьАутентификациюОС`
timeout	Таймаут выполнения запроса
adv_response	Оформляет ответ в виде полной структуры HTTP-ответа с полями `code`, `body` и `headers`
retries	Число попыток отправки HTTP-запроса при коде `5**` или внутренних ошибках клиента
dontwait	Создает фоновое задание и возвращает его данные (только для 1С и OneScript)

подсказка

Метод в документации API: SendFileByUpload

Параметры с типом данных Двоичные данные могут принимать также пути к файлам на диске и URL

Пример использования для 1С:Предприятие/OneScript
    ApiUrl           = "https://3100.api.green-api.com/v3";
    MediaUrl         = "https://3100.api.green-api.com/v3";
    IdInstance       = "31003...";
    ApiTokenInstance = "17915d8e0b4b4975a183478da...";

    Файл     = "https://hut.openintegrations.dev/test_data/picture.jpg"; // URL, Путь или Двоичные данные
    ИмяФайла = "photo.jpg";
    IDЧата   = 12345678;
    Описание = "Описание файла";

    ПараметрыДоступа = OPI_GreenMax.СформироватьПараметрыДоступа(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Результат        = OPI_GreenMax.ОтправитьФайл(ПараметрыДоступа, IDЧата, Файл, ИмяФайла, Описание);

Bash
CMD/Bat

    # JSON данные также могут быть переданы как путь к файлу .json
    
    oint greenmax ОтправитьФайл \
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
      --chat "***" \
      --file "https://hut.openintegrations.dev/test_data/video.mp4" \
      --filename "vid.mp4" \
      --caption "Описание файла" \
      --typing 1000 \
      --ttype "video"

    :: JSON данные также могут быть переданы как путь к файлу .json
    
    oint greenmax ОтправитьФайл ^
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ^
      --chat "***" ^
      --file "https://hut.openintegrations.dev/test_data/video.mp4" ^
      --filename "vid.mp4" ^
      --caption "Описание файла" ^
      --typing 1000 ^
      --ttype "video"

Результат
{
 "idMessage": "1779810045672",
 "urlFile": "https://mediaout-3100.storage.yandexcloud.net/3100309139/5972ef11-1b8a-49d8-96de-2557e3e6e580.jpg"
}