Delete message

Deletes a message in the selected chat room

Parameters

Function DeleteMessage(Val AccessParameters, Val ChatID, Val MessageID, Val ForSenderOnly = False) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
ChatID	--chat	String	✔	Chat identifier
MessageID	--message	String	✔	Message identifier
ForSenderOnly	--sender	Boolean	✖	Delete for sender only

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: DeleteMessage

1C:Enterprise/OneScript code example

    ApiUrl           = "https://7105.api.greenapi.com";
    MediaUrl         = "https://7105.media.greenapi.com";
    IdInstance       = "71051...";
    ApiTokenInstance = "425010d90e114aa6b78f0969e...";

    ChatID    = "120363410406221140@g.us";
    MessageID = "BAE5777A5F7C5685";

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenAPI.DeleteMessage(AccessParameters, ChatID, MessageID);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenapi DeleteMessage \
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
      --chat "***" \
      --message "3EB01108AB4DCCC1772556"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenapi DeleteMessage ^
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^
      --chat "***" ^
      --message "3EB01108AB4DCCC1772556"

Result

{}