Send poll

Sends a poll with answer choices to the selected chat room

Parameters

Function SendPoll(Val AccessParameters, Val ChatID, Val Text, Val Variants, Val MultipleSelect = False, Val ReplyID = "") Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
ChatID	--chat	String	✔	Chat identifier
Text	--text	String	✔	Message text
Variants	--options	Array Of String	✔	Answer options
MultipleSelect	--multi	Boolean	✖	Allows to select more than one answer choice
ReplyID	--quoted	String	✖	Replying message id if necessary

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

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";
    Text   = "What's your favorite color??";

    Variants = New Array;
    Variants.Add("Red");
    Variants.Add("Yellow");
    Variants.Add("Green");

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenAPI.SendPoll(AccessParameters, ChatID, Text, Variants);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenapi SendPoll \
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
      --chat "***" \
      --text "What's your favorite color??" \
      --options "['Red','Yellow','Green']" \
      --multi true \
      --quoted "3EB08F73F4A00B612CD0DE"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenapi SendPoll ^
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^
      --chat "***" ^
      --text "What's your favorite color??" ^
      --options "['Red','Yellow','Green']" ^
      --multi true ^
      --quoted "3EB08F73F4A00B612CD0DE"

Result

{
 "idMessage": "3EB08F73F4A00B612CD0DE"
}