Краткий обзор программных интерфейсов Cisco …• Identity...

C97-739389-00 © 2017 Cisco and/or its affiliates. All rights reserved .

Краткий обзор программных интерфейсов Cisco UCCX


© 2019 Cisco and/or its affiliates. All rights reserved.

Программные интерфейсы Cisco UCCX

UCCX Configuration API. Обзор.

UCCX Advanced Scripting (REST API). Примеры использования.

Заключение

Содержание:



Где узнать больше?

Обработка неголосовых обращений в контактных центрах Cisco на базе CTI OMNI.Платон Бегун, руководитель направления «Контактные центры», CTI

Быстрый поиск и решение неисправностей в UCCX.Дмитрий Бокатов, Customer Support Engineer (TAC), Cisco

Полезные инструменты при эксплуатации контакт центра.Сергей Олиферов, Customer Support Engineer (HTTS), Cisco

Функционал Finesse 12.0 и подробная работа с API.Константин Ваксин, Customer Support Engineer (TAC), Cisco

14:45

15:25

16:40

17:50


Интерфейсы UCCX



Интерфейсы разработки Cisco UCCX

Custom Web Chat Client

CTI Clients

Custom Agent Desktop

Custom Config App

Social Miner CUCM

Finesse

UCCX Administration Web Application

CUIC

Platform

Database

CTI Server

UCCX

Programmable Scripting Engine

UCCX Engine

http/https

UCCX CTI protocol

http/https

http/https



Как программные интерфейсы используются?

• CTI Protocol: для построения собственного интерфейса оператора, отчётности или интеграции с уже существующими приложениями (например, CRM). Детали можно найти в CTI Protocol Developer Guide.

• Configuration APIs: для построения собственного интерфейса администрирования, автоматизации изменений в конфигурации UCCX. Детали можно найти в Configuration API

Developer Guide.

• Scripting: для самостоятельно создания собственных сценариев работы контакт-центра с помощью инструмента визуального программирования. Детали можно найти в Scripting and

Development Series Guide.

• Identity Service SDK: для использования конечными пользователям ряда Web и REST API приложений в рамках контакт-центра после единственной авторизации в систему. Детали можно найти в Cisco Identity Service Client SDK Guide.

https://developer.cisco.com/docs/contact-center-express/#!uccx-overview

https://developer.cisco.com/docs/contact-center-express/#cti-protocol-dev-guide

https://developer.cisco.com/docs/contact-center-express/#configuration-api-dev-guide

https://developer.cisco.com/docs/contact-center-express/#scripting-and-development-guide

https://developer.cisco.com/docs/contact-center-express/#cisco-identity-service-client-sdk-guide

https://developer.cisco.com/docs/contact-center-express/#!uccx-overview



Как программные интерфейсы используются?

• CTI Protocol: для построения собственного интерфейса оператора, отчётности или интеграции с уже существующим приложением (например, CRM). Детали можно найти в CTI Protocol Developer Guide.

• Configuration APIs: для построения собственного интерфейса администрирования, автоматизации изменений в конфигурации UCCX. Детали можно найти в Configuration API

Developer Guide.

• Scripting: для самостоятельно создания собственных сценариев работы контакт-центра с помощью инструмента визуального программирования. Детали можно найти в Scripting and

Development Series Guide.

• Identity Service SDK: для использования конечными пользователям ряда Web и REST API приложений в рамках контакт-центра после единственной авторизации в систему. Детали можно найти в Cisco Identity Service Client SDK Guide.

https://developer.cisco.com/docs/contact-center-express/#configuration-api-dev-guide

https://developer.cisco.com/docs/contact-center-express/#scripting-and-development-guide


REST API



Что такое REST?

REpresentational State Transfer

“передача состояния представления”

• REST это архитектурный стиль, описывающий принципы взаимодействия компонентов распределённого в сети приложенияпо модели клиент-сервер.

• RESTful Web service – это веб сервис, полностью соответствующий принципам REST.

• RESTful Web service API – это набор вызовов, возвращающих данные в определённом формате на базе методов протокола HTTP.



REST API Запрос - Ответ:



REST API Запрос – Ответ:



Пример URL: что вы запрашиваете?

Ресурс

• Местонахождение запрашиваемых данных или объекта

Параметры

• Детали для охвата, фильтрации или уточнения запроса. Часто необязательны.

http:// or https://

• Протокол, с помощью которого передаются данные

• ‘s’ в https обозначает «Secure»

Сервер или Хост

• Определяет IP и порт, к которым идёт подключение

