不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| outboundbot:StartJob | none | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 id | da37319b-6c83-4268-9f19-814aed62e401 |
| JobGroupId | string | 否 | 作业组 id | 4f21446e-324e-46f2-bf62-7f341fb004ea |
| ScenarioId | string | 否 | 场景 id，为了兼容旧版外呼功能。可不填。 | af81a389-91f0-4157-8d82-720edd02b66a |
| JobJson | string | 是 | 作业数据 | {"extras":[{"value":"2019-08-21 09:49:59.0","key":"djrq"}],"contacts":[{"phonenumber":"1816*******","name":"张三","referenceId":"2c9a9a7c6caedab6016cb1ddd13325ed","honorific":"张先生"}]} |
| ScriptId | string | 否 | 话术 id，2020 年 2 月份后创建的话术，该字段必填 | b9ff4e88-65f9-4eb3-987c-11ba51f3f24d |
| CallingNumber | array | 否 | 主叫号码列表 | |
| string | 否 |
返回参数
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "8a621aa1-d2e7-43f3-b54d-8830af73c468",
"Success": true,
"TaskIds": [
{
"Key": "c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
"Value": "62229628-45d8-41bd-a80f-6e4c0a39f79b"
}
],
"CallIds": [
{
"Key": "c93cdd1c-f9b5-4758-be43-7a237a7eaa1d",
"Value": "62229628-45d8-41bd-a80f-6e4c0a39f79b"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
| 404 | NotExist.JobGroup | The specified JobGroup does not exist. | 指定的任务组不存在。 |
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试，如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史