StartJob - 创建一个作业_智能外呼机器人(Outbound Bot)-阿里云帮助中心

不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。

调试

您可以在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 //额外信息，非必填 key //自定义变量内容 key value //自定义变量内容 value contacts // 必填字段，被叫人联系信息 phoneNumber // 必填字段，被叫人电话号码 referenceId // 必填字段，联系人 ID（用户自定义），主要是避免重名现象 role //非必填字段，该联系人在此外呼业务中的角色，不指定则不区分 honorific //非必填字段，联系人尊称 name //非必填字段，联系人姓名	{ "extras": [{ "value": "测试", "key": "测试" }, { "key": "ServiceId", "value": null }, { "key": "TenantId", "value": null }], "contacts": [{ "phonenumber": "198********", "name": "张三", "priority": 5, "referenceId": "C01" }] }
ScriptId	string	否	场景 ID(必填)	1eeae263-54ca-4a52-ae14-62da58f3c473
CallingNumber	array	否	主叫号码列表
	string	否	主叫号码	05710*******

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码	200
Code	string	接口状态码	OK
Message	string	接口提示信息	Success
RequestId	string	请求 ID	8a621aa1-d2e7-43f3-b54d-8830af73c468
Success	boolean	表示是否调用成功。true：调用成功。 false：调用失败。	true
TaskIds	array<object>	联系人第三方 id 和外呼系统任务 id 的映射
KeyValuePair	object
Key	string	联系人第三方 id	c93cdd1c-f9b5-4758-be43-7a237a7eaa1d
Value	string	外呼系统任务 id	62229628-45d8-41bd-a80f-6e4c0a39f79b
CallIds	array<object>	通话 ID 列表
KeyValuePair	object
Key	string	联系人第三方 id。	c93cdd1c-f9b5-4758-be43-7a237a7eaa1d
Value	string	任务的 Callid	62229628-45d8-41bd-a80f-6e4c0a39f79b

示例

正常返回示例

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.	内部错误。建议重试，如果多次重试报错请提交工单。

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史