目录同步概述

目录同步Webex Cisco BroadWorks 用户可以使用 Webex 应用程序中的 Webex 目录从 BroadWorks 服务器呼叫任何主叫实体。 此功能将非用户设置一部分的 BroadWorks 呼叫信息同步到 Webex目录。

Webex Cisco BroadWorks 用户设置中,已更新 Webex 目录,为 Cisco BroadWorks 用户更新 Webex 的呼叫详细信息(主电话号码、移动电话号码、分机),但省略外部呼叫记录。 但是,当目录同步打开时,此功能还会将以下呼叫记录同步到Webex目录。

  • 仅 BroadWorks 呼叫用户(未加入 Webex)

  • 非用户呼叫实体(例如,会议室电话、传真寻线组号码)

  • BroadWorks 电话列表条目

下表总结了 BroadWorks 呼叫记录,并显示了如何将记录添加到 Webex目录。

表 1. 目录同步更新至Webex目录

BroadWorks 呼叫记录

描述

通过Webex添加到目录...

Webex Cisco BroadWorks 用户

为 Cisco BroadWorks Webex启用用户设置

用户设置(例如,流式设置)

仅 BroadWorks 呼叫用户

呼叫未加入 呼叫Webex

目录同步

非用户呼叫实体

例如电话、传真会议室寻线组号码

目录同步

BroadWorks 电话列表

BroadWorks 电话列表条目:

  • 企业通用电话列表

  • 组通用电话列表(服务商组或企业组)

  • 个人电话列表

目录同步(电话列表同步)


有关用户提供的更多详细信息,请参阅 Cisco BroadWorks Webex解决方案指南

目录同步条件

  • 合作伙伴管理员必须在合作伙伴级别启用此功能。 合作伙伴管理员可以在一次操作中为多个客户组织开启或关闭此功能。

  • 缺省情况下,初始同步会在启用同步后的下一周执行(所选的同步开始时间是随机的)。 但是,客户组织可以使用立即同步选项跳过一周的等待时间,而为给定的客户组织完成即时同步。

  • 缺省情况下,每个客户的目录同步每周运行一次。 每次同步都会在上次同步后一周进行,不管上次同步是安排还是通过“立即同步”手动 触发

  • 每个 BroadWorks 集群的最大同步数为 2: 一个已安排的同步和一个按需同步(通过 API 或 Partner Hub GUI)。 但是,管理员无法从同一 BroadWorks 同时运行两个按需同步。 无论通过 API 还是 Partner Hub 中的“立即同步”选项启动同步,都不存在此限制。 此外,Webex不会安排从同一 BroadWorks 同时运行两个已安排的同步。

  • 如果发生同步失败,Webex每 24 小时自动重新尝试同步一次,直到下次安排的同步。

  • 同步会忽略没有电话号码的用户。

  • 在 Partner Hub 中,您可以查看给定客户的同步状态信息。 此外,您还可以将上次同步的详细信息导出为 CSV 记录。 CSV 记录提供比 Control Hub 显示更多的详细信息,并可以帮助进行疑难解答、分析和审核。

  • Webex以加密格式存储用户联系人。 只有拥有该联系人的用户才能访问解密密钥。

  • 对于 BroadWorks 仅呼叫用户和非用户呼叫实体,此功能将同步 BroadWorks 中的以下电话号码类型:

    • 主要电话号码

    • 移动电话号码

    • 分机号

    但是,如果主电话号码或分机不存在,同步操作不会将仅 BroadWorks 呼叫用户和非用户呼叫实体排除在同步中。

BroadWorks 电话列表和联系最大值

目录同步还会将 BroadWorks 电话列表条目同步到Webex联系人。 已同步条目将添加到以下联系人类型之一:

  • 组织联系人 - Webex组织存储这些联系人。 每个用户都可以访问其组织的组织联系人。 最多 500 名联系人。

  • 用户联系人 - Webex针对用户存储这些联系人。 只有拥有该联系人的用户才能访问该联系人条目。 最多可以有 2000 个联系人(1500 个已同步的联系人 + 500 个手动输入联系人)。


仅将“电话列表”条目Webex联系人。 除非 Webex 用户手动将包含在目录同步中的 BroadWorks 呼叫用户和非用户呼叫实体添加到“联系人”中。

下表将Webex联系人源(从 BroadWorks 电话列表同步或手动添加)映射联系人类型:

表 2. 目录同步上限和来源

Webex 联系人类型

联系人来源

最大

从 BroadWorks 同步...

用于同步的 API

组织联系人

目录同步

500 名联系人

企业通用电话列表

/directories/enterprisecommon

组通用电话列表(对于服务商组)**

/directories/groupcommon

用户联系人

目录同步

1500 名联系人

组通用电话列表(对于企业组)**

/directories/groupcommon

个人电话列表

/directories/personal

由用户手动添加

500 名联系人

不适用

不适用


**组通用电话列表条目的同步方式有所不同,具体取决于 BroadWorks 是企业模式还是服务商模式。 参数值(true 或 false) isBroadWorksEnterprise 可确定列表的同步方式:

  • True - 同步为用户联系人

  • False - 同步为组织联系人

以下条件适用于目录同步处理联系人上限的方式:

  • 如果组织超过了同步允许的最大联系人数(500 个组织联系人或 1500 个已同步的用户联系人),目录同步不包括高于最大阈值的条目。 没有适用于已同步或省略联系人的特定顺序。

  • 如果您的客户中的某一位客户超过了任一类别中的联系人人数上限,我们建议您向 Cisco 提出案例,要求将该组织排除在目录同步之外。

  • 手动联系人是用户在 Webex App 上手动添加的联系人。 一个用户最多可以添加 500 个手动联系人。 手动联系人属于更多用户的联系人类别Webex但不包含在同步中。

更新

以下是 Webex 目录处理更新的方式:

  • 如果联系人姓名在 BroadWorks 上发生更改,现有联系人将从Webex中删除,然后会新建联系人。

  • 如果联系人号码在 BroadWorks 上发生更改,Webex使用新号码在 Webex 中更新现有联系人。

当管理员在 BroadWorks 上更新联系人后,当用户的应用程序中显示更新时,Webex概述:

  • 如果更新的是仅 BroadWorks 呼叫用户或非用户呼叫实体,则更新会在后续目录同步后立即显示在用户的 Webex 应用程序中。

  • 如果更新内容是 BroadWorks 电话列表条目:

    • 对于用户联系人 - 在后续目录同步之后Webex用户的“应用程序”中显示更新。

    • 对于组织联系人 - Webex 目录将在后续目录同步时更新,但用户直到重启 Webex 应用程序或本地 72 小时缓存计时器到期后才能在 Webex 应用程序中看到更改。


Cisco BroadWorks Webex 应用程序更新用户信息作为设置流程的一部分进行处理。

Control Hub 包含通过 CSV 文件在 Control Hub 中添加或编辑组织级联系人的选项。 具有 Control Hub 访问权限的合作伙伴管理员和客户管理员可以访问该选项。 但是,Cisco BroadWorks 的 Webex通过 Control Hub 更新联系人。 Control Hub 中应用的联系人更新不会同步回 BroadWorks,并且无法从台式电话进行目录搜索。

目录同步先决条件

我们建议您使用以下设置:


以下示例假定您使用的是 XSP 服务器。 对于 ADP 服务器,将 (XSP_CLI) 替换为 (ADP_CLI)。
  • 速率限制值—设置以下 OverloadControl 系统属性 (XSP_CLI/Applications/Xsi-Actions/OverloadControl):

    • userDirectoryTransactionLimit—设置为空值。

    • globalDirectoryTransactionLimit—设置为空值。


    建议您将 userDirectoryTransactionLimit 和 globalDirectoryTransactionLimit 设置为空值。 但是,如果您决定分配值,则每个值都必须设置为至少五倍于 transactionLimitPeriodSeconds 的值(应该是 1)。
  • 交易限制—设置以下值 (XSP_CLI/System/CommunicationUtility/DefaultSettings):

    • userTransactionLimit - 设为至少 100。

    • transactionLimitPeriodSecs - 设为 1。

  • 寻呼值—设置寻呼系统属性 (XSP_CLI/Applications/Xsi-Actions/Paging):

    • defaultPageSize—设为 50

    • availableUserMaxLimit—设为 100

  • CTI 接口—确保将 Webex CA 证书上传到 CTI 接口信任库,并启用 CTI 接口上的客户端验证。

此外,在启用此功能前,我们建议根据您的 BroadWorks 发行版对 BroadWorks 部署应用以下系统补丁:

启用目录同步(新模板)

合作伙伴管理员可以在创建新模板时为客户模板启用目录同步。 任何分配到该模板的新客户组织都将启用目录同步。 有关详细信息,请参阅在 Partner Hub 中配置合作伙伴组织(位于 Webex for Cisco BroadWorks 的解决方案指南中)中的“配置客户模板”。

后续步骤

确保您的用户知道必须至少单击一次 Webex 应用程序上的联系人标签页才能在 Webex 应用程序上开启此功能。 只需完成一次。

启用目录同步(现有模板)

合作伙伴管理员可以完成以下步骤,在现有客户模板中开启目录同步,以便为使用该模板的客户组织启用此功能。

1

登录 Partner Hub,然后选择设置

2

滚动到 BroadWorks Calling,然后单击查看模板

3

选择相应的客户模板,然后滚动到 BroadWorks 目录同步

4

要在缺省情况下为使用该模板的新客户组织启用目录同步:

  1. 为所有新客户组织启用 BroadWorks 目录和电话列表同步切换开关设置为开启

  2. 单击保存

5

要为使用该模板的现有客户组织启用目录同步:

  1. 单击显示客户同步状态列表

  2. 选中要开启该功能的各个组织旁边的复选框。

  3. 单击启用同步


 

如果您要禁用目录同步,请按以上过程操作,并执行以下操作:

  • 在步骤 4a 中,将为所有新的客户组织启用电话目录同步设置为关闭,以在缺省情况下为使用该模板的新客户组织禁用目录同步。

  • 在步骤 5c 中,单击禁用同步,为现有组织关闭该功能。

下一步

确保您的用户知道必须至少单击一次 Webex 应用程序上的联系人标签页才能在 Webex 应用程序上开启此功能。 只需完成一次。

完成“即时同步”

立即同步选项允许合作伙伴管理员为给定客户组织完成按需同步。 只能为单个客户组织选择该选项,没有批量“立即同步”选项。

1

