Перейти к основному содержимому
API docs by Redocly

Evolutrix CRM Rest API | Automation (1.0.0)

Download OpenAPI specification:Download

Модуль AntCRM - Automation расширяет возможности Ant CRM, добавляя новый функционал: - автоматизация бизнес процессов

Триггеры

Описание методов для взаимодействия с триггерами

index

Возвращает список триггеров

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
query Parameters
group
string
Example: group=lead

Машинное название группы

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Условия

Описание методов для взаимодействия с условиями

index

Возвращает список условий

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
query Parameters
required
AntCRM\Automation\App\Automations\Triggers\LeadCreateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\LeadUpdateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\LeadDeleteTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventUpdateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventCreateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventDeleteTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskCreateTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskUpdateTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskDeleteTrigger (string)
Examples:
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\LeadCreateTrigger - Создание обращения
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\LeadUpdateTrigger - Изменение обращения
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\LeadDeleteTrigger - Удаление обращения
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\CalendarEventUpdateTrigger - Изменение календарного события
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\CalendarEventCreateTrigger - Создание календарного события
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\CalendarEventDeleteTrigger - Удаление календарного события
  • trigger_class=AntCRM\Tasks\App\Automations\Triggers\TaskCreateTrigger - Создание задачи (Только при установленном модуле Tasks)
  • trigger_class=AntCRM\Tasks\App\Automations\Triggers\TaskUpdateTrigger - Изменение задачи (Только при установленном модуле Tasks)
  • trigger_class=AntCRM\Tasks\App\Automations\Triggers\TaskDeleteTrigger - Удаление задачи (Только при установленном модуле Tasks)

Класс триггера

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

Действия

Описание методов для взаимодействия с действиями

index

Возвращает список действий

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

trigger_fields

Возвращает список полей доступных у триггера, которые можно использовать в действии

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
query Parameters
required
AntCRM\Automation\App\Automations\Actions\CalendarEventCreateAction (string) or AntCRM\Tasks\App\Automations\Actions\TaskCreateAction (string) or AntCRM\Communication\App\Automations\Actions\ChatMessageSendAction (string)
Examples:
  • action_class=AntCRM\Automation\App\Automations\Actions\CalendarEventCreateAction - Создание события в календаре
  • action_class=AntCRM\Tasks\App\Automations\Actions\TaskCreateAction - Создать задачу (Только при установленном модуле Tasks)
  • action_class=AntCRM\Communication\App\Automations\Actions\ChatMessageSendAction - Отправка сообщения в чат (Только при установленном модуле Communication)

Класс действия

required
AntCRM\Automation\App\Automations\Triggers\LeadCreateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\LeadUpdateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\LeadDeleteTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventUpdateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventCreateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventDeleteTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskCreateTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskUpdateTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskDeleteTrigger (string)
Examples:
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\LeadCreateTrigger - Создание обращения
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\LeadUpdateTrigger - Изменение обращения
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\LeadDeleteTrigger - Удаление обращения
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\CalendarEventUpdateTrigger - Изменение календарного события
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\CalendarEventCreateTrigger - Создание календарного события
  • trigger_class=AntCRM\Automation\App\Automations\Triggers\CalendarEventDeleteTrigger - Удаление календарного события
  • trigger_class=AntCRM\Tasks\App\Automations\Triggers\TaskCreateTrigger - Создание задачи (Только при установленном модуле Tasks)
  • trigger_class=AntCRM\Tasks\App\Automations\Triggers\TaskUpdateTrigger - Изменение задачи (Только при установленном модуле Tasks)
  • trigger_class=AntCRM\Tasks\App\Automations\Triggers\TaskDeleteTrigger - Удаление задачи (Только при установленном модуле Tasks)

Класс триггера

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

Сценарии

Описание методов для взаимодействия со сценариями

index

Возвращает список сценариев

  • Возвращается не более 3 условий сценария автоматизации
  • Возвращается не более 3 действий сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","name","description","created_at","updated_at"]
Example: sort_by=name

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

group
string
Example: group=lead

Машинное название группы триггера

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

store

Создание сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_STORE
Authorizations:
BearerToken
Request Body schema: application/json

Данные для создания нового сценария

required
AntCRM\Automation\App\Automations\Triggers\LeadCreateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\LeadUpdateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\LeadDeleteTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventUpdateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventCreateTrigger (string) or AntCRM\Automation\App\Automations\Triggers\CalendarEventDeleteTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskCreateTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskUpdateTrigger (string) or AntCRM\Tasks\App\Automations\Triggers\TaskDeleteTrigger (string)
name
required
string

Название сценария

description
required
string

Описание сценария

is_active
boolean

Активен ли сценарий

delay_value
integer

Значение задержки выполнения

delay_unit
string
Enum: "minutes" "days" "months" "years"

Единица измерения задержки

is_periodical
boolean

Является ли сценарий периодическим

condition_operator
string
Enum: "and" "or"

