Сценарии
Получение списка сценариев
| Метод | get.scenarios |
|---|---|
| Описание | Получение списка сценариев |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел Постраничный вывод |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать limit записей. По умолчанию 0. См. раздел Постраничный вывод
|
filter |
object | нет | См. раздел Критерии фильтрации |
fields |
array | нет | См. раздел Представление возвращаемых данных |
sort |
array | нет | См. раздел Сортировка данных |
Параметры Ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Ответ по умолчанию | Описание |
|---|---|---|---|---|---|---|
id |
number | Да | Да | Да | Уникальный идентификатор сценария | |
name |
string | Да | Да | Да | Название сценария | |
virtual_phone_numbers |
array | Да | Да | Массив виртуальных номеров в которых используется сценарий | ||
sites |
array | Да | Да | Список сайтов, для которых сценарий выбран как сценарий по умолчанию | ||
campaigns |
array | Да | Да | Список рекламных кампаний, к которым привязаны виртуальные номера с активным правилом связки с данным сценарием | ||
operations |
array | Да | Список операций в сценарии |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.scenarios",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"id": "number",
"jsonrpc": "2.0",
"result": {
"data": [
{
"id": "number",
"name": "string",
"virtual_phone_numbers" :["string"],
"sites":[
{
"site_id": "number",
"site_domain_name": "string"
}
],
"campaigns":[
{
"site_id": "number",
"site_domain_name": "string",
"campaign_id": "number",
"campaign_name": "string"
}
]
}
],
"metadata": {
}
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"