发起智能联络机器人呼出。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CalledShowNumber |
string |
是 |
呼出主叫号码。在语音服务真实号管理界面查看。 |
132****0849 |
| CalledNumber |
string |
是 |
被叫号码。 |
131****2204 |
| RobotId |
integer |
是 |
机器人 ID,即话术 ID。在话术管理界面查看审核通过的话术 ID。 |
1000035****** |
| OutId |
string |
否 |
预留给调用方使用的 ID,最终会通过回执消息将此 ID 带回给调用方,长度为 1~15 个字节。 |
222356**** |
| RecordFlag |
boolean |
否 |
通话过程是否录音。取值:
|
true |
| EarlyMediaAsr |
boolean |
否 |
是否启用号码状态识别标识。取值:
说明
启用后会记录通话未接听的原因。 |
false |
| Params |
string |
否 |
机器人的参数列表。JSON 格式。总长度不要超过 512 个字节。在话术管理>详情>输出输入参数中查看或通过 ListRobotParams 接口查看。 |
{ "name": "张三", "age": "25" } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Message |
string |
状态码的描述。 |
OK |
| RequestId |
string |
请求 ID。 |
A90E4451-FED7-49D2-87C8-00700A8C4D0D |
| Data |
string |
此次通话的唯一回执 ID,即呼叫唯一 ID。 |
1160128*****^10281427***** |
| Code |
string |
请求状态码。返回 OK 代表请求成功。 |
OK |
示例
正常返回示例
JSON格式
{
"Message": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Data": "1160128*****^10281427*****",
"Code": "OK"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Permission.NotAuthorized | Insufficient permissions. Please contact the primary account administrator. | 权限不足,请联系主账号管理员 |
| 400 | Parameter.Error | Parameter error. | 参数错误 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。