API 文档 文档
API 文档
API 文档
SparkTG API 正在迁移到 v2
这些页面介绍的是 API v1。SparkTG 的所有 API 都将迁移到 API v2,并使用签名的 API 令牌,而不是用户名和密码:凡是已有 v2 的,请使用 v2。
迁移到 API v2API 文档
SparkTG 云电话 API 参考
SparkTG 云电话 API
简介
SparkTG 是一家云电话服务提供商。云电话是一种按需服务,为提供产品和服务的组织提供强大而可靠的电话功能。
网络访问: 各项能力通过网络提供,并通过标准机制访问。用户可以随时随地登录并控制自己的服务。
资源池化: 电信资源通过多租户模型进行池化,以服务多个客户,物理和虚拟资源会根据需求动态分配和重新分配。这降低了自建电话服务的开发成本,并且只需为实际使用的资源付费。
弹性: 电话端口可以快速、弹性地配置(在某些情况下自动完成),以便灵活地向上扩展,并可快速释放以向下缩减。
计量服务: 云系统通过计量能力自动控制和优化资源使用,其抽象层级与服务类型相适应(例如呼入通话数、呼出通话数和骚扰来电数)。资源使用情况可以被监控、控制和报告,为服务提供方和使用方双方提供透明度。基于这些目标,SparkTG 为其大部分服务提供 API,方便客户将其轻松测试并集成到自己的应用程序(网页、桌面或移动端)中。
前提条件
本文档面向开发人员,需要对 SparkTG 云电话平台有基本了解。在客户可以在其应用程序中使用 API 服务之前,SparkTG 需要提前为每位客户开通 API 服务。
发送基本认证标头: 我们提供基于 REST 的 API,采用基本认证。您需要自行发送基本认证标头,为此需要传递格式为 username:password 的字符串。
云电话
按需提供的电话服务,为企业可靠地提供强大功能。可随时随地通过网络访问各项能力。
资源池化
多租户模式,动态分配资源。按实际用量付费,降低自主开发成本。
弹性伸缩
可自动快速开通电话端口以横向扩容,并在需要时迅速释放以缩容。
计量服务
具备计量能力的自动化资源控制。服务提供方与使用方均可透明地监控用量。
基本认证
我们使用基于 REST 的 API 并采用基本认证。您需要自行发送基本认证标头,为此需要传递格式为 username:password 的字符串。
认证格式:
username:password将其放入 Authorization 请求头,或使用 curl -u 参数
开发者要求
• 需具备 SparkTG 云电话平台的基础知识
• SparkTG 必须提前为每位客户开通 API 服务
• 基于 REST 的 API,支持基本认证
• 兼容网页、桌面和移动应用
入门指南
1. 申请 API 访问权限
联系 SparkTG,为您的客户账户开通 API 服务。
2. 获取凭据
获取用于基本认证的 username:password 凭据。
3. 选择 API
可选择通话管理、坐席 API、消息服务等。
4. 集成
在您的网页、桌面或移动应用中使用 REST 端点。
可用的 API 类别
坐席管理
登录、状态、休息及坐席配置
通话管理
外呼、转接、预约及通话控制
消息与 OTP
短信和 OTP 验证服务
数据分析
通话记录、报表及仪表盘数据
实时事件
WebSocket 事件与 Webhook 集成
配置
转接设置与服务配置
