应用 API

Contact Center AI 平台 (CCAI Platform) 提供 API 端点,以支持与该平台集成。Apps API 扩展了平台支持的渠道的功能,包括来电、对话和短信。这些端点分为以下几类:

基本身份验证

请求使用基本身份验证。如需创建 API 凭据,请按以下步骤操作:

  1. 前往 CCAI Platform 门户。

  2. 依次前往设置 > 开发者设置 > API 凭据

  3. 添加新的 API 凭据并提供名称。

API 调用的凭据如下:

  • 子网域用作 {username} 变量。

  • 令牌用作 {​password} 变量。

每个安装都有自己的子网域。如需查找子网域,请在浏览器中找到网址。它应类似于以下内容:

https://customer.uc1.ccaiplatform.com

将子网域(在本例中为 customer)替换为 {subdomain} 变量。将网址的其余部分(在本例中为 rest.of.url.com)替换为 {domain} 变量。

基准网址

该 API 对其所有 API 请求使用以下基准网址

https://{subdomain}.{domain​}/apps/api/v1

其中,提及 /calls 表示 https://{subdomain​}.​{domain​}/apps/api/v1/calls

速率限制

系统将请求限制为每个客户每秒 10 个请求的速率。

预期 API 响应中出现无法识别的 JSON 键

所有 API 更新都是向后兼容的。我们保留随时在现有 API 响应中引入新的 JSON 键的权利。我们建议您以防御方式处理响应,忽略任何无法识别的键,以保持持续的功能。