https://deckofcardsapi.com/api/deck/new/shuffle/?deck_count=1

Сервер или Хост Ресурс Параметры









HTTP Аутентификация и Безопасность

• None: Web API ресурс публичный, кто угодно может сделать запрос.

• Basic HTTP: имя пользователя и пароль передаются на сервер в закодированной строке.

• Authorization: Basic YWRtaW5pc3RyYXRvcjpDMXNjbzEyMzQ1

• Token: секретный ключ обычно извлекается с портала Web API. Значение ключевого слова («Токен») уникально для каждого API.

• Authorization: Token aikasf8adf9asd9akasdf0asd

• OAuth: открытый протокол авторизации, позволяющий получать «Токен»от поставщика учётных записей (Identity Provider).

• Authorization: Bearer 8a9af9adadf0asdf0adfa0af

• Авторизация API может требовать периодического обновления ключа



Запрос/Ответ в REST:

HTTPS/1.1 200 OKDate: Wed, 23 Jan 2019 23:12:11 GMTContent-Type: application/json;charset=UTF-8Content-Encoding: gzipContent-Length: 323Trackingid: ROUTER_5C48F4B1-9789-01BB-4148-xxxxxxxxxVary: Accept-EncodingStrict-Transport-Security: max-age=63072000; includeSubDomains; preload

