ListJobs-阿里云帮助中心

Queries multiple 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	af81a389-91f0-4157-8d82-720edd02b66a
JobId	array	Yes	The list of job IDs. A maximum of 99 child items are allowed.	24fb9a8d-f20e-4ee2-a11c-094dda68c5cc
	string	No	The job ID.	24fb9a8d-f20e-4ee2-a11c-094dda68c5cc

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The response code.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
Jobs	array<object>	The list of jobs.
	array<object>
Status	string	The job status. Valid values: Scheduling: The job is being scheduled. Executing: The job is being executed. Succeeded: The job succeeded. Paused: The job is suspended. Failed: The job failed. Cancelled: The job is cancelled. Drafted: The job is in draft state.	Succeeded
ScenarioId	string	The scenario ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
JobGroupId	string	The job group ID.	fce6c599-8ede-40e3-9f78-0928eda7b4e8
StrategyId	string	The strategy ID.	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
JobId	string	The job ID.	b72425bd-7871-4050-838e-033d80d754b7
Priority	integer	The job priority.	5
SystemPriority	integer	The system priority.	1
FailureReason	string	The reason why the job failed.	NoAnswer
ReferenceId	string	The business ID of the job, which is custom-defined by the caller. Note This is the ContactId value that was uploaded.	d5971d98-7312-4f0e-a918-a17d67133e28
Contacts	array<object>	The list of contacts.
	object
PhoneNumber	string	Phone number	135****8888
State	string	Status. Deprecated.	Available
ContactId	string	Contact ID. Generated by the system.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	Honorific. Same as the contact name.	张先生
JobId	string	Job ID. Deprecated.	72dcd26b-f12d-4c27-b3af-18f6aed5b160
ContactName	string	Contact name	张三
Role	string	Contact role. Deprecated.	*
ReferenceId	string	Third-party system ID for the contact	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extras	array<object>	The list of business parameters. Note TenantId and ServiceId are generated by the system. Other parameters are custom-defined and passed in by the caller.
	object
Key	string	Business parameter key	name
Value	string	Business parameter value	张三
Summary	array<object>	The conversation label data. In large model scenarios, this contains the label hit data after the conversation ends. In small model scenarios, this contains the variable value data after the conversation ends.
	object
SummaryName	string	Tag name	score
Category	string	Conversation summary category	{}
Content	string	Tag value	5
Tasks	array<object>	The list of tasks.
	array<object>
Status	string	Note: The Succeeded status is now split into specific reasons. The generic Succeeded: 1 (Connected) status is no longer returned. Instead, specific reason types are returned. Executing: 0 (Dialing). Succeeded: 1 (Connected). NoAnswer: 2 (Not connected — No answer). NotExist: 3 (Not connected — Nonexistent number). Busy: 4 (Not connected — Busy). Cancelled: 5 (Not dialed — Task stopped). Failed: 6 (Failed). NotConnected: 7 (Not connected — Unreachable). PoweredOff: 8 (Not connected — Powered off). OutOfService: 9 (Not connected — Out of service). InArrears: 10 (Not connected — Overdue payment). EmptyNumber: 11 (Not dialed — Empty number). PerDayCallCountLimit: 12 (Not dialed — Daily call limit exceeded). ContactBlockList: 13 (Not dialed — Blacklisted). CallerNotRegistered: 14 (Not dialed — Caller number not registered). Terminated: 15 (Not dialed — Terminated). VerificationCancelled: 16 (Not dialed — Verification failed before call). OutOfServiceNoCall: 17 (Not dialed — Out of service). InArrearsNoCall: 18 (Not dialed — Overdue payment). CallingNumberNotExist: 19 (Not dialed — Caller number does not exist). SucceededFinish: 20 (Connected — Normal end). SucceededChatbotHangUpAfterNoAnswer: 21 (Connected — Bot hung up after no recognition). SucceededChatbotHangUpAfterSilence: 22 (Connected — Bot hung up after silence timeout). SucceededClientHangUpAfterNoAnswer: 23 (Connected — User hung up after no recognition). SucceededClientHangUp: 24 (Connected — User hung up without reason). SucceededTransferByIntent: 25 (Connected — Transferred to agent after intent match). SucceededTransferAfterNoAnswer: 26 (Connected — Transferred to agent after no recognition). SucceededInoInterAction: 27 (Connected — No interaction from user side). SucceededError: 28 (Connected — System error interrupted). SucceededSpecialInterceptVoiceAssistant: 29 (Connected — Intercepted for special case — Voice assistant). SucceededSpecialInterceptExtensionNumberTransfer: 30 (Connected — Intercepted for special case — Extension transfer). SucceededSpecialInterceptCustomSpecialIntercept: 31 (Connected — Intercepted for special case — Custom interception). HighRiskSipCode: 32 (Not dialed — High risk).	Succeeded
PlanedTime	integer	Scheduled execution time	1579068424883
ChatbotId	string	Chatbot ID	1234
ActualTime	integer	Actual execution time	1579068424883
CalledNumber	string	Called number	135****8888
ScenarioId	string	Scenario ID. Legacy parameter. Deprecated.	ade80092-03d9-4f4d-ad4f-ab8a247d3150
JobId	string	Job ID	b72425bd-7871-4050-838e-033d80d754b7
CallId	string	Call ID	1528189846043
CallingNumber	string	Calling number	0571****3106
Brief	string	Business result. Legacy parameter. Deprecated.	1
Duration	integer	The duration of the task.	120
TaskId	string	Task ID	ff44709e-39a6-43ba-959b-20fcabe3e496
Conversation	array<object>	Conversation list
	array<object>
