CreateBatchJobs-阿里云帮助中心

Deprecated. Do not use this operation to batch-create outbound calling jobs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:CreateBatchJobs

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID of the instance.	174952ab-9825-4cc9-a5e2-de82d7fa4cdd
BatchJobName	string	Yes	Name of the batch job.	第一个作业组
BatchJobDescription	string	No	Description of the batch job.	描述
ScenarioId	string	No	ID of the scenario.	c6a668d1-3145-4048-9101-cb3678bb8884
ScriptId	string	No	ID of the script.	b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
StrategyJson	string	No	JSON string that defines the job execution policy. Required.	{"maxAttemptsPerDay":2,"name":"策略名字","workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"13:00:00","endTime":"18:30:00"}],"minAttemptInterval":60}
JobFilePath	string	No	Path to the Excel file that contains the batch job data. Note Get this value from the Folder parameter in the response of the GetJobDataUploadParams operation.	52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx
Submitted	boolean	Yes	Indicates whether the job is submitted. Set to false to submit the job. Set to true to save it as a draft.	false
CallingNumber	array	No	List of caller numbers.	["95187"]
	string	No	Caller number.	["4008013260"]

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
Code	string	API status code.	OK
Message	string	Response message.	Success
RequestId	string	ID of the request.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the call succeeded.	true
BatchJob	object	Information about the job group.
CreationTime	integer	Time when the job group was created.	1579068424000
ScenarioId	string	ID of the scenario for the job group.	6cea9bed-63e6-439e-ae4c-b3333efff53d
JobGroupName	string	Name of the job group.	批量作业01
BatchJobId	string	ID of the job group.	5a7e8b09-baf9-4cab-b540-c971f47a7146
JobFilePath	string	Key of the uploaded Excel file.	52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx
JobGroupDescription	string	Description of the job group.	第一个批量作业
CallingNumbers	array	List of caller numbers.
	string	A list of calling numbers.	["4008013260 "]
Strategy	object	Job execution policy.
Type	string	Type of the policy.	Repeatable
StrategyName	string	Name of the policy.	策略
MaxAttemptsPerDay	integer	Maximum number of retries per day after a failed call.	3
FollowUpStrategy	string	Action to take for outbound calls that were not completed in the previous cycle.	CONTINUE
EndTime	integer	End time of the scheduling policy.	2209702074000
Customized	string	Custom information for the policy.	{}
IsTemplate	boolean	Indicates whether the policy is a template.	false
StartTime	integer	Start time when the job group begins execution.	1578550074000
StrategyId	string	ID of the policy.	f718798d-96be-40e4-bef6-317b54855708
RoutingStrategy	string	Recording policy for caller numbers.	LocalFirst
MinAttemptInterval	integer	Minimum interval between retries.	10
StrategyDescription	string	Description of the policy.	作业执行策略
RepeatBy	string	How often the job repeats. Valid values: Once, Day, Week, and Month.	Once
WorkingTime	array<object>	Time periods during which the job runs each day.
	object
EndTime	string	End time.	12:00:00
BeginTime	string	Start time.	09:00:00
RepeatDays	array	List of days on which the job repeats.
	string	Day on which the job repeats.	[1,2,3,4,5]

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "BatchJob": {
    "CreationTime": 1579068424000,
    "ScenarioId": "6cea9bed-63e6-439e-ae4c-b3333efff53d",
    "JobGroupName": "批量作业01",
    "BatchJobId": "5a7e8b09-baf9-4cab-b540-c971f47a7146",
    "JobFilePath": "52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx",
    "JobGroupDescription": "第一个批量作业",
    "CallingNumbers": [
      "[\"4008013260 \"]"
    ],
    "Strategy": {
      "Type": "Repeatable",
      "StrategyName": "策略",
      "MaxAttemptsPerDay": 3,
      "FollowUpStrategy": "CONTINUE",
      "EndTime": 2209702074000,
      "Customized": "{}",
      "IsTemplate": false,
      "StartTime": 1578550074000,
      "StrategyId": "f718798d-96be-40e4-bef6-317b54855708",
      "RoutingStrategy": "LocalFirst",
      "MinAttemptInterval": 10,
      "StrategyDescription": "作业执行策略",
      "RepeatBy": "Once",
      "WorkingTime": [
        {
          "EndTime": "12:00:00",
          "BeginTime": "09:00:00"
        }
      ],
      "RepeatDays": [
        "[1,2,3,4,5]"
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.
404	NotExist.Script	The specified Script does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.