Websocket Token-API
Обзор
Websocket Token-API служит для подключения внешних систем и является альтернативой веб-хукам.
Адрес для подключения /ws/token/v1/:TOKEN
, где :TOKEN
- значение поля token_local
сущности integration_point.
Требует настройки websocket-подключения на конкретные API, доступные внешним системам и соответствующие точке подключния по настроенным ролям (поле opts.filter_capabilities
сущности integration_point).
Информация о подключении
[ "connection_info", { "qid":930293482233 } ]
[ "connection_info_result", { "qid":123, "result":"ok", "site":"main_site", "ownertype":"token", "domain":"test.rootdomain.ru", "sessionid":"6a0c530c-017d-960e-e3d6-7cd30a921f58", "connectionid":"b26c45b1-017d-960e-e3d5-7cd30a921f58", "capabilities":["test","callrecord","infinityx","ivrapi","rest","svcscript"], "datetime":"2021-12-07T18:47:00.003Z", "timestamp":1638902820003, "integration_point_id":"c75f0231-016b-8f20-af65-1c1b0d69174c", "integration_point_type":"public", "roles":["admin"], "token":"a55c54b59ee6c8cfab2f83e33c2474d3" } ]
Доступные Token-API
-
rest - управление классами системы (статическими и динамическими).
-
subscr - подписка на события системы, отправляемые ролью wssubscr.
-
ivrapi - внешнее управление IVR-сценариями.
-
infinityx - доступ к функциям управления звонками и устройством.
-
callrecord - доступ к записям разговоров.
-
svcscript - запуск обработчика произвольного служебного сценария в домене.
-
msg - отправка сервером произвольных сообщений в websocket-подключения из сценариев.
Поддерживается подключение плагинов, реализующих и другие произвольные Token-API и соответствующие capabilities.