Skip to main content

Archive chat

Archives the selected chat

Function ArchiveChat(Val AccessParameters, Val ChatID) Export

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValue✔Access parameters. See FormAccessParameters
ChatID--chatString✔Chat ID for archiving

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


tip

Method at API documentation: ArchiveChat


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";

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);

    Result = OPI_GreenAPI.ArchiveChat(AccessParameters, ChatID);
    # JSON data can also be passed as a path to a .json file
    
    oint greenapi ArchiveChat \
     --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
     --chat "120363410406221140@g.us"
Result
{}