GetTaskByUuid-阿里云帮助中心

Retrieve a task by its UUID.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	024f8cf0-c842-4c01-b74b-c8667e4579c7
TaskId	string	Yes	Task ID	15160071061
WithConversations	boolean	No	Include conversation details Note The default value is false.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Task	object	Task information	{}
JobGroupId	string	Job group ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
EndTime	integer	End time	1640090211434
PlannedTime	integer	Planned execution time (deprecated)	1640090211434
JobId	string	Job ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CallId	string	Call ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CallingNumber	string	Caller number	057190294
ActualTime	integer	Actual execution time	1640090211434
InstanceId	string	Instance ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CalledNumber	string	Callee number	13777777777
Id	string	Task ID	2
Conversations	array<object>	List of conversations
	object
Speaker	string	Who spoke in the conversation. Valid values: Robot or Contact.	Robot
Script	string	Conversation text.	你好，我是**客服
Timestamp	integer	Timestamp when the summary was created.	1579068424883
Action	string	Action type Dialogue: Dialogue AbortDialogue: Abort a dialogue SilenceTimeout: Silence timeout CollectedNumber: Collected number EndDialogue: End a dialogue Broadcast: Greeting message HangUp: Hang up Authorize: Authorization TransferToAgent: Transfer to an agent TransferToIVR: Transfer to an IVR system RedirectToPage: Redirect to a page CollectNumber: Collect a number WaitOnAsyncTask: Wait for an asynchronous task Error: Error	Broadcast
SequenceId	string	Session ID	fd279983-93b9-b13b-9a34-64e5df473225
EndReason	string	Reason the task ended FINISHED: Task completed normally CHATBOT_HANGUP_AFTER_NOANSWER: Bot hung up after no answer CHATBOT_HANGUP_AFTER_SILENCE: Bot hung up after silence timeout CLIENT_HANGUP_AFTER_NOANSWER: Client hung up after no answer CLIENT_HANGUP: Client hung up without reason TRANSFER_BY_INTENT: Transferred to agent after intent match TRANSFER_AFTER_NOANSWER: Transferred to agent after no answer INO_INTERACTION: No interaction from client ERROR: System error interrupted the task SPECIAL_INTERCEPT_VOICE_ASSISTANT: Intercepted due to voice assistant SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER: Intercepted due to extension number transfer Important This parameter is a string that returns an enumeration value such as FINISHED.	FINISHED
Code	string	API status code	OK
Message	string	Response message	Success
Success	boolean	Indicates whether the request succeeded	True
HttpStatusCode	integer	HTTP status code	200

Examples

Success response

JSON format

{
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Task": {
    "JobGroupId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "EndTime": 1640090211434,
    "PlannedTime": 1640090211434,
    "JobId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "CallId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "CallingNumber": "057190294",
    "ActualTime": 1640090211434,
    "InstanceId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "CalledNumber": "13777777777",
    "Id": "2",
    "Conversations": [
      {
        "Speaker": "Robot",
        "Script": "你好，我是**客服",
        "Timestamp": 1579068424883,
        "Action": "Broadcast",
        "SequenceId": "fd279983-93b9-b13b-9a34-64e5df473225"
      }
    ],
    "EndReason": "FINISHED"
  },
  "Code": "OK",
  "Message": "Success",
  "Success": true,
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.