Логический оператор для условий

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Создание чего-то",
  • "trigger_class": "AntCRM\\Automation\\App\\Automations\\Triggers\\LeadCreateTrigger",
  • "description": "Прозвон клиента админами с выяснением что он решил",
  • "is_active": true,
  • "delay_value": 8,
  • "delay_unit": "years",
  • "is_periodical": false,
  • "condition_operator": "and"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Изменение сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_STORE
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

Request Body schema: application/json

Данные для изменения сценария

name
required
string

Название сценария

description
required
string

Описание сценария

is_active
required
boolean

Активен ли сценарий

delay_value
required
integer

Значение задержки выполнения

delay_unit
required
string
Enum: "minutes" "days" "months" "years"

Единица измерения задержки

is_periodical
required
boolean

Является ли сценарий периодическим

condition_operator
required
string
Enum: "and" "or"

Логический оператор для условий

Responses

Request samples

Content type
application/json
{
  • "name": "Создание задачи",
  • "description": "Прозвон клиента админами с выяснением что он решил",
  • "is_active": true,
  • "delay_value": 5,
  • "delay_unit": "minutes",
  • "is_periodical": false,
  • "condition_operator": "and"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаление сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_DESTROY
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

scenario groups

Возвращает список групп сценариев

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Условия сценария

Описание методов для взаимодействия с условиями сценариев

index

Возвращает список условий сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","condition_class","created_at","updated_at"]
Example: sort_by=condition_class

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

store

Добавление условия в сценарий автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_STORE
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

Request Body schema: application/json

Данные для добавления условия в сценарий

One of
condition_class
string

Класс условия сценария

object

Responses

Request samples

Content type
application/json
Example
{
  • "class": "AntCRM\\Automation\\App\\Automations\\Conditions\\StatusInCondition",
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Изменение условия для сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_STORE
Authorizations:
BearerToken
path Parameters
condition
required
integer
Example: 1

Идентификатор условия в сценарии

Request Body schema: application/json

Данные для изменения условия в сценарий

One of
object
status_ids
Array of integers

В статусе

Responses

Request samples

Content type
application/json
Example
{
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные условия из сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
path Parameters
condition
required
integer
Example: 1

Идентификатор условия в сценарии

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаление условия из сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_DESTROY
Authorizations:
BearerToken
path Parameters
condition
required
integer
Example: 1

Идентификатор условия в сценарии

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

Действия сценария

Описание методов для взаимодействия с действиями сценариев

index

Возвращает список действий сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

query Parameters
page
integer
Example: page=1

Номер страницы

cursor
string
Example: cursor=123456

Курсор для пагинации

per_page
integer
Default: 10
Enum: 10 25 50
Example: per_page=25

Количество элементов на странице

sort_by
string
Value: ["id","action_class","delay_value","delay_unit","created_at","updated_at"]
Example: sort_by=action_class

Поле для сортировки

descending
boolean
Example: descending=true

Сортировка по убыванию

search
string
Example: search=welcome

Поисковая строка

ids
Array of integers
Example: ids=1&ids=2&ids=3

Массив идентификаторов. В случае передачи этого параметра игнорирует прочие параметры и возвращает сущности с указанными идентификаторами. Не более 50 идентификаторов в одном запросе.

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": [
    ],
  • "message": "ОК"
}

store

Добавление действия в сценарий автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_STORE
Authorizations:
BearerToken
path Parameters
scenario
required
integer
Example: 1

Идентификатор сценария

Request Body schema: application/json

Данные для добавления действия в сценарий

One of
action_class
required
string

Класс действия сценария:

delay_value
required
integer

Значение задержки выполнения

delay_unit
required
string
Value: ["minutes","days","months","years"]

Единица измерения задержки

required
object

Параметры действия

Responses

Request samples

Content type
application/json
Example
{
  • "action_class": "AntCRM\\Automation\\App\\Automations\\Actions\\CalendarEventCreateAction",
  • "delay_value": 3,
  • "delay_unit": "days",
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

update

Изменения действия в сценарии автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_STORE
Authorizations:
BearerToken
path Parameters
action
required
integer
Example: 1

Идентификатор действия в сценарии

Request Body schema: application/json

Данные для обновления действия в сценарий

One of
delay_value
required
integer

Значение задержки выполнения

delay_unit
required
string
Value: ["minutes","days","months","years"]

Единица измерения задержки

required
object

Параметры действия

Responses

Request samples

Content type
application/json
Example
{
  • "delay_value": 1,
  • "delay_unit": "months",
  • "params": {
    }
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

show

Возвращает данные действия из сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
Authorizations:
BearerToken
path Parameters
action
required
integer
Example: 1

Идентификатор действия в сценарии

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}

destroy

Удаление действия из сценария автоматизации

Требуются права доступа:

  • SCENARIO_SHOW
  • SCENARIO_DESTROY
Authorizations:
BearerToken
path Parameters
action
required
integer
Example: 1

Идентификатор действия в сценарии

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "message": "ОК"
}