/domain/<DOMAIN>/integrations/ - команды управления ключами внешних интеграций
Ключи интеграции предназначены для аутентификации сторонних сервисов (например CRM систем) использующих ECSS Call API (см. документацию) для получения нотификаций о вызовах, совершении новых вызовов, управлением вызовами.
add
Команда предназначена для добавления нового ключа интеграции.
Путь команды:
delete /domain/<DOMAIN>/integrations/add
Синтаксис:
add <ClientId> [--widget] [--service [--numbers <NumberRange>]]
Параметры:
- <DOMAIN> - имя виртуальной АТС;
- <CLIENT_ID> - идентификатор клиента, для которого будет создан ключ интеграции;
- <NumberRange> - диапазон номеров, добавляемых к интеграции.
Примеры:
admin@ds1@ecss1:/$ domain/biysk.local/integrations/add tester New integration was added. API key: 7bWK3ylK14tRELCbKXC2ersnK48esEPAM27KCX247eyKPL42qEsLEG7KbKjWCPXC [exec at: 16.02.2021 15:20:33, exec time: 25ms, nodes: ds1@ecss1 v.3.14.7.585]
admin@ds1@ecss1:/$ domain/biysk.local/integrations/add amouser --widget New integration was added. API key: rTDNoZ9aF9tErDT9ZQEU04qgSt9brFd9Z9QEZGHa9tgtB9drr0dTNZ9ohzE0Ga4q [exec at: 16.02.2021 16:06:33, exec time: 23ms, nodes: ds1@ecss1 v.3.14.7.585]
admin@ds1@ecss1:/$ domain/biysk.local/integrations/add servint --service --numbers 24010{0-1}
New integration was added.
API key: 8bWJ8lHeqWI80pwo38JWC2pjYCqpW8C808p3p8ebWWJlsvWLqqpdgII88N6wophe
[exec at: 16.02.2021 16:08:38, exec time: 25ms, nodes: ds1@ecss1 v.3.14.7.585]
remove
Команда предназначена для удаления имеющегося ключа интеграции по идентификатору клиента.
Путь команды:
delete /domain/<DOMAIN>/integrations/remove <CLIENT_ID>
Синтаксис:
remove <CLIENT_ID>
Параметры:
<DOMAIN> - имя виртуальной АТС;
<CLIENT_ID> - идентификатор клиента, для которого будет удален ключ интеграции.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/integrations/remove tester ok [exec at: 16.02.2021 16:15:04, exec time: 24ms, nodes: ds1@ecss1 v.3.14.7.585]
list
Команда предназначена для просмотра списка ключей интеграций в данном домене.
Путь команды:
delete /domain/<DOMAIN>/integrations/list
Синтаксис:
list
Параметры:
<DOMAIN> - имя виртуальной АТС.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/integrations/list ┌─────────┬───────┬────────────────────────────────────────────────────────────────┬────────┐ │Client id│ Type │ API Key │Options │ ├─────────┼───────┼────────────────────────────────────────────────────────────────┼────────┤ │aleksandr│widget │tPS8pIKwO9ezzAtmP9qwnEFNwzO9gAWPtgIPq9wshnIw9s919zezvPZtpIISP09q│ │ ├─────────┼───────┼────────────────────────────────────────────────────────────────┼────────┤ │amouser │widget │rTDNoZ9aF9tErDT9ZQEU04qgSt9brFd9Z9QEZGHa9tgtB9drr0dTNZ9ohzE0Ga4q│ │ ├─────────┼───────┼────────────────────────────────────────────────────────────────┼────────┤ │servint │service│8bWJ8lHeqWI80pwo38JWC2pjYCqpW8C808p3p8ebWWJlsvWLqqpdgII88N6wophe│Numbers:│ │ │ │ │240100 │ │ │ │ │240101 │ ├─────────┼───────┼────────────────────────────────────────────────────────────────┼────────┤ │svetlana │widget │qOPBaHCsS6WZpRB9U969bRSXwjSpRPBlUH9sXSXM2jSTOpOBP9WKHsSO6SJCV2uS│ │ ├─────────┼───────┼────────────────────────────────────────────────────────────────┼────────┤ │tester │widget │wSH6fVwcAM3qzA6SQYUHf6pbBwAbB3MihB3qtw3YQHSfwBTw0cQb3i3zqobcn3qS│ │ └─────────┴───────┴────────────────────────────────────────────────────────────────┴────────┘ [exec at: 16.02.2021 16:09:20, exec time: 24ms, nodes: ds1@ecss1 v.3.14.7.585]
replace
Команда предназначена для замены текущего ключа интеграции для определенного идентификатора клиента.
Путь команды:
delete /domain/<DOMAIN>/integrations/replace <CLIENT_ID>
Синтаксис:
replace <CLIENT_ID>
Параметры:
<DOMAIN> - имя виртуальной АТС;
<CLIENT_ID> - идентификатор клиента, для которого будет удален ключ интеграции.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/integrations/replace tester Old key was replaced with new one. New API key: wSH6fVwcAM3qzA6SQYUHf6pbBwAbB3MihB3qtw3YQHSfwBTw0cQb3i3zqobcn3qS [exec at: 16.02.2021 15:22:05, exec time: 21ms, nodes: ds1@ecss1 v.3.14.7.585]
set
Команда предназначена для изменения свойств интеграции.
Путь команды:
delete /domain/<DOMAIN>/integrations/set
Синтаксис:
set <ClientId> [--service [--numbers <NumberRange>]]
Параметры:
- <DOMAIN> - имя виртуальной АТС;
- <CLIENT_ID> - идентификатор клиента, для которого будет создан ключ интеграции;
- <NumberRange> - диапазон номеров, добавляемых к интеграции.
Примеры:
admin@ds1@ecss1:/$ domain/biysk.local/integrations/set servint --numbers 240006 Integration properties changed [exec at: 16.02.2021 16:12:09, exec time: 25ms, nodes: ds1@ecss1 v.3.14.7.585]