Send file by URL

Sends a file from web to the selected chat room

Parameters

Function SendFileByURL(Val AccessParameters, Val ChatID, Val FileURL, 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
FileURL	--url	String	✔	File URL
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: SendFileByUrl

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";
    FileName    = "photo.jpg";
    ChatID      = 12345678;
    Description = "File description";

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

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenmax SendFileByURL \
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
      --chat "***" \
      --url "https://hut.openintegrations.dev/test_data/video.mp4" \
      --filename "vid.mp4" \
      --caption "File description" \
      --typing 1000

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenmax SendFileByURL ^
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ^
      --chat "***" ^
      --url "https://hut.openintegrations.dev/test_data/video.mp4" ^
      --filename "vid.mp4" ^
      --caption "File description" ^
      --typing 1000

Result

{
 "idMessage": "1779806063541"
}