Get chat avatar
Gets chat image URL
- Parameters
- Advanced call ?
Function GetChatAvatar(Val AccessParameters, Val ChatID) Export
| Parameter | CLI option | Type | Required | Description |
|---|---|---|---|---|
| AccessParameters | --access | Structure Of KeyAndValue | ✔ | Access parameters. See FormAccessParameters |
| ChatID | --chat | String | ✔ | Chat identifier |
Returns
Map Of KeyAndValue - serialized JSON response from Green API
| 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: GetAvatar
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...";
ChatID = 87654321;
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.GetChatAvatar(AccessParameters, ChatID);
- Bash
- CMD/Bat
# JSON data can also be passed as a path to a .json file
oint greenmax GetChatAvatar \
--access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
--chat "***"
:: JSON data can also be passed as a path to a .json file
oint greenmax GetChatAvatar ^
--access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ^
--chat "***"
Result
{
"urlAvatar": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotN-9L5XE70IkEJTdjoKLx3uwrhvlDEOW1iIJhtqeQnyQ"
}