应用 API

Contact Center AI 平台(CCAI 平台)提供 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

API 响应中可能存在无法识别的 JSON 键

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