QueryJobs-阿里云帮助中心

Queries a list of 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
ScenarioId	string	No	The scenario ID. This is a legacy parameter that has been deprecated.	b0f35dd1-0337-402e-9c4f-3a6c2426950a
JobGroupId	string	No	The job group ID.	994b8baf-7ef8-480c-b141-b7b6db77c4df
StartTime	integer	No	The filter condition for the start time. The default value is 0, which indicates the start of the current day (00:00).	1579068424883
EndTime	integer	No	The filter condition for the end time. The default value is 0, which indicates the current time.	1579077794665
TimeAlignment	string	No	Specifies whether to query by start time, end time, or job creation time. Valid values: start, end, job_create.	start
ContactName	string	No	The filter condition for the contact name.	John
PhoneNumber	string	No	The filter condition for the contact phone number.	135****8888
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The page size.	10

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The response code.	200
Code	string	The HTTP status 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	object	The job data.
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
TotalCount	integer	The total number of records.	1
List	array<object>	The job array.
	array<object>
Status	string	The job status. Valid values: Scheduling(0): scheduling in progress. Executing(1): executing. Succeeded(2): ended - reached. Paused(3): paused. Failed(4): ended - not reached. Cancelled(5): cancelled - manual intervention. Drafted(6): draft.	Succeeded
JobGroupId	string	The task ID.	fce6c599-8ede-40e3-9f78-0928eda7b4e8
ScenarioId	string	[Deprecated] The scenario ID. This is a legacy parameter and is no longer used.	ade80092-03d9-4f4d-ad4f-ab8a247d3150
StrategyId	string	The strategy ID.	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
JobId	string	The job ID.	fce6c599-8ede-40e3-9f78-0928eda7b4e8
Priority	integer	The priority.	1
FailureReason	string	The failure reason. Valid values: Unknown: unknown error. NoAnswer: no answer. InvalidStrategy: invalid strategy. The strategy configuration is incorrect. TimeUp: timeout detected during scheduling. NoStrategy: strategy is empty or not found. CallFailed: call failed. PerDayCallCountLimit: daily call count limit for the number. ContactBlockList: contact is on the block list. EmptyNumber: nonexistent number, no further outbound calls. JobPerDayCallCountLimit: daily call count limit for the number. VerificationCancelled: pre-call verification failed, call cancelled. ContactSuspended: call suspended. InArrears: overdue payment. OutOfService: out of service.	NoAnswer
ReferenceId	string	The associated business ID.	d5971d98-7312-4f0e-a918-a17d67133e28
Contacts	array<object>	[Deprecated] The contact information. This parameter is deprecated. Note You can obtain this information through the DescribeJob operation.
	object
PhoneNumber	string	The phone number.	135****8888
State	string	The status. Valid values: Available: normal. WrongNumber: wrong number. DoesNotExist: nonexistent number. Suspended: call suspended.	Available
ContactId	string	The contact ID.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	The honorific title.	Mr. Zhang
JobId	string	The job ID.	fce6c599-8ede-40e3-9f78-0928eda7b4e8
ContactName	string	The contact name.	John
Role	string	The role.	*
ReferenceId	string	The associated business ID.	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extras	array<object>	The business data. Displays tag collection information for large language model scenarios. Note Keys equal to TenantId or ServiceId are system parameters.
	object
Key	string	The business data key.	djrq
Value	string	The business data value.	2019-08-21 09:49:59.0
Summary	array<object>	[Deprecated] The conversation summary. This is a legacy field and is no longer used.
	object
SummaryName	string	The summary name.	score
GroupId	string	The task ID.	ba1ba502-d044-48c0-b710-0f1f840a7c53
JobId	string	The job ID.	b72425bd-7871-4050-838e-033d80d754b7
Category	string	The category.	{}
TaskId	string	The call ID.	9fdf7a81-6781-4ab8-92fb-1d4231ef365e
Content	string	The content.	5
ConversationDetailId	string	The call record ID.	098b9b09-9223-4a8b-a422-99726f0457f3
SummaryId	string	The summary ID.	dc67d544-df06-4625-ae48-13e3c9f72d8a
Tasks	array<object>	[Deprecated] The call list. This parameter is deprecated. Note You can obtain this information through the searchTask operation.
	array<object>
