Microsoft CIFramework 提供了使用 JavaScript API 管理 Dynamics 365 模型驱动应用中的通信面板（小组件）、通知、应用程序选项卡、会话、记录和窗体的方法。
重要
- 仅组织中配置的活动渠道提供程序支持 API。
- 在调用其他 API 之前，必须调用 CIFInitDone 事件处理程序 。
- API 的超时限制为 100 秒。 如果 API 未在 100 秒内运行，则必须使用更改的参数或范围再次运行它们。
通信面板管理 API
通信面板是您作为代理与客户互动的地方。 使用此面板加载使用 Channel Integration Framework 2.0 构建的合作伙伴小组件。 此版本中的小部件显示在会话面板的左侧，并支持停靠、最小化和隐藏模式。
使用以下 API 来管理通信面板（小组件）的状态。
| Methods | Description |
|---|---|
| 设置宽度 | 设置所有会话的面板宽度。 |
| 获取宽度 | 获取面板宽度（以像素为单位）。 |
| 设置模式 | 设置面板的状态。 |
| 获取模式 | 设置面板的状态。 |
CRUD作 API
使用以下 API 对实体记录执行 CRUD作。
| Methods | Description |
|---|---|
| 创建记录 | 创建实体记录。 |
| 检索记录 | 检索实体记录。 |
| 更新记录 | 更新实体记录。 |
| 删除记录 | 删除实体记录。 |
通知管理 API
使用以下 API 显示或取消有关传入对话的通知。
| Methods | Description |
|---|---|
| notifyEvent | 显示可用于通知座席传入对话的通知。 |
| 取消事件 | 根据方法中 notifyEvent 指定的取消令牌隐藏或取消通知。 |
应用程序选项卡管理 API
使用以下 API 创建和管理应用程序选项卡的状态。
| Methods | Description |
|---|---|
| 创建选项卡 | 在焦点会话中创建选项卡，并返回所创建选项卡的唯一标识符。 |
| getTabs | 如果会话属于通道提供程序，则返回与焦点会话中选项卡的模板名称或模板标记关联的选项卡标识符数组。 |
| 焦点选项卡 | 如果焦点会话属于通道提供程序，并且选项卡属于焦点中的会话，则设置选项卡上的焦点。 |
| getFocusedTab | 如果会话属于提供程序，则返回焦点会话中的选项卡标识符。 |
| 刷新选项卡 | 刷新选项卡。 |
| setTabTitle | 设置选项卡的标题，如果焦点会话属于通道提供程序，并且选项卡属于焦点会话。 |
| closeTab | 关闭当前会话中的指定选项卡。 |
会话管理 API
使用以下 API 管理多会话提供程序环境中的会话。
| Methods | Description |
|---|---|
| 可以创建会话 | 允许您检查是否可以创建新会话。 |
| 创建会话 | 根据定义为模板一部分的会话模板创建会话，并返回已创建会话的唯一标识符。 |
| get会话 | 返回一个对象，其中包含会话的唯一标识符、上下文和参数值 isFocused （如果会话属于通道提供程序）。 |
| getFocusedSession | 返回焦点会话的唯一标识符，如果它属于通道提供程序，否则返回 null。 |
| getAll会话 | 返回通道提供程序的会话标识符数组。 |
| 设置会话标题 | 设置会话标题（如果会话属于通道提供程序）。 |
| 请求焦点会话 | 如果会话属于通道提供程序，则将焦点设置为会话标识符作为参数传递的会话。 |
渠道分析 API
使用以下 API 跟踪事件分析。
| Methods | Description |
|---|---|
| logAnalytics事件 | 调用此方法以记录自定义事件的分析。 |
会话指示器 API
使用以下 API 指示关键绩效指标 （KPI） 违规，并更新特定会话中的新活动数。
| Methods | Description |
|---|---|
| 通知KpiBreach | 此方法用于指示 KPI 违规。 使用此方法时，当发生 KPI 违规时，联系人的显示图像上会出现一个红色圆圈。 |
| notifyNewActivity （通知新活动） | 此方法用于更新特定会话中的新活动数。 |
在线状态 API
使用这些 API 以编程方式设置和检索全渠道代理状态。 当混合代理正在使用全渠道处理非 Microsoft 应用程序时，可以使用这些方法，并且您希望同步不同应用程序之间的状态，以确保以最佳方式利用代理容量。
| Methods | Description |
|---|---|
| 设置存在 | 允许以编程方式为客户端会话中的代理设置状态。 |
| 获取存在 | 允许以编程方式为客户端会话中的代理返回状态。 |
杂项方法
| Methods | Description |
|---|---|
| getEntityMetadata | 返回指定实体的实体元数据。 |
| setClickToAct | 设置布尔值以启用或禁用出站通信 （ClickToAct）。 |
| getClickToAct | 返回一个布尔值，以指示是否启用了出站通信 （ClickToAct）。 |
| searchAndOpenRecords | 该方法在入站通信期间从通信小组件中搜索记录并打开记录。 |
| 获取环境 | 获取当前的统一接口应用和页面详细信息。 详细信息包括应用程序 ID（appid）、pageType（pageType）、记录 ID（id）、组织地理位置 （orgGeo） 和会话导航类型 （navigationType）。 |
| 开放表格 | 打开实体窗体或快速创建窗体。 |
| 渲染搜索页面 | 允许您在特定实体类型的记录中搜索。 此 API 将打开统一接口实体页面，其中的搜索字段预填充了作为参数传递的搜索字符串。 |
| addHandler | 将订阅者添加到事件中。
注释 此 API 可用于小组件和统一接口页面。 |
| removeHandler | 从事件中删除订阅者。
注释 此 API 可用于小组件和统一接口页面。 |
| raise 事件 | 调用事件的关联订阅者。
注释 如果已使用 addHandler 方法创建了自定义事件，则可以通过在此方法中将事件名称作为参数传递来引发这些事件。 |
| 更新上下文 | 此方法允许您设置自动化字典。 |
| 更新对话 | 此方法允许您更新对话记录。 |