{"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iODBjM2NmOC01ZGIwLTQyNzAtOThiZS1mYzFhYjA3MzE1YWE","emails": ["[email protected]"],"displayName": "Charles Eckel","nickName": "Charles","firstName": "Charles","lastName": "Eckel",:"status": "active","type": "person”}

GET /v1/people/me HTTPS/1.1Host: api.ciscospark.comAuthorization: Bearer <redacted>Accept: */*Accept-Encoding: gzip, deflate, sdchConnection: keep-aliveUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36

Запрос: GET https://api.ciscospark.com/v1/people/me

Ответ: 200 OK + Data

HTTPS Request

Request Headers

HTTPS Response

Response Headers

Response Payload

<blank line>

Note: обмен в виде простого текста через TCP/TLS соединение.

Инструкция для получения токена: https://developer.webex.com/docs/api/getting-started/accounts-and-authentication



Инструменты для работы с REST API:

• Curl• Приложение командной строки Linux

• Postman• Среда для тестирования работы API

• Requests• Библиотека в Python для скриптов

• OpenAPI/Swagger• Документация спецификации API



Cisco DevNet Learning Labs

https://developer.cisco.com/learning/


Configuration API



Архитектура Configuration API:

Custom Configuration Application

3rd Party Campaign Management Application

3rd Party Agent Reskilling Application

Finesse


CUIC

Platform

Database

CTI Server

UCCX

UCCX Engine

https://developer.cisco.com/docs/contact-center-express/#!configuration-api-overview/technical-overview

https://developer.cisco.com/docs/contact-center-express/#!configuration-api-overview/technical-overview



UCCX Configuration API:

• Сущность

• Имя объекта, который конфигурируется

• Примеры: Application, Campaign, Skill

• Идентификатор

• Идентификатор конкретного экземпляра настраиваемого объекта

• Примеры: Application_Id, Campaign_Id, Skill_Id

• http:// or https://

• Протокол, с помощью которого передаются данные

• ‘s’ в https обозначает «Secure»

• Сервер или Хост

• FQDN или IP сервера контакт-центра (может быть любым в HA кластере)

https:// < ccx_hostname > / adminapi / < entityname > / [instanceid]

Сервер или Хост Сущность Идентификатор





Действие HTTP метод URL Назначение

LIST GEThttps://<ccx_hostname>/adminapi/<entityname>

https://connect.ccx.cisco.com/adminapi/application

Получить список сущностей

GET GEThttps://<ccx_hostname>/adminapi/<entityname>/<instanceid>

https://connect.ccx.cisco.com/adminapi/application/2

Получить свойства одной сущности

CREATE POSThttps://<ccx_hostname>/adminapi/<entityname>


Создать новую сущность

MODIFY PUThttps://<ccx_hostname>/adminapi/<entityname>/<instanceid>


Изменитьсуществующую

сущность

DELETE DELETEhttps://<ccx_hostname>/adminapi/<entityname>/<instanceid>

https://connect.ccx.cisco.com/adminapi/application/2

Удалить сущность

Контент в формате XML или JSON Для Аутентификации требуются полномочия администратора

Поддерживаемые типы операций:



Заголовок:какие метаданные можно использовать?

Заголовок Пример Назначение

Content-Type application/json, application/xml Обозначает формат данных в теле запроса

Accept application/json, application/xml Ожидаемый формат данных в ответе

Authorization Basic dmFncmFudDp2YWdyYW50 Авторизация (в UCCX используется BASIC)

Date Tue, 25 Jul 2017 19:26:00 GMT Дата и время сообщение

• Используется для передачи информации между клиентом и сервером

• Включаются и в REQUEST и в RESPONSE

• Некоторые APIs используют специальные заголовки для аутентификации или других целей



Проверка статуса:

Код статуса Сообщение Значение

200 OK All looks good

201 Created New resource created

202 Accepted Accepted for processing, but processing not completed

204 No Content Request succeeded, but no message body returned

400 Bad Request Request was invalid

401 Unauthorized Authentication missing or incorrect

403 Forbidden Request was understood, but not allowed

404 Not Found Resource not found

500 Internal Server Error Something wrong with the server

503 Service Unavailable Server is unable to complete request



Files (Scripts, Prompts, Grammar,

Document) Application

Call Control Group

Dialog Group

Http Trigger Contact Service Queue (CSQ)

Skills Outbound

Campaigns

and more…Chat Widget Channel Provider

(for chat and email)

Area Code

Поддерживаемые объекты в Configuration API:



Документация:



REST API за кадром: CSQ List




https://uccx1.dcloud.cisco.com/appadmin/main




Действие HTTP метод URL Назначение

LIST GET https://uccx1.dcloud.cisco.com/adminapi/csq Получить список сущностей

<id>, <name>, <queueType>,<routingType>, <queueAlgorithm>,<resourcePoolType>, …



GET https://uccx1.dcloud.cisco.com/adminapi/csq/10

GET GET https://uccx1.dcloud.cisco.com/adminapi/csq Получить свойства одной сущности

REST API за кадром: CSQ Info



REST API за кадром: Add Skill to CSQ



PUT https://uccx1.dcloud.cisco.com/adminapi/csq/10

REST API за кадром: Add Skill to CSQ



Пример использования Configuration APIПортал управления ресурсами

• Создание и назначение навыков

• Перераспределение по командам

• Визуализация skill-based CSQ и agent-based CSQ

• Изменение свойств оператора

• Cross-links для вывода информации о всех очередях и статистике

• и многое другое…



• Бизнес календарь: изменение настроек контакт-центра и IVR по дате

• Управление голосовыми приветствиями

• Дружественный для бизнеса интерфейс управления кампаниями

• Удалённое управление ресурсами и приложениями

• И многое другое…

Что можно улучшить в контакт-центре с помощью Configuration API?


Advanced Scripting:Make REST call



UCCX Script Editor

1

43

Палитра: список доступных шагов1

2 Окно дизайна: создание скрипта

3 Окно переменных: создать, изменить, просмотреть переменные скрипта

4 Панель сообщений: проверка, отладка, сообщения об ошибках и событиях

2



Editor REST Step Интерфейс с сервисами REST

• Generic REST step

• Внутренние / внешние сервисы REST

• Соответствует стандартам

• Поддерживает HTTPS

• Гибкий тип контента / формат

• Поддерживает GET / POST /PUT / DELETE

В категории «Document»

Шаг Make REST Call

Ветви алгоритма



Make REST call

https://developer.cisco.com/docs/contact-center-express/#!make-rest-call

REST URL

Authentication Credentials

REST Method

REST Payload

Response Status Code/Detail(variable)

Call Timeout

Payload Content Type(XML / JSON)

Query/URL parameters

REST Response(variable)

Other Headers

https://developer.cisco.com/docs/contact-center-express/#!make-rest-call



Body vs Parameters

Parameters – добавляются в URL:index.jsp?field1=value1&field2=va

lue2&field3=value3

Body – отправляется только в методах: POST и PUT

<xml version="1.0" ?>

<Bug>

<Submitter>rlafount</Submitter>

</Bug>

field1 value1field2 value2

field3 value3

Пример:

https://translate.google.ru/#view=home&op=translate&sl=en

&tl=ru&text=Hello%20world



Символ «U» в теле запроса:• XML часто содержит двойные кавычки, обозначающие «String» в Java.

• Эти двойные кавычки должны быть выделены с помощью знака черты "\".

• Знак ‘u’ должен предварять строку, содержащую выделенные двойные кавычки.

<xml version="1.0" ?>

<Bug>

<Submitter>rlafount</Submitter>

</Bug>

Name RequestBody

Type String

Value u"<xml version=\"1.0\" ?><Bug><Submitter>rlafount</Submitter></Bug>"

Attributes



Пример REST GET:

Name Type

Response String

ResponseCode String

ResponseDetial String



Пример REST POST:

Name RequestBody

Type String

Value u"<xml version=\"1.0\" ?><Bug><Submitter>rlafount</Submitter></Bug>"

Attributes


Пример использования Make REST #1



Пример использования Make REST #1Courtesy Callback

• Было зафиксировано, что в пиковые часы клиенты слишком долго ожидают соединения с оператором, из-за чего снижается уровень удовлетворённости сервисом и снижается уровень лояльности к компании.

• Количество операторов уже не может быть увеличено, но можно предложить клиенту обратный звонок:

“… Ваше приблизительное время ожидания 10 минут. Если вы хотите, чтобы мы перезвонили Вам, когда появится свободный оператор, нажмите «1», иначе, нажмите «2» или просто ожидайте соединения со следующим свободным оператором”



Как задача решалась раньше:

https://www.cisco.com/c/en/us/support/docs/customer-collaboration/unified-contact-center-express/200764-UCCX-Call-Back-Feature-as-seen-on-CUCM-a.html

BaseLineAdvQueuing

https://www.cisco.com/c/en/us/support/docs/customer-collaboration/unified-contact-center-express/200764-UCCX-Call-Back-Feature-as-seen-on-CUCM-a.html



Алгоритм скрипта:

Начало

Принять звонокОгласить приветствие

Есть свободный оператор?

Соединить с оператором

Конец

Звонок в очереди

Время ожидания

превышает лимит?

Спросить, хочет ли клиент запросить обратный звонок

Ответ?

Проверить, сколько уже контактов в исходящей кампании

Огласить клиенту, что заявка принята и его место в очереди такое-то

Добавить контакт в исходящую очередь

Да

Нет

Break

Да

Нет

ДаНет

Клиент доволен?Да!



Добавить контакт в исходящую очередь:

https://uccx1.dcloud.cisco.com/adminapi/campaign/16/contacts

Сервер Сущность Идентификатор




<campaignContacts>

<campaign name= "CAMPAIGN_NAME” >

<refURL>http://uccx1.dcloud.cisco.com/adminapi/campaign/ID</refURL>

</campaign>

<csvdata>phone1

PHONE_NUM

</csvdata>

</campaignContacts>

Name Type Value

CallbackCampaignName String

CallbackCampaignId String

RESTPayload String

1) Задаём переменные:

2) Формируем текст запроса (XML формат):




Name Type Value

AddContactBodyTemplate String u"<campaignContacts>\n<campaign name=\"CAMPAIGN_NAME\">\n<refURL>http://uccx1.dcloud.cisco.com/adminapi/campaign/ID</refURL>\n</campaign>\n <csvdata>phone1\nPHONE_NUM\n</csvdata>\n</campaignContacts>

3) Сохраняем текст запроса в текстовую переменную:

4) Добавляем значения переменных в текст запроса (шаг “Set”):

Set RESTPayload =

AddContactBodyTemplate.replaceAll ("CAMPAIGN_NAME", CallbackCampaignName ) .replaceAll("ID", CallbackCampaignId ).replaceAll("PHONE_NUM", CallingNumber )




5) Формируем шаг запроса (шаг “Make REST”):

/* Add the caller contact information to the "auto callback" campaign. */

Make REST call

Successful

Unsuccessful

https://uccx1.dcloud.cisco.com/adminapi/campaign/" +

CallbackCampaignId + "/contacts"

<campaignContacts>

<campaign name= "CAMPAIGN_NAME” >

<refURL>http://uccx1.dcloud.cisco.com/adminapi/campaign/ID/refURL>

</campaign>

<csvdata>phone1

PHONE_NUM

</csvdata>

</campaignContacts>




6) Обрабатываем результат (код ответа):

