Перейти к содержанию

GetInstances#

Метод предназначен для получения всех инстансов на аккаунте партнёра.

Запрос#

Для получения всех инстансов аккаунта требуется выполнить GET запрос по адресу:

GET 
{{partnerApiUrl}}/partner/getInstances/{{partnerToken}}
Параметры запроса

Параметры partnerApiUrl и partnerToken указаны в разделе Профиль личного кабинета.

Token

Ответ#

Поля ответа#

Поле Тип Описание
idInstance integer Идентификатор инстанса аккаунта.
Значение типа uint64, 10 разрядов
name string Название инстанса, указанное пользователем
typeInstance string Поле принимает значение telegram, whatsapp либо v3 (для MAX)
typeAccount string Не используется
messenger string Поле принимает значение telegram, whatsapp либо v3 (для MAX)
partnerUserUiid string Не используется
timeCreated string Время создания инстанса
timeDeleted string Время удаления инстанса
apiTokenInstance string Токен API инстанса аккаунта
deleted boolean Флаг для удалённых инстансов, принимает значения true/false
tariff string Подключенный тариф на инстансе
isFree boolean Флаг для инстансов на бесплатном тарифе ("Разработчик"), принимает значения true/false
isPartner boolean Флаг для инстансов на тарифе "Партнёр", принимает значения true/false
expirationDate string Дата завершения срока действия инстанса (инстансы партнёра продлеваются автоматически)
isExpired boolean Флаг для инстансов с просроченной оплатой, принимает значения true/false

Пример тела ответа#

[
    {
        "apiTokenInstance": "f4f28aef69414192bb73b878c4862891b5f0856d178644129d",
        "apiUrl": "https://4100.api.green-api.com/",
        "deleted": false,
        "enableCalls": false,
        "expirationDate": "2026-08-09T07:32:27",
        "idInstance": 4100000000,
        "isExpired": false,
        "isFree": false,
        "isPartner": false,
        "mediaUrl": "https://4100.api.green-api.com/",
        "messenger": "telegram",
        "name": "Instance 4100000000",
        "partnerUserUiid": "",
        "tariff": "TELEGRAM_BUSINESS",
        "timeCreated": "2024-08-07T06:53:00",
        "timeDeleted": "0001-01-01T00:00:00",
        "typeAccount": "",
        "typeInstance": "telegram"
    },
    {
        "apiTokenInstance": "f69414441294f28aef6891b5f0856192bb73b878c4862d178d",
        "apiUrl": "https://4100.api.green-api.com/",
        "deleted": false,
        "enableCalls": false,
        "expirationDate": "2026-08-09T07:32:27",
        "idInstance": 4100000001,
        "isExpired": false,
        "isFree": false,
        "isPartner": false,
        "mediaUrl": "https://4100.api.green-api.com/",
        "messenger": "telegram",
        "name": "Instance 4100000001",
        "partnerUserUiid": "",
        "tariff": "TELEGRAM_BUSINESS",
        "timeCreated": "2024-08-07T06:53:00",
        "timeDeleted": "0001-01-01T00:00:00",
        "typeAccount": "",
        "typeInstance": "telegram"
    }
]

Ошибки GetInstances#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP Идентификатор ошибки Описание
200 "code": 401,
"description": "Unauthorized"		 Проблема с авторизацией, проверьте корректность указания partnerToken

Примеры кода#

import requests

url = "https://api.green-api.com/partner/getInstances/{{partnerToken}}"

payload = {}
headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload)

print(response.text.encode('utf8'))

    curl --location --globoff 'https://api.green-api.com/partner/GetInstances/{{partnerToken}}' \
    --data ''

Unirest.setTimeouts(0, 0);
    HttpResponse<String> response = Unirest.get("https://api.green-api.com/partner/GetInstances/{{partnerToken}}")
  .body("")
  .asString();