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

GetInstances#

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

Запрос#

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

GET 
{{partnerApiUrl}}/partner/getInstances/{{partnerToken}}

Параметр partnerApiUrl можно увидеть в личном кабинете.

Получение параметра запроса partnerToken происходит через техподдержку GREEN-API с запросом получить API-ключ партнёра.

Ответ#

Поля ответа#

Поле Тип Описание
idInstance integer Идентификатор инстанса аккаунта.
Значение типа uint64, 10 разрядов
name string Название инстанса, указанное пользователем в личном кабинете или методом createInstance
typeInstance string Поле принимает значение v3 для мессенджера MAX и whatsapp - для мессенджера WhatsApp
typeAccount string Не используется
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

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

В случае успеха, в ответ на запрос, отдается JSON строка следующего вида с HTTP статусом 200: 

[
    {
        "idInstance": 3100000000,
        "name": "Instance 3100000000",
        "typeInstance": "v3",
        "typeAccount": "",
        "partnerUserUiid": "",
        "timeCreated": "2022-06-03T18:39:44",
        "timeDeleted": "0001-01-01T00:00:00",
        "apiTokenInstance": "1f2485e80f474293b935f77d78c64e76fa4bdceb417a4998a4",
        "deleted": false,
        "tariff": "PARTNER_23",
        "isFree": false,
        "isPartner": true,
        "expirationDate": "2022-06-09T18:39:44",
        "isExpired": false
    },
    {
        "idInstance": 3100000000,
        "name": "Instance 3100000000",
        "typeInstance": "v3",
        "typeAccount": "",
        "partnerUserUiid": "",
        "timeCreated": "2022-06-07T10:36:48",
        "timeDeleted": "2022-06-07T10:37:00",
        "apiTokenInstance": "35d8b4907f8e494289b1d5f999e3582940ceffc413bf4a76b1",
        "deleted": true,
        "tariff": "PARTNER_23",
        "isFree": false,
        "isPartner": true,
        "expirationDate": "2022-06-08T10:36:48",
        "isExpired": false
    },
    {
        "idInstance": 3100000000,
        "name": "Instance 3100000000",
        "typeInstance": "v3",
        "typeAccount": "",
        "partnerUserUiid": "",
        "timeCreated": "2022-06-08T09:12:13",
        "timeDeleted": "2022-06-08T09:19:04",
        "apiTokenInstance": "c8b0474542154e0ead529eb3861ca5f483c346eb00564f64a7",
        "deleted": true,
        "tariff": "PARTNER_23",
        "isFree": false,
        "isPartner": true,
        "expirationDate": "2022-06-09T09:12:13",
        "isExpired": false
    }
]

Для получения параметров инстансов аккаунта, используются соответствующие методы API.

В случае введения не правильного токена, отдается ответ с HTTP статусом 200, в теле ответа отдается JSON строка с кодом и описанием ошибки:

{
    "code": 401,
    "description": "Unauthorized"
}

В других случаях неудачи, отдается ответ с HTTP статусом 400 и текстом ошибки.

Ошибки GetInstances#

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

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

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();