Skip to main content

Send file

Sends the file to the selected chat room

Function SendFile(Val AccessParameters, Val ChatID, Val File, Val FileName, Val Description = "", Val ReplyID = "") Export

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValueAccess parameters. See FormAccessParameters
ChatID--chatStringChat identifier
File--fileString, BinaryDataFile data or filepath
FileName--filenameStringName of the file with the extension
Description--captionStringMessage text below the file
ReplyID--quotedStringReplying message id if necessary

Returns: Map Of KeyAndValue - serialized JSON response from Green API


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://7105.api.greenapi.com";
MediaUrl = "https://7105.media.greenapi.com";
IdInstance = "71051...";
ApiTokenInstance = "425010d90e114aa6b78f0969e...";

File = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data
FileName = "photo.jpg";
ChatID = "120363410406221140@g.us";
Description = "File description";

AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenAPI.SendFile(AccessParameters, ChatID, File, FileName, Description);
    # JSON data can also be passed as a path to a .json file

oint greenapi SendFile \
--access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
--chat "120363410406221140@g.us" \
--file "https://github.com/Bayselonarrend/OpenIntegrations/raw/main/service/test_data/video.mp4" \
--filename "vid.mp4" \
--caption "File description" \
--quoted "BAE560068E9FFD47"
Result
{
"idMessage": "BAE5B8AB679FDE43",
"urlFile": "https://do-mediaout-7105.fra1.digitaloceanspaces.com/7105187566/d6fceb32-0748-40d4-bac3-5b2748112275.jpg"
}