StartJob-阿里云帮助中心

This API initiates a call directly, bypassing the outbound call scheduling system. It is available only to users on the whitelist.

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:StartJob

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	da37319b-6c83-4268-9f19-814aed62e401
JobGroupId	string	No	Task group ID	4f21446e-324e-46f2-bf62-7f341fb004ea
ScenarioId	string	No	Scenario ID. This field supports backward compatibility with legacy outbound calling features. You can omit it.	af81a389-91f0-4157-8d82-720edd02b66a
JobJson	string	Yes	Job data, which includes the following fields: extras // Optional extra information key // Key for a custom variable value // Value for a custom variable contacts // Required contact information for the callee phoneNumber // Required phone number of the callee referenceId // Required contact ID (user-defined) to avoid duplicate names role // Optional role of this contact in the outbound call scenario. If omitted, no role distinction is made honorific // Optional honorific for the contact name // Optional name of the contact	{ "extras": [{ "value": "测试", "key": "测试" }, { "key": "ServiceId", "value": null }, { "key": "TenantId", "value": null }], "contacts": [{ "phonenumber": "198********", "name": "张三", "priority": 5, "referenceId": "C01" }] }
ScriptId	string	No	Scenario ID (required)	1eeae263-54ca-4a52-ae14-62da58f3c473
CallingNumber	array	No	List of caller numbers	10086
	string	No	Caller number	05710*******

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
Code	string	API status code	OK
Message	string	API message	Success
RequestId	string	Request ID	8a621aa1-d2e7-43f3-b54d-8830af73c468
Success	boolean	Indicates whether the call succeeded. true means success. false means failure.	true
TaskIds	array<object>	Mapping between third-party contact IDs and outbound call task IDs
	object
Key	string	Third-party contact ID	c93cdd1c-f9b5-4758-be43-7a237a7eaa1d
Value	string	Outbound call task ID	62229628-45d8-41bd-a80f-6e4c0a39f79b
CallIds	array<object>	List of call IDs
	object
Key	string	Third-party contact ID	c93cdd1c-f9b5-4758-be43-7a237a7eaa1d
Value	string	Call ID for the task	62229628-45d8-41bd-a80f-6e4c0a39f79b

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

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.JobGroup	The specified JobGroup does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.