发起机器人外呼。支持根据配置好的机器人ID,即话术ID,通过外呼主叫号码呼叫被叫号码,可选择通话过程是否录音等功能。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CalledShowNumber | string | 是 | 外呼主叫号码。 | 0571****5678 |
CalledNumber | string | 是 | 被叫号码。 | 131****2204 |
RobotId | long | 是 | 机器人 ID,即话术 ID。 您可以在智能联络中心控制台左侧导航栏的智能外呼机器人>话术管理中获取。 | 350000**** |
OutId | string | 否 | 预留给调用方使用的 ID。 最终会通过在回执消息中将此 ID 带回给调用方。字符串类型,长度为 1~15 个字节。 | abcdefgh |
RecordFlag | boolean | 否 | 通话过程是否录音。取值:
| true |
EarlyMediaAsr | boolean | 否 | 是否启用号码状态(早媒体)识别标识。取值:
说明
设为 true 会记录通话未接听的原因。
| false |
Params | string | 否 | 机器人的参数列表。JSON 格式。总长度不要超过 512 个字节。 | {"name":"张三","age":"25"} |
返回参数
示例
正常返回示例
JSON
格式
{
"Message": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Data": "116012854210^10281427*****",
"Code": "OK"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Permission.NotAuthorized | Insufficient permissions. Please contact the primary account administrator. | 权限不足,请联系主账号管理员 |
400 | Parameter.Error | Parameter error. | 参数错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-05-19 | 新增 OpenAPI | 看变更集 |