GetTicket-阿里云帮助中心

Retrieves information about a specific ticket.

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.	ccc-test
TicketId	string	Yes	The ticket ID.	3d26b90a-c5d2-4b09-8219-********

Response elements

Element	Type	Description	Example
	object	DescribeTicketResponse
Data	object	The data.
InstanceId	string	The instance ID.	ccc-test
TicketId	string	The ticket ID.	b3a6a131-359e-46bd-9bc5-1f5cb0ea093f
TemplateId	string	The ticket template ID.	ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238
TemplateVersion	string	The version of the ticket template.	0
Title	string	The ticket title.	售后工单
Context	string	The fields of the ticket.	{"productName":"商品A"}
Assignee	string	The ID of the assignee.	agent1@ccc-test
AssigneeName	string	The name of the assignee.	坐席A
Creator	string	The ID of the creator.	creator@ccc-test
CreatorName	string	The name of the creator.	坐席B
CategoryId	string	The ticket category ID.	8939-4223-86d0-6bd187905cc8
CategoryName	string	The name of the ticket category.	售后类目
JobId	string	The call ID.	job-399383842187575296
StartTime	integer	The time when the ticket processing started.	1620259200000
EndTime	integer	The time when the ticket processing was completed.	1687846259999
CreatedTime	integer	The time when the ticket was created.	1620259200000
UpdatedTime	integer	The time of the last update.	1693793208075
CurrentTaskId	string	The ID of the current node.	912f0b78-6639-4a93-ae18-0d832885c27e
CurrentTaskName	string	The name of the current node.	节点1
CurrentTaskStartTime	integer	The time when the current node started.	1693793208075
Source	string	The source of the ticket. AUDIO: Voice service. CHAT: Web service. Console: Created in the ticket console.	Audio
CustomerId	string	The customer ID. This is the customer ID in the customer profile of Cloud Contact Center.	4223-86d0-6bd187905-891798749
State	string	The ticket status. Processing Withdrawal Rejected Closed	Processing
CloseCode	string	The reason for closing the ticket. Completed Terminated	Completed
Comment	string	The comment.	无
RequestId	string	The request ID.	BF268B34-09C2-43FD-BAC4-5D31EA633111
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The response code.	OK
Message	string	The response message.	无
Params	array	The list of incorrect parameters.
	string	The incorrect parameter.	无

Examples

Success response

JSON format

{
  "Data": {
    "InstanceId": "ccc-test",
    "TicketId": "b3a6a131-359e-46bd-9bc5-1f5cb0ea093f",
    "TemplateId": "ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238",
    "TemplateVersion": "0",
    "Title": "售后工单",
    "Context": "{\"productName\":\"商品A\"}",
    "Assignee": "agent1@ccc-test",
    "AssigneeName": "坐席A",
    "Creator": "creator@ccc-test\n",
    "CreatorName": "坐席B",
    "CategoryId": "8939-4223-86d0-6bd187905cc8",
    "CategoryName": "售后类目",
    "JobId": "job-399383842187575296",
    "StartTime": 1620259200000,
    "EndTime": 1687846259999,
    "CreatedTime": 1620259200000,
    "UpdatedTime": 1693793208075,
    "CurrentTaskId": "912f0b78-6639-4a93-ae18-0d832885c27e",
    "CurrentTaskName": "节点1",
    "CurrentTaskStartTime": 1693793208075,
    "Source": "Audio",
    "CustomerId": "4223-86d0-6bd187905-891798749",
    "State": "Processing",
    "CloseCode": "Completed",
    "Comment": "无"
  },
  "RequestId": "BF268B34-09C2-43FD-BAC4-5D31EA633111",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.