文档

RobotCall - 发起机器人外呼

更新时间:

调用RobotCall接口发起机器人外呼。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
CalledShowNumberstring

外呼主叫号码。

0571****5678
CalledNumberstring

被叫号码。

131****2204
RobotIdlong

机器人 ID,即话术 ID。 您可以在智能联络中心控制台左侧导航栏的智能外呼机器人>话术管理中获取。

350000****
OutIdstring

预留给调用方使用的 ID。

最终会通过在回执消息中将此 ID 带回给调用方。字符串类型,长度为 1~15 个字节。

abcdefgh
RecordFlagboolean

通话过程是否录音。取值:

  • false(默认值):不录音。
  • true:录音。
true
EarlyMediaAsrboolean

是否启用号码状态(早媒体)识别标识。取值:

  • false(默认值):不启用。
  • true:启用。
说明 设为 true 会记录通话未接听的原因。
false
Paramsstring

机器人的参数列表。JSON 格式。总长度不要超过 512 个字节。

{"name":"张三","age":"25"}

返回参数

名称类型描述示例值
object

返回数据。

Messagestring

状态码的描述。

OK
RequestIdstring

请求 ID。

A90E4451-FED7-49D2-87C8-00700A8C4D0D
Datastring

此次通话的唯一回执 ID。

116012854210^10281427*****
Codestring

请求状态码。返回 OK 代表请求成功。

OK

示例

正常返回示例

JSON格式

{
  "Message": "OK",
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Data": "116012854210^10281427*****",
  "Code": "OK"
}

错误码

HTTP status code错误码错误信息描述
400Permission.NotAuthorizedInsufficient permissions. Please contact the primary account administrator.权限不足,请联系主账号管理员
400Parameter.ErrorParameter error.参数错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-05-19新增 OpenAPI看变更集
  • 本页导读 (1)