CreateCampaign - 创建外呼任务-智能外呼机器人(Outbound Bot)-阿里云帮助中心

创建外呼活动。

接口说明

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:CreateCampaign

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 id	12f3dd08-0c55-44ce-9b64-e69d35ed3a76
Name	string	是	任务名称	修改后的作业组
StartTime	integer	是	任务开始时间	1578965079000
EndTime	integer	是	任务结束时间	1579965079000
CallableTime	string	是	任务的可外呼时段，格式为 JSON 对象，对象包含两个属性，beginTime 和 EndTime。	[{"beginTime":"09:00:00","endTime":"18:00:00" }]。
CaseFileKey	string	否	任务名单，是一个 OSS 对象的 Key，通过 GenerateFileUploadParams 接口获取。也可以不设置，后续通过 AppendCases 接口追加联系人。	cases/customer.csv
Cases	array<object>	否	联系人列表。也可以不设置，后续通过 AppendCases 接口追加联系人。
	object	否	联系人列表。
ReferenceId	string	否	联系人业务 ID。	bizId-1
PhoneNumber	string	否	联系人号码。	133********
CustomVariables	string	否	客户自定义变量，格式为 JSON 对象，对象最多包含 10 个属性，每个属性的名称和值均由客户自定义。	{"key1":"value1"}
Priority	string	否	联系人优先级。默认 1	1
ScriptId	string	是	场景 ID。	aa279896-64a6-4182-864c-4f2b04ec8d17
MaxAttemptCount	integer	是	最大尝试次数，表示当号码呼叫失败时，最多呼几次。	2
MinAttemptInterval	integer	是	尝试间隔时间	5
Numbers	array	否	外呼任务的主叫号码列表。
	string	否	主叫号码。	010********
RunUntilEndTime	boolean	否	联系人均拨打完成时是否持续保持调度状态至活动结束时间，默认 fasle; true, 任务仍然处于调度状态，可以继续追加名单。 false,任务改变为已完成，不可追加名单。	false
DialingTimeoutSeconds	integer	否	外呼超时时间（秒），默认 25	25
FixedQuota	integer	否	最小并发数。任务设置的最小并发数，0 表示不设保底，按权重分配。若多个活动都设置了最小并发如果总并发小于实例总并发，优先满足每个任务的“最小并发”，多出的资源按权重比例额外分配。如果总并发大于实例总并发，“最小并发”不再作为保底值，而是作为权重因子参与计算。	0
RedialRestrictions	string	否	外呼尝试限制条件列表,不传表示不限制。 CALLEE_NOT_EXISTS 空号不外呼 OUT_OF_SERVICE 停机不外呼	无
HolidayRestricted	boolean	否	节假日禁止外呼	false
AttemptOrder	string	否	呼叫执行顺序，默认 MIN_ATTEMPT_FIRST PRIORITY_FIRST，按优先级优先 MIN_ATTEMPT_FIRST，按尝试次数优先	MIN_ATTEMPT_FIRST
FlashSmsParameters	string	否	闪信参数	{}
Weight	integer	否	权重，为范围 0～100 的整数。值越大，调度时分配的并发越多。	50

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 返回码。	200
Code	string	接口状态码。	OK
Message	string	接口提示信息	Success
RequestId	string	请求 ID。	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功	true
Data	string	返回数据，任务 ID。	4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b15
Params	array	错误信息中的变量值
	string	错误信息中的变量值	4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Data": "4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b15",
  "Params": [
    "4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04"
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。