API 能力总览
对接前的第一步:拉取企业下所有项目及其运行状态(运行中/已暂停)和执行模式(流式自动外呼/手动批次),后续所有接口都要用到这里返回的项目 ID。
拉取企业名下及对本企业开放的共享线路,包含运营商、外显号码类型、并发数、每日拨打频次上限等信息,创建项目前先挑好线路。
按数字员工当前话术配置生成对应的 Excel 模板,表头列名就是后续上传时的字段映射依据,不能随意改列名。
上传 Excel 或 CSV(最大 100MB),系统按项目内手机号自动去重,返回成功写入与跳过的数量,方便核对导入结果。
推送线索前调用一次,拿到该数字员工 variables 需要传的准确字段 key(不是 Excel 模板里看到的中文列名),避免字段不匹配被拒绝。
适合用户刚填完表单就要立即外呼的场景。支持 contextId 做业务标识:同号同 contextId 覆盖重排队,同号不同 contextId 可并存,互不打扰。
线索上传后需要显式启动项目才会开始拨打;暂停期间推送的线索会正常入队等待,不会丢失,恢复运行后自动继续拨打。
随时调整最大并发、拨打顺序(先进先出/后进先出)、允许拨打的时间段和绝对禁呼时段,字段全部可选,只改需要的部分。
呼入时可通过 SIP Header 传入自定义参数,系统接收后自动替换进提示词模板,实现"来电即知道对方是谁"的个性化开场。
X-BotId 指定接听的数字员工,X-Call-Params 携带业务参数,X-Call-ID 作为本次呼入的全局唯一标识,事后可凭它接收或查询结果。
所有自定义参数先组成 JSON 对象,再整体做 Base64 编码放入 X-Call-Params,几行代码即可完成编码。
提供标准的 originate + bridge 转发示例,呼入网关按此拼接 Header 即可把电话转接到对应的 AI 数字员工线路。
通话结束后系统主动向接入方的 HTTPS 地址推送话单,5 秒内返回 200 视为接收成功,超时会被判定失败并按配置重推。
每次推送都带 X-Sign 签名,按时间戳、随机串、应用 ID、正文和密钥拼接后取 MD5 或 SHA256,接入方可据此验证请求确实来自平台。
推送失败会按配置重试,接入方应以话单 ID 做幂等处理避免重复入库;即使重推全部失败,也能用查询接口兜底核对遗漏的话单。
创建 API Key 时按最小权限原则勾选:只读查询、线索管理、项目控制、话术改写——权限不够时接口直接返回 403,不会误操作。