/* Add the caller contact information to the "auto callback" campaign. */

Make REST call

Successful

Unsuccessful

Переходим к выполнению следующего шага

Обработка ошибки




Начало




Конец





Ответ?


Огласить клиенту, что заявка принята и его место в очереди такое-то


Да

Нет

Break

Да

Нет

ДаНет




Проверить, сколько контактов в кампании:https://uccx1.dcloud.cisco.com/adminapi/campaign/16

Сервер Сущность ID

<pendingCintacts> 6 </pendingCintacts>




5) Формируем шаг запроса (шаг “Make REST”):

/* Get number of pending contacts in the "auto callback" campaign. This

is roughly the position of the caller in the campaign. */

Make REST call

Successful

Unsuccessful

https://uccx1.dcloud.cisco.com/adminapi/campaign/" +

CallbackCampaignId

Set NumPendingContacts =

RESTResponse.replaceAll("^.*<pendingContacts>","" ).replaceAll("</pendingContacts>.*","")

[if]

(1)

(2)




Начало




Конец





Ответ?


Огласить клиенту, что заявка принята и его место в очереди = NumPendingContacts


Да

Нет

Break

Да

Нет

ДаНет




Пример использования Make REST #2 Web Callback

Перезвонить мне





Светлана Зайцева • Регистрация

