SearchTask-阿里云帮助中心

Search for tasks.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	d481cebe-0bb6-4d13-9649-42ce5074fb75
TaskCreateTimeGte	integer	No	Start time of the task Note You must specify both TaskCreateTimeGte and TaskCreateTimeLte. If you omit either, the filter does not work.	1646792941
TaskCreateTimeLte	integer	No	End time of the task Note You must specify both TaskCreateTimeGte and TaskCreateTimeLte. If you omit either, the filter does not work.	1646792941
JobGroupId	string	No	Job group ID	3a30ae7c-27b2-4305-9444-7185ced9d51f
JobGroupNameQuery	string	No	Job group name	国寿财住院保续保_20220301_134130
JobId	string	No	Job ID	11994321-e6bc-47bb-8b1c-8eef8f2f768b
CalledNumber	string	No	Called number	15126426342
UserIdMatch	string	No	User ID. A unique identifier for a user. Note This field is passed when you upload an outbound call list. If you upload the list in JSON format, the user ID is the value of referenceId. If you upload the list as an Excel file, the user ID is the value of contactId.	C01
TaskId	string	No	Task ID	744b27f3-437f-4a8c-a181-f668e492fd24
ActualTimeGte	integer	No	Call start time	1646582400000
ActualTimeLte	integer	No	Call end time	1643126399000
RecordingDurationGte	integer	No	Minimum ring duration, in seconds	10
RecordingDurationLte	integer	No	The minimum ringing duration for the search.	60
PageIndex	integer	No	Page number Note The first page is 0.	2
PageSize	integer	No	Number of items per page Note If you omit this parameter, the default value is 10.	10
OtherId	string	No	Other ID Valid values include the following: sessionID taskid jobid	AVD-2021-39685
SortBy	string	No	Sort field. Default value: actualTime	actualTime
SortOrder	string	No	Sort order. Valid values: asc (ascending) desc (descending). Default value.	desc
CallDurationGte	integer	No	Minimum call duration, in milliseconds	12341155
CallDurationLte	integer	No	Maximum call duration, in milliseconds	12341155
JobStatusStringList	string	No	Job status. Separate multiple statuses with commas. If you specify this parameter, it overrides jobStatusList. Scheduling: The job is being scheduled. Executing: The job is running. Succeeded: The job completed successfully. Paused: The job was paused. Failed: The job failed. Cancelled: The job was cancelled.	Succeeded
TaskStatusStringList	string	No	Call status. Separate multiple statuses with commas. Executing: 0 (Calling). Succeeded: 1 (Connected). NoAnswer: 2 (No answer). NotExist: 3 (Nonexistent number). Busy: 4 (Line busy). Cancelled: 5 (Call canceled due to job stop). Failed: 6 (Call failed). NotConnected: 7 (Cannot connect). PoweredOff: 8 (Phone powered off). OutOfService: 9 (Called number out of service). InArrears: 10 (Called number overdue payment). EmptyNumber: 11 (Empty number, no outbound call). PerDayCallCountLimit: 12 (Daily call limit exceeded). ContactBlockList: 13 (Blacklisted). CallerNotRegistered: 14 (Caller number not registered). Terminated: 15 (Call terminated). VerificationCancelled: 16 (Call canceled due to pre-call validation failure). OutOfServiceNoCall: 17 (Called number out of service, no outbound call). InArrearsNoCall: 18 (Called number overdue payment, no outbound call). CallingNumberNotExist: 19 (Caller number does not exist). SucceededFinish: 20 (Connected and ended normally). SucceededChatbotHangUpAfterNoAnswer: 21 (Connected and robot hung up after rejection). SucceededChatbotHangUpAfterSilence: 22 (Connected and robot hung up after silence timeout). SucceededClientHangUpAfterNoAnswer: 23 (Connected and client hung up after rejection). SucceededClientHangUp: 24 (Connected and client hung up without reason). SucceededTransferByIntent: 25 (Connected and transferred to agent based on intent match). SucceededTransferAfterNoAnswer: 26 (Connected and transferred to agent after rejection). SucceededInoInterAction: 27 (Connected and no interaction from client side). SucceededError: 28 (Connected but system error interrupted). SucceededSpecialInterceptVoiceAssistant: 29 (Connected but intercepted by voice assistant). SucceededSpecialInterceptExtensionNumberTransfer: 30 (Connected but intercepted by extension transfer). SucceededSpecialInterceptCustomSpecialIntercept: 31 (Connected but intercepted by custom rule). HighRiskSipCode: 32 (High-risk SIP code, no outbound call).	Executing
ScriptNameQuery	string	No	Scenario name	国寿财
CallingNumber	string	No	Calling number	051085500215
LabelsJson	array	No	Label-based filter condition for calls Note You can only use labels that have specific enumeration values. For example, labels configured with specific values in Large Language Model (LLM) scenarios.
	string	No	Label name and corresponding label value to filter. Note Filters all calls where the specified label has the specified value. For example: {"ValueList":["Satisfied","Dissatisfied"],"Name":"Satisfaction"} filters calls where the "Satisfaction" label equals "Satisfied" or "Dissatisfied".	{ "ValueList": [ "满意", "不满意" ], "Name": "是否满意" }

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code	200
PageIndex	integer	Page number	0
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request succeeded	true
Code	string	Request status code	OK
Message	string	Response message	Success
PageSize	integer	Number of items per page	10
Total	integer	Total number of items	2
SearchTaskInfoList	array<object>	List of tasks	[]
	array<object>	List of tasks
