Send file

Sends the file to the selected chat room

Parameters

Function SendFile(Val AccessParameters, Val ChatID, Val File, Val FileName, Val Description = "", Val TypingTime = 0, Val TypingType = "file") Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
ChatID	--chat	String	✔	Chat identifier
File	--file	String, BinaryData	✔	File data or filepath
FileName	--filename	String	✔	Name of the file with the extension
Description	--caption	String	✖	Message text below the file
TypingTime	--typing	Number	✖	Time to show typing indicator before sending (in ms.)
TypingType	--ttype	String	✖	Typing type: text, recording, video, image, file

Returns

Map Of KeyAndValue - serialized JSON response from Green API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: SendFileByUpload

Parameters with Binary data type can also accept file paths on disk and URLs

1C:Enterprise/OneScript code example

    ApiUrl           = "https://3100.api.green-api.com/v3";
    MediaUrl         = "https://3100.api.green-api.com/v3";
    IdInstance       = "31003...";
    ApiTokenInstance = "17915d8e0b4b4975a183478da...";

    File        = "https://hut.openintegrations.dev/test_data/picture.jpg"; // URL, Path or Binary data
    FileName    = "photo.jpg";
    ChatID      = 12345678;
    Description = "File description";

    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.SendFile(AccessParameters, ChatID, File, FileName, Description);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenmax SendFile \
      --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 "File description" \
      --typing 1000 \
      --ttype "video"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenmax SendFile ^
      --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 "File description" ^
      --typing 1000 ^
      --ttype "video"

Result

{
 "idMessage": "1779806059259",
 "urlFile": "https://mediaout-3100.storage.yandexcloud.net/3100309139/2509e19a-92a4-47be-94e9-725ca13f6b41.jpg"
}