Status	string	The task status. Note: The Succeeded status has been subdivided into specific reasons and will no longer be displayed as Succeeded: 1 (connected). Subsequent responses return the specific sub-reason type. Valid values: Executing: 0 (dialing in progress). 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 - callee out of service). InArrears: 10 (not connected - callee has overdue payment). EmptyNumber: 11 (not dialed - nonexistent number, no outbound call). PerDayCallCountLimit: 12 (not dialed - daily limit exceeded). ContactBlockList: 13 (not dialed - blocked). CallerNotRegistered: 14 (not dialed - caller number not registered). Terminated: 15 (not dialed - terminated). VerificationCancelled: 16 (not dialed - pre-call verification failed, cancelled). OutOfServiceNoCall: 17 (not dialed - callee out of service, no outbound call). InArrearsNoCall: 18 (not dialed - callee has overdue payment, no outbound call). CallingNumberNotExist: 19 (not dialed - caller number does not exist). SucceededFinish: 20 (connected - normal completion). SucceededChatbotHangUpAfterNoAnswer: 21 (connected - robot hung up after no recognition). SucceededChatbotHangUpAfterSilence: 22 (connected - silence timeout, hung up). SucceededClientHangUpAfterNoAnswer: 23 (connected - user hung up after no recognition). SucceededClientHangUp: 24 (connected - user hung up without reason). SucceededTransferByIntent: 25 (connected - intent matched, transferred to agent). SucceededTransferAfterNoAnswer: 26 (connected - no recognition, transferred to agent). SucceededInoInterAction: 27 (connected - no interaction from user side). SucceededError: 28 (connected - system exception interrupted). SucceededSpecialInterceptVoiceAssistant: 29 (connected - special intercept - voice assistant). SucceededSpecialInterceptExtensionNumberTransfer: 30 (connected - special intercept - extension number transfer). SucceededSpecialInterceptCustomSpecialIntercept: 31 (connected - special intercept - custom intercept). HighRiskSipCode: 32 (not dialed - high risk, no outbound call).	Succeeded
PlanedTime	integer	The planned outbound call time.	1579068424883
ChatbotId	string	The robot ID.	1234
ActualTime	integer	The actual outbound call time.	1579068424883
CalledNumber	string	The called number.	135****8888
ScenarioId	string	The scenario ID.	ade80092-03d9-4f4d-ad4f-ab8a247d3150
JobId	string	The job ID.	b72425bd-7871-4050-838e-033d80d754b7
CallId	string	SIP call ID。	1528189846043
CallingNumber	string	The calling number.	0571****3106
Brief	string	The summary. This is a legacy field and is no longer used.	1
Duration	integer	The call duration.	120
TaskId	string	The call ID.	ff44709e-39a6-43ba-959b-20fcabe3e496
Contact	object	The contact information.
PhoneNumber	string	The phone number of the contact.	135****8888
State	string	The status.	Available
ContactId	string	The contact ID.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	The honorific title.	Mr. Zhang
JobId	string	The job ID.	b72425bd-7871-4050-838e-033d80d754b7
ContactName	string	The contact name.	John
Role	string	The role.	*
ReferenceId	string	The associated business ID.	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
CallingNumbers	array	The list of calling numbers.
	string	The list of calling numbers.	["0571****3106"]
TagHits	array<object>	The tag hit information in small model scenarios.
	object
TagName	string	The tag name.	Interested
TagGroup	string	The tag group name.	Intent collection

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Jobs": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "Status": "Succeeded",
        "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
        "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
        "JobId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "Priority": 1,
        "FailureReason": "NoAnswer",
        "ReferenceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
        "Contacts": [
          {
            "PhoneNumber": "135****8888",
            "State": "Available",
            "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
            "Honorific": "张先生",
            "JobId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8\n",
            "ContactName": "张三",
            "Role": "*",
            "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
          }
        ],
        "Extras": [
          {
            "Key": "djrq",
            "Value": "2019-08-21 09:49:59.0"
          }
        ],
        "Summary": [
          {
            "SummaryName": "score",
            "GroupId": "ba1ba502-d044-48c0-b710-0f1f840a7c53",
            "JobId": "b72425bd-7871-4050-838e-033d80d754b7\n",
            "Category": "{}",
            "TaskId": "9fdf7a81-6781-4ab8-92fb-1d4231ef365e",
            "Content": "5",
            "ConversationDetailId": "098b9b09-9223-4a8b-a422-99726f0457f3",
            "SummaryId": "dc67d544-df06-4625-ae48-13e3c9f72d8a"
          }
        ],
        "Tasks": [
          {
            "Status": "Succeeded",
            "PlanedTime": 1579068424883,
            "ChatbotId": "1234",
            "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",
            "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\"]"
        ],
        "TagHits": [
          {
            "TagName": "有意向",
            "TagGroup": "意向收集"
          }
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	The specified parameter %s is invalid.
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.