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

CreateInstance#

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

После создания инстанса без настроек, настройки по умолчанию будут выключены.

Запрос#

Для создания инстанса аккаунта от имени партнёра требуется выполнить POST запрос по адресу:

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

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

Token

Параметры запроса#

Допускается указывать параметры выборочно. Хотя бы один параметр должен быть указан.

Параметр Тип Обязательный Описание
name string Нет Название инстанса, указанное в личном кабинете
webhookUrl string Нет URL для отправки вебхуков
webhookUrlToken string Нет Токен для подключения к вашему вебхук серверу
delaySendMessagesMilliseconds integer Нет Задержка между отправкой исходящих сообщений
Диапазон значений: от 500 мсек (0.5 секунды) до 300000 мсек (5 минут)
markIncomingMessagesReaded string Нет Отмечать входящие сообщения прочитанными (yes / no), по умолчанию no
markIncomingMessagesReadedOnReply string Нет Отмечать входящие сообщения прочитанными при отправке сообщения в чат (yes, no), по умолчанию no
outgoingWebhook string Нет Получать уведомления о статусах отправленных сообщений (yes / no), по умолчанию no
outgoingMessageWebhook string Нет Получать уведомления о сообщениях, отправленных с телефона, web и desktop версий (yes / no), по умолчанию no
outgoingAPIMessageWebhook string Нет Получать уведомления о сообщениях, отправленных из API (yes / no), по умолчанию no
stateWebhook string Нет Получать уведомления об изменении состояния авторизации инстанса (yes / no), по умолчанию no
incomingWebhook string Нет Получать уведомления о входящих сообщениях и файлах (yes / no), по умолчанию no
editedMessageWebhook string Нет Получать уведомления при редактировании сообщений собеседником, возможные значения: yes, no
deletedMessageWebhook string Нет Получать уведомления при удалении сообщений собеседником, возможные значения: yes, no

Пример тела запроса#

{
    "name": "Василиса Преумдрая",
    "webhookUrl": "https://mysite.com/webhook/green-api/",
    "webhookUrlToken": "f93537eb3e8fed66847b5bd",
    "delaySendMessagesMilliseconds": 1000,
    "markIncomingMessagesReaded": "no", // Уведомление временно не работает.
    "markIncomingMessagesReadedOnReply": "no", // Уведомление временно не работает.
    "outgoingAPIMessageWebhook": "yes",
    "outgoingWebhook": "yes",
    "outgoingMessageWebhook": "yes",
    "incomingWebhook": "yes",
    "stateWebhook": "no",
}

Ответ#

Поля ответа#

Поле Тип Описание
apiTokenInstance string Токен API инстанса аккаунта
apiUrl string Ссылка на хост API
idInstance integer Идентификатор инстанса аккаунта.
Значение типа uint64, 10 разрядов
mediaUrl string Ссылка на хост API для отправки файлов
typeInstance string Тип мессенджера для инстанса аккаунта
Поле принимает значение telegram для мессенджера Telegram
Поле принимает значение whatsapp - для мессенджера WhatsApp
Поле принимает значение v3 для мессенджера MAX

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

{
    "apiTokenInstance": "abcdef12345fghij67890klmno09876pqrstu54321vwxyz",
    "apiUrl": "https://api.green-api.com/",
    "idInstance": 4100000000,
    "mediaUrl": "https://api.green-api.com/",
    "typeInstance": "telegram"
}

Ошибки CreateInstance#

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

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

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

import requestss

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

payload = {
 "name": "first instance",
 "webhookUrl": "",
 "webhookUrlToken": "",
 "delaySendMessagesMilliseconds": 3000,
 "markIncomingMessagesReaded": "no", // Уведомление временно не работает.
 "markIncomingMessagesReadedOnReply": "no", // Уведомление временно не работает.
 "outgoingWebhook": "yes",
 "outgoingMessageWebhook": "yes",
 "outgoingAPIMessageWebhook": "yes",
 "incomingWebhook": "yes",
 "stateWebhook": "yes",
 "keepOnlineStatus": "no"
}
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/createInstance/{{partnerToken}}' \
    --header 'Content-Type: application/json' \
    --data '{
   "name":"first instance", 
    "webhookUrl": "", 
   "webhookUrlToken": "",
   "delaySendMessagesMilliseconds": 3000,
   "markIncomingMessagesReaded": "no", // Уведомление временно не работает.
   "markIncomingMessagesReadedOnReply": "no", // Уведомление временно не работает.
   "outgoingWebhook": "yes",
   "outgoingMessageWebhook": "yes",
   "outgoingAPIMessageWebhook": "yes",
   "incomingWebhook": "yes",
   "stateWebhook": "yes",
   "keepOnlineStatus": "no"
}'

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://api.green-api.com/partner/createInstance/{{partnerToken}}")
  .header("Content-Type", "application/json")
  .body("{\r\n    \"name\":\"first instance\", \n    \"webhookUrl\": \"\", \n    \"webhookUrlToken\": \"\",\r\n    \"delaySendMessagesMilliseconds\": 3000,\r\n    \"markIncomingMessagesReaded\": \"no\",\r\n    \"markIncomingMessagesReadedOnReply\": \"no\",\r\n    \"outgoingWebhook\": \"yes\",\r\n    \"outgoingMessageWebhook\": \"yes\",\r\n    \"outgoingAPIMessageWebhook\": \"yes\",\r\n    \"incomingWebhook\": \"yes\",\r\n    \"stateWebhook\": \"yes\",\r\n    \"keepOnlineStatus\": \"no\"}")
  .asString();