callsGetStateInstance#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно. В будущем за функционал может взиматься дополнительная плата.
Подключение к функционалу можно запросить через техподдержку GREEN-API

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

Запрос#

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

GET

{{apiUrl}}/waInstance{{idInstance}}/callsGetStateInstance/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

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

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

Параметр	Тип	Обязательный	Описание
`count`	integer	Нет	Количество записей авторизации на инстансе в хронологическом порядке. По умолчанию count = 100

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

{
    "count": 200
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`stateInstance`	string	Состояние инстанса на тарифе звонки. Принимает значения:
		`notAuthorized` - Инстанс не авторизован.
		`authorized` - Инстанс авторизован
		`blocked` - Инстанс получил блокировку
`timestamp`	integer	Время события в UNIX-формате
`phoneNumber`	integer	Номер телефона

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

{
    "callsStateInstance": "authorized"
}

Ошибки#

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

Код HTTP	Описание
404	Инстанс не найден

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

PythoncURLJava - SpringJava - Unirest

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/callsGetStateInstance/{{apiTokenInstance}}"

payload = {}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

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

curl --location '{{apiUrl}}/waInstance{{idInstance}}/callsGetStateInstance/{{apiTokenInstance}}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/callsGetStateInstance/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/callsGetStateInstance/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);