Speaker	string	Who spoke: Robot or Contact	Robot
Timestamp	integer	Timestamp when the conversation text was stored	1579068424883
Script	string	Conversation text	你好，我是**客服
Summary	array<object>	Summary information. Deprecated.
	object
SummaryName	string	Summary name	是本人
Category	string	Category	标签
Content	string	Summary content	是
Contact	object	Contact for the task
PhoneNumber	string	Phone number	135****8888
State	string	Status	Available
ContactId	string	Contact ID	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	Honorific. If empty, defaults to the contact name.	张先生
JobId	string	Job ID. Deprecated.	b72425bd-7871-4050-838e-033d80d754b7
ContactName	string	Contact name	张三
Role	string	Role	*
ReferenceId	string	Third-party system ID for the contact	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
CallingNumbers	array	The list of calling numbers.
	string	The list of calling numbers.	["0571****3106"]

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Jobs": [
    {
      "Status": "Succeeded",
      "ScenarioId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
      "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
      "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
      "Priority": 5,
      "SystemPriority": 1,
      "FailureReason": "NoAnswer",
      "ReferenceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
      "Contacts": [
        {
          "PhoneNumber": "135****8888",
          "State": "Available",
          "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
          "Honorific": "张先生",
          "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5b160",
          "ContactName": "张三",
          "Role": "*",
          "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
        }
      ],
      "Extras": [
        {
          "Key": "name",
          "Value": "张三"
        }
      ],
      "Summary": [
        {
          "SummaryName": "score",
          "Category": "\t{}",
          "Content": "5"
        }
      ],
      "Tasks": [
        {
          "Status": "Succeeded",
          "PlanedTime": 1579068424883,
          "ChatbotId": "\t1234",
          "ActualTime": 1579068424883,
          "CalledNumber": "135****8888",
          "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
          "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
          "CallId": "1528189846043",
          "CallingNumber": "0571****3106",
          "Brief": "1",
          "Duration": 120,
          "TaskId": "ff44709e-39a6-43ba-959b-20fcabe3e496",
          "Conversation": [
            {
              "Speaker": "Robot",
              "Timestamp": 1579068424883,
              "Script": "你好，我是**客服",
              "Summary": [
                {
                  "SummaryName": "是本人",
                  "Category": "标签",
                  "Content": "是"
                }
              ]
            }
          ],
          "Contact": {
            "PhoneNumber": "135****8888",
            "State": "Available",
            "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
            "Honorific": "张先生",
            "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
            "ContactName": "张三",
            "Role": "*",
            "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
          }
        }
      ],
      "CallingNumbers": [
        "[\"0571****3106\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.