JobGroupName	string	Job group name	85成新（有笔记划线）2021_11_14_18_00_51
UserId	string	User ID	12334134
ActualTime	integer	Actual execution time	1643436089677
CalledNumber	string	Called number	15205879599
TaskStatusString	string	Task status Executing: 0 (Calling). Succeeded: 1 (Connected). NoAnswer: 2 (No answer). NotExist: 3 (Nonexistent number). Busy: 4 (Line busy). Cancelled: 5 (Call canceled due to job stop). Failed: 6 (Call failed). NotConnected: 7 (Cannot connect). PoweredOff: 8 (Phone powered off). OutOfService: 9 (Called number out of service). InArrears: 10 (Called number overdue payment). EmptyNumber: 11 (Empty number, no outbound call). PerDayCallCountLimit: 12 (Daily call limit exceeded). ContactBlockList: 13 (Blacklisted). CallerNotRegistered: 14 (Caller number not registered). Terminated: 15 (Call terminated). VerificationCancelled: 16 (Call canceled due to pre-call validation failure). OutOfServiceNoCall: 17 (Called number out of service, no outbound call). InArrearsNoCall: 18 (Called number overdue payment, no outbound call). CallingNumberNotExist: 19 (Caller number does not exist). SucceededFinish: 20 (Connected and ended normally). SucceededChatbotHangUpAfterNoAnswer: 21 (Connected and robot hung up after rejection). SucceededChatbotHangUpAfterSilence: 22 (Connected and robot hung up after silence timeout). SucceededClientHangUpAfterNoAnswer: 23 (Connected and client hung up after rejection). SucceededClientHangUp: 24 (Connected and client hung up without reason). SucceededTransferByIntent: 25 (Connected and transferred to agent based on intent match). SucceededTransferAfterNoAnswer: 26 (Connected and transferred to agent after rejection). SucceededInoInterAction: 27 (Connected and no interaction from client side). SucceededError: 28 (Connected but system error interrupted). SucceededSpecialInterceptVoiceAssistant: 29 (Connected but intercepted by voice assistant). SucceededSpecialInterceptExtensionNumberTransfer: 30 (Connected but intercepted by extension transfer). SucceededSpecialInterceptCustomSpecialIntercept: 31 (Connected but intercepted by custom rule). HighRiskSipCode: 32 (High-risk SIP code, no outbound call).	Executing
TaskStatusName	string	Display text for task status Executing: 0 (Calling). Succeeded: 1 (Connected). NoAnswer: 2 (No answer). NotExist: 3 (Nonexistent number). Busy: 4 (Line busy). Cancelled: 5 (Call canceled due to job stop). Failed: 6 (Call failed). NotConnected: 7 (Cannot connect). PoweredOff: 8 (Phone powered off). OutOfService: 9 (Called number out of service). InArrears: 10 (Called number overdue payment). EmptyNumber: 11 (Empty number, no outbound call). PerDayCallCountLimit: 12 (Daily call limit exceeded). ContactBlockList: 13 (Blacklisted). CallerNotRegistered: 14 (Caller number not registered). Terminated: 15 (Call terminated). VerificationCancelled: 16 (Call canceled due to pre-call validation failure). OutOfServiceNoCall: 17 (Called number out of service, no outbound call). InArrearsNoCall: 18 (Called number overdue payment, no outbound call). CallingNumberNotExist: 19 (Caller number does not exist). SucceededFinish: 20 (Connected and ended normally). SucceededChatbotHangUpAfterNoAnswer: 21 (Connected and robot hung up after rejection). SucceededChatbotHangUpAfterSilence: 22 (Connected and robot hung up after silence timeout). SucceededClientHangUpAfterNoAnswer: 23 (Connected and client hung up after rejection). SucceededClientHangUp: 24 (Connected and client hung up without reason). SucceededTransferByIntent: 25 (Connected and transferred to agent based on intent match). SucceededTransferAfterNoAnswer: 26 (Connected and transferred to agent after rejection). SucceededInoInterAction: 27 (Connected and no interaction from client side). SucceededError: 28 (Connected but system error interrupted). SucceededSpecialInterceptVoiceAssistant: 29 (Connected but intercepted by voice assistant). SucceededSpecialInterceptExtensionNumberTransfer: 30 (Connected but intercepted by extension transfer).	正在拨打
JobStatus	integer	Job status 0: Scheduling 1: Executing 2: Succeeded 3: Paused 4: Failed 5: Cancelled	0
DialException	string	Exception details	[{"code":"OutboundCallError.SipCodeError", "params":[{"key":"SipCode","value":"500"}]}]
UserName	string	Username	xxx
CallDurationDisplay	string	Call duration	47″
HasAnswered	boolean	Indicates whether the called party answered	true
JobStatusName	string	Display text for job status 0: Scheduling 1: Executing 2: Succeeded 3: Paused 4: Failed 5: Cancelled	调度中
CallDuration	integer	Call duration, in milliseconds	46000
TaskCreateTime	integer	Task creation time	1646792941
JobStatusString	string	Job status Scheduling (0) Executing (1) Completed—Reached (2) Paused (3) Failed—Line busy (4) Cancelled (5)	Scheduling
HasReachedEndOfFlow	boolean	Indicates whether the conversation ended	true
InstanceId	string	Instance ID	73df6283-26b2-402d-bad0-ffa489923ea1
HasHangUpByRejection	boolean	Indicates whether the call ended due to rejection	true
TaskEndReason	integer	Reason why the task ended FINISHED(1,"Normal completion") CHATBOT_HANGUP_AFTER_NOANSWER(2, "Robot hangup after rejection") CHATBOT_HANGUP_AFTER_SILENCE(3, "Robot hangup after silence timeout") CLIENT_HANGUP_AFTER_NOANSWER(4, "Client hangup after rejection") CLIENT_HANGUP(5, "Client hangup without reason") TRANSFER_BY_INTENT(6, "Transfer to agent based on intent match") TRANSFER_AFTER_NOANSWER(7, "Transfer to agent after rejection") INO_INTERACTION(8, "No interaction from client side") ERROR(9, "System error interrupted") SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "Intercepted by voice assistant") SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "Intercepted by extension transfer")	OutOfService
JobGroupId	string	Job group ID	37db3113-ad34-4ba3-b930-468f016bbf95
TaskStatus	integer	Valid values: Executing: 0 (Calling). Succeeded: 1 (Connected). NoAnswer: 2 (No answer). NotExist: 3 (Nonexistent number). Busy: 4 (Line busy). Cancelled: 5 (Call canceled due to job stop). Failed: 6 (Call failed). NotConnected: 7 (Cannot connect). PoweredOff: 8 (Phone powered off). OutOfService: 9 (Called number out of service). InArrears: 10 (Called number overdue payment). EmptyNumber: 11 (Empty number, no outbound call). PerDayCallCountLimit: 12 (Daily call limit exceeded). ContactBlockList: 13 (Blacklisted). CallerNotRegistered: 14 (Caller number not registered). Terminated: 15 (Call terminated). VerificationCancelled: 16 (Call canceled due to pre-call validation failure). OutOfServiceNoCall: 17 (Called number out of service, no outbound call). InArrearsNoCall: 18 (Called number overdue payment, no outbound call). CallingNumberNotExist: 19 (Caller number does not exist). SucceededFinish: 20 (Connected and ended normally). SucceededChatbotHangUpAfterNoAnswer: 21 (Connected and robot hung up after rejection). SucceededChatbotHangUpAfterSilence: 22 (Connected and robot hung up after silence timeout). SucceededClientHangUpAfterNoAnswer: 23 (Connected and client hung up after rejection). SucceededClientHangUp: 24 (Connected and client hung up without reason). SucceededTransferByIntent: 25 (Connected and transferred to agent based on intent match). SucceededTransferAfterNoAnswer: 26 (Connected and transferred to agent after rejection). SucceededInoInterAction: 27 (Connected and no interaction from client side). SucceededError: 28 (Connected but system error interrupted). SucceededSpecialInterceptVoiceAssistant: 29 (Connected but intercepted by voice assistant). SucceededSpecialInterceptExtensionNumberTransfer: 30 (Connected but intercepted by extension transfer).	0
JobId	string	Job ID	6203248e-e652-4ef8-a1eb-586ed7b54dc2
RecordingDuration	integer	Ringing duration, in seconds	10
TaskId	string	Task ID	479aea04-3a92-4ac3-935d-c8798c667850
DialExceptionOld	string	Exception details	["OutboundCallError.SipTrunkError"]
DialExceptionCodes	array	Exception codes shown on the remarks page
	string	List of exception codes	[ { "code":"OutboundCallError.SipCodeError", "hint":"线路侧异常码:480, 首先确定主叫和被叫正确，其次再联系号码和线路的供应商处理!" } ]
