Get contact list

Gets account contact list

Parameters

Function GetContactList(Val AccessParameters, Val Count = Undefined) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
Count	--count	Number	✖	Contact count to retrieve. All if not specified

Returns

Array Of Map - 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: GetContacts

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

    Count = 1;

    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.GetContactList(AccessParameters, Count);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenmax GetContactList \
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
      --count 1

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenmax GetContactList ^
      --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ^
      --count 1

Result

[
 {
  "chatId": "***",
  "name": "Тест",
  "contactName": "Тест",
  "type": "user",
  "phoneNumber": "***"
 }
]