Ваше Имя: Номер телефона: Вопрос

+7 495 9611410Русский

Язык:

Время звонка: Сейчас Позже …





Спасибо за обращение, Ваша заявка принята,Ваш номер в очереди –Приблизительное время ожидания - минут. Детали звонка:

310

Светлана Зайцева • Регистрация+7 495 9611410Русский





Светлана Зайцева • Регистрация

Ваше Имя: Номер телефона: Вопрос

+7 495 9611410Русский

Язык:

Время звонка: Сейчас Позже …

Операции с HTTP: • работа с переменными• перевод на страницу





Спасибо за обращение, Ваша заявка принята,Ваш номер в очереди –Приблизительное время ожидания - минут. Детали звонка:

• Работа с документами JSON / XML / URL

• Операции с HTTP (работа с переменными, формирование ответной страницы)

• Make REST call (работа с переменными, добавление контакта)

310

Светлана Зайцева • Регистрация+7 495 9611410Русский



• Было зафиксировано, что в определённых подразделениях в пиковые часы высококвалифицированные специалисты перегружены, в то время как остальные ресурсы простаивают, а уровень удовлетворённости клиентов падает.

• Было решено, что не всегда, но при сильном превышении порогового значения KPI можно привлекать и менее квалифицированных специалистов к работе в очереди CSQ1.

• Эту функцию необходимо автоматизировать, чтобы разгрузить супервизоров контакт-центра.

Пример использования Make REST #3 Динамическое изменение свойств CSQ



Пример использования Make REST #3 Динамическое изменение свойств CSQ

Определить текущую нагрузку

•Значение Estimated Wait Time для CSQ1

Слишком много звонков?

•Сохранить исходное состояние очереди

•Понизить Skill Competence Level для CSQ1

Нагрузка снизилась?

•Возвратить свойства очереди на исходные



• Добавить контакт в Outbound Campaign

• Динамически изменять поведение контакт-центра

• Работать с данными в формате JSON / XML (веб-сервисы, CRM, итд.)

• Вовлекать в сценарий внешние системы (голосом отдавать команды системе и разговаривать с искусственным интеллектом :)

• И многое другое…

Что ещё можно сделать с помощью Make REST call?

https://cloverhound.com/2015/08/10/learning-simple-self-service-app-creation-for-uccx-with-philips-hue/

https://blogs.cisco.com/developer/hybrid-chat-wins



Доступность инструментов в UCCX Editor Step:

https://developer.cisco.com/docs/contact-center-express/#!cisco-unified-ccx-editor-step-availability-introduction/introduction

Cisco Unified IP IVR Cisco Unified CCX Enhanced Cisco Unified CCX Premium

General X X X

Session X X X

Contact X X X

Call Contact X X X

Email Contact X X

HTTP Contact X X

Media X X X

User X X X

Prompt X X X

Grammar X X X

Document X X X

Data Base X X

ACD X X

ICM X

Java X X X

https://developer.cisco.com/docs/contact-center-express/#!cisco-unified-ccx-editor-step-availability-introduction/introduction



Интерфейсы разработки Cisco UCCX

Custom Web Chat Client

CTI Clients

Custom Agent Desktop

Custom Config App

Social Miner CUCM

Finesse


CUIC

Platform

Database

CTI Server

UCCX

Programmable Scripting Engine

UCCX Engine

http/https

UCCX CTI protocol

http/https

http/https

Спасибо за внимание!

www.facebook.com/CiscoRu


www.instagram.com/ciscoru

www.youtube.com/user/CiscoRussiaMedia

www.vk.com/cisco

Оцените данную сессию в мобильном приложении конференции

Контакты:

Тел.: +7 495 9611410www.cisco.com

Краткий обзор программных интерфейсов Cisco …• Identity...

Documents

Transcript of Краткий обзор программных интерфейсов Cisco …• Identity...