HasLastPlaybackCompleted	boolean	Indicates whether the last audio playback completed before hangup	true
ScriptName	string	Scenario name	慢病线索
CallingNumber	string	Calling number	02152739269
Labels	array<object>	Labels matched for this outbound call
	object
K	string	Label name	是否满意
V	string	Matched label value	是
VariableNames	array	Complete list of label keys
	string	Complete list of label keys	["是否满意","是否是本人","是否收到"]
Labels	array<object>	Labels available for filtering. Note Displays all labels with enumeration values in this job group.
	object
Name	string	Label name	是否满意
ValueList	array	List of label values
	string	Label value	["否","是"]

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "PageIndex": 0,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "PageSize": 10,
  "Total": 2,
  "SearchTaskInfoList": [
    {
      "JobGroupName": "85成新（有笔记划线）2021_11_14_18_00_51",
      "UserId": "12334134",
      "ActualTime": 1643436089677,
      "CalledNumber": "15205879599",
      "TaskStatusString": "Executing",
      "TaskStatusName": "正在拨打",
      "JobStatus": 0,
      "DialException": "[{\"code\":\"OutboundCallError.SipCodeError\", \"params\":[{\"key\":\"SipCode\",\"value\":\"500\"}]}]",
      "UserName": "xxx",
      "CallDurationDisplay": "47″",
      "HasAnswered": true,
      "JobStatusName": "调度中",
      "CallDuration": 46000,
      "TaskCreateTime": 1646792941,
      "JobStatusString": "Scheduling",
      "HasReachedEndOfFlow": true,
      "InstanceId": "73df6283-26b2-402d-bad0-ffa489923ea1",
      "HasHangUpByRejection": true,
      "TaskEndReason": 0,
      "JobGroupId": "37db3113-ad34-4ba3-b930-468f016bbf95",
      "TaskStatus": 0,
      "JobId": "6203248e-e652-4ef8-a1eb-586ed7b54dc2",
      "RecordingDuration": 10,
      "TaskId": "479aea04-3a92-4ac3-935d-c8798c667850",
      "DialExceptionOld": "[\"OutboundCallError.SipTrunkError\"]",
      "DialExceptionCodes": [
        "[\t\t\t\t\t{\t\t\t\t\t\"code\":\"OutboundCallError.SipCodeError\",\t\t\t\t\t\"hint\":\"线路侧异常码:480, 首先确定主叫和被叫正确，其次再联系号码和线路的供应商处理!\"\t\t\t}\t\t\t\t]"
      ],
      "HasLastPlaybackCompleted": true,
      "ScriptName": "慢病线索",
      "CallingNumber": "02152739269",
      "Labels": [
        {
          "K": "是否满意",
          "V": "是"
        }
      ]
    }
  ],
  "VariableNames": [
    "[\"是否满意\",\"是否是本人\",\"是否收到\"]"
  ],
  "Labels": [
    {
      "Name": "是否满意",
      "ValueList": [
        "[\"否\",\"是\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.