- 主页
- /
- 文章
Partner Hub中Webex 的详细呼叫记录Webhook
您可以设置网络钩子以收集所有客户的Webex呼叫记录, 用于计费核对、分析或报告目的。
概览
通过“详细呼叫记录”Web ,您可以更好地了解客户的Webex 活动,以满足从计费到自定义报告等各种目的。您可以使用此Web 方便地收集所有客户的记录,而无需逐个查询每个客户的记录。此Web 允许您开发自定义报告和分析应用程序,用于内部业务目的或向客户提供增值服务。有关Web 及其附带API的介绍,您可以观看此vidcast。
网络钩子每5分钟提供一次记录。每个Webhook有效负载都包含10至5分钟前结束的呼叫记录。例如,在17:00时收到的有效负载包括在16:50至16:55之间结束的呼叫。16:55至17:00之间结束的呼叫将在17:05有效负载中。
Webex 记录使用与 详细呼叫记录API 相同的格式提供。您可以设置Web 并在两种类型的摘要中进行选择:
- 分析—包括合作伙伴与Webex 存在关系的所有客户组织的所有呼叫记录。这包括以下组织:
- 合作伙伴以合作伙伴完全权限管理员角色管理客户组织。
- 客户组织在合作伙伴组织内有活动的Webex 订阅。
- 计费—仅包括由合作伙伴销售的Webex呼叫许可证的用户呼叫的呼叫记录。此源中包含了Workspaces的呼叫记录。
设置 Webhook 回拨 URL
API终端
我们提供两个API端点以及Web ,以帮助进行数据协调。这些端点允许您“跟上”或将数据存储与WebHook侦听器未接收的丢失记录进行调节。这两个API是协调API终 端和记录API终端。
记录可从这些API获得48小时。我们建议定期核对记录库(如每12或24小时一次),以便按预期收到所有记录。需要合作伙伴访问令牌才能使用此API。您可以获取合作伙伴访问令牌并根据标准Webex开发者访问令牌管理原则进行管理。
协调API终端
对账API端点返回由合作伙伴在指定时间段内管理的每个客户生成的记录数。如果合作伙伴管理200多个客户组织,来自API的结果将分页显示,以获得更好的可读性。您可以使用这些总数来检查本地存储空间是否缺少特定客户的任何记录。您可以在此处找到协调API端点URL:
https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
参数
调用API最多持续时间为1小时,开始时间
和结束时间
的参数相隔不超过60分钟。API可以在5分钟到48小时之前的任何时间段内使用,但是要管理服务负载,一次只能呼叫1小时。
可用的参数为:
- start Time(字符串)-要收集的第一个报表的时间。报告时间指定呼叫完成时间。
您必须将时间格式为
YYYY-MM-DDTHH:MM:SS。mmmZ
。 - end Time(字符串)-要收集的上一次报表的时间。报告时间指定呼叫完成时间。
指定时间应该晚于
startTime
,但不晚于48小时,并且必须将该时间格式为YYYY-MM-DDTHH:MM:SS。mmmZ
。
以下是Reconciliation API端点JSON返回有效负载的示例:
{ "cdr_counts": [ { "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy", "count":3009 }, { "orgId": "yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyyyy", "count":129 }, {"orgId":"xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyy","count":278 } ] }
API响应的标题表示返回的组织总数,以及是否有额外的页面。检查以下参数,确保已查询所有页面。
num-pages = 2个orgs = 283当前页= 1
以上参数表明,当前页是第一页,总页有2页,整个响应包含283个组织。在GET
请求中添加参数page=2
以访问第二页,如下所示。
https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
记录API终端
此API终端以JSON格式返回呼叫记录,格式与详细呼叫历史记录API中所述的格式相同。返回的有效载荷包含与返回的详细呼叫历史记录相同的字段。您可以在此处返回的每个字段中找到有关值的更多详细信息。记录API端点用于查询缺少记录的组织的丢失记录。您可以在此处找到记录API端点URL:
https://analytics.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
参数
-
orgID -要查询记录的组织ID。您可以从上述核对端点打开这些标识符。
-
start Time(字符串)-要收集的第一个报表的时间。报告时间指定呼叫完成时间。
指定时间必须在5分钟前到48小时前之间,并且必须将时间格式为
YYYY-MM-DDTHH:MM:SS。mmmZ
。 -
end Time(字符串)-要收集的上一次报表的时间。报告时间指定呼叫完成时间。
指定时间应该晚于
startTime
,但不晚于48小时,并且必须将该时间格式为YYYY-MM-DDTHH:MM:SS。mmmZ
。