登录 Partner Hub (http://admin.webex.com),然后选择设置

2

滚动到 BroadWorks Calling,然后单击查看模板

3

选择相应的客户模板,然后滚动到 BroadWorks 目录同步

4

单击显示客户同步状态列表

5

对于要同步的客户组织,请单击最右边的三个圆点,然后选择立即同步

6

单击刷新查看同步结果。

将“同步记录”导出为 CSV

合作伙伴管理员可以将上次同步的详细信息导出为 CSV 文件。 CSV 中的同步记录比 Control Hub GUI 中的内容更详尽,有助于进行故障排除和分析。

1

登录 Partner Hub (http://admin.webex.com),然后选择设置

2

滚动到 BroadWorks Calling,然后单击查看模板

3

选择相应的客户模板,然后滚动到 BroadWorks 目录同步

4

单击显示客户同步状态列表

5

选中要导出的各个组织旁边的复选框。

6

单击导出结果

用于目录同步的公共 API

developer.webex.com 上提供了公共 API,允许合作伙伴管理员执行以下操作:更新其管理的客户组织的目录同步设置、触发即时同步,或者获取同步状态信息。 目录同步方法分组到 BroadWorks 企业:

  • 列出 BroadWorks 企业 - 使用此 API 方法可获取给定服务商下的企业列表,以及各个企业 id 。 您必须输入 spEnterpriseId (预配置时指定)。

  • 更新 BroadWorks 企业的目录同步 - 输入企业 id 以更新该企业的目录同步状态,从而启用或禁用目录同步。

  • 触发企业的目录同步 - 如果要为给定企业触发即时同步,请使用此 API 方法 id 。 对于 syncStatus ,请输入 SYNC_NOW

  • 获取企业的目录同步状态 - 输入企业 id 并运行,以获取最新同步的状态和 trackingId 。 您可以使用 trackingID 通过 Kibana 和 Grafana 等工具运行其他分析。

此外,管理员可以为单个 用户 API 触发目录同步来为单个用户触发按需目录同步。

有关 API 文档的详细信息,请参阅 https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide

您需要登录到 https://developer.webex.com/docs/api/v1/broadworks-subscribers 以阅读 API 规范。

将多个企业与 API 同步

完成本过程以使用公共 API 为多个企业完成目录同步。

  • 目录同步允许您通过按需同步来一次仅同步 Broadworks 集群中的单个企业。 如果您尝试同步多个企业,会收到 429 错误

  • 单个企业完成同步所花的时间取决于企业规模。

1

运行列出 BroadWorks 企业 API,生成要同步的企业的列表。

  1. startWith 设置为企业或服务商标识的起始字符串。

  2. 单击 运行.

2

对列表中的第一个企业运行触发企业的目录同步 API。

  1. 输入企业标识

  2. syncStatus 设置为 SYNC_NOW

  3. 单击 运行.

    将为企业触发即时同步。 该同步计入每个 Broadworks 的一次按需同步限制。
3

等待几秒钟,然后运行获取目录同步状态 API 以获得同步状态。

  1. 输入企业标识

  2. 单击 运行.

4

同步完成后,对列表中的下一个企业完成步骤 2 到 4。 重复这些步骤,直至同步整个列表。

目录同步错误代码

以下错误代码适用于目录同步。

错误代码

错误消息

600000

发生 Broadworks 外部目录用户同步意外错误。

600001

Broadworks 外部目录用户同步失败。

600002

Broadworks 外部目录用户同步尚未完成,但必须终止。

600003

Broadworks 外部目录用户同步仅部分成功。 部分客户组织同步失败。

600004

没有为配置集启用 Broadworks 外部目录用户同步。

600005

正在进行配置集的 Broadworks 外部目录用户同步。

600006

Broadworks 外部目录用户同步线程正忙或已关闭,因此不会接受其他同步请求,请稍后重试。

600007

找不到客户配置的身份组织。

600008

在合作伙伴组织中找不到客户配置。

600009

无法运行 Broadworks 外部目录用户同步,因为与客户配置关联的 Broadworks 集群正忙

600010

无法运行 Broadworks 外部目录用户同步,因为没有任何 Broadworks 集群与客户配置关联。

600011

没有为客户配置启用 Broadworks 外部目录用户同步。

600012

无法运行 Broadworks 外部目录用户同步,因为已为客户配置启用混合目录同步。

600013

Broadworks 外部目录用户同步无法将用户和计算机帐户添加到身份存储库。

600014

尝试连接到 Broadworks 集群时,Broadworks 外部目录用户同步失败。 Broadworks 发生错误 - %s。

600015

Broadworks 外部目录用户同步在身份存储库中找不到任何匹配的用户。

600017

BroadWorks 电话列表同步无法同步所有用户和企业/组织联系人。

600018

对于企业/组织中的用户,BroadWorks 电话列表同步失败。

600019

BroadWorks 电话列表同步无法同步企业/组织联系人。

600020

正在进行 CustomerConfig sync,因此无法禁用 BroadWorks 外部目录用户同步。

600022

无法进行 BroadWorks 外部目录单用户同步,因为企业没有设置用户。

600023

BroadWorks 外部目录单用户同步无法进行,因为该组织中已经存在该用户。

600024

BroadWorks 外部目录单用户同步无法进行,因为 BroadWorks 中找不到匹配的用户。

600025

BroadWorks 外部目录用户同步在 CI 用户帐户同步失败。

600026

BroadWorks 外部目录用户同步在 CI 中更新机器帐户失败。

600027

BroadWorks 外部目录单用户同步无法进行,因为在 BroadWorks 中发现多个用户。

600028

不能进行 BroadWorks 外部目录单用户同步,因为应至少完成一个企业目录同步。

600029

BroadWorks 外部目录用户同步失败,因为企业没有设置用户。

更改历史记录

下表对本文的更新进行了总结。

日期

Revision

2022 年 7 月 19 日

概述信息的澄清和修正:

  • 更新 了目录同步概述 ,以澄清涉及不同的同步以及每个目录Webex更新方式。

  • 更新 了 BroadWorks 电话列表和联系人上限 ,以澄清只有电话列表可以与联系人同步。

  • 更新修正 以澄清应用程序显示Webex记录的时间。

2022 年 5 月 9 日

  • 目录同步概述中,更正了目录 同步最大值和源表下的 注释。 还更新了流式设置说明。

  • 语法编辑和修复

2022 年 4 月 7 日

  • 在“目录 同步 概述 ”的 “更新”部分中新增了关于在 Control Hub 中应用组织级联系人编辑的限制。

2022 年 3 月 28 日

  • 重新插入“启用目录同步 (新模板)”下的缺失内容

  • 添加了有关同步最大值的信息。 您可以同时从同一集群运行一个已安排的同步和一个 API 同步。

  • 添加了关于单 用户 API 触发目录同步 的信息。

2022 年 3 月 24 日

在“目录同步条件”中添加 了同步的电话号码类型列表。 同步现在包括移动电话号码。

2022 年 3 月 16 日

  • 添加了新的错误代码。

  • 添加了介绍性说明,以从网络搜索中提供更好的易用性。

2021 年 12 月 17 日

  • 进行微小结构编辑,以修复缺少 TOC 的问题。

2021 年 12 月 16 日

  • 更新了文章,增加了用户联系人上限值。

2021 年 12 月 8 日

  • 添加了“ 目录同步”和“联系人最大 数量”部分,以说明“目录同步”如何获取最大组织和用户联系人数。

  • 修改了目录同步错误代码中的表格格式,以提高可读性。