ListTicketNotes - Ticket System API - Alibaba Cloud Documentation Center

Obtains the ticket communication records.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TicketId	string	Yes	Work Order Number	0005PYGCW
Uid	string	No	UID	1936753548534516

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The return code of the request result.	0
Message	string	The error message. If success is set to false, the message is returned.	success
RequestId	string	The unique ID of the API request. The requestID is unique for each call.	AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD
Success	boolean	Indicates whether the call is successful. A value of true indicates that the call is normal.	true
Data	array<object>	Return value, that is, the dialog record list data of the specified ticket
	object
Type	integer	Conversation Type 1 card, that is, schema 2 Text, that is, content	1
Status	integer	Communication message status field, reference value Unread=1, Read=2	6
Tip	string	Fields Not Used	null
DialogId	long	The unique ID of the conversation record.	9999
CreateTime	long	The timestamp when the communication message was created.	1623396736000
Dialog	object	Work order communication record object
Schema	string	The ticket communication record system card will be used when the system card docking capability is opened in the future. At present, the content can be used to obtain plain text content.	null
Content	string	Work order communication content	ECS backup failed
User	object	Conversation of users
Role	integer	Dialogue user role, distinguish between agent and user. 2 represents agent, 3 represents user.	2
Name	string	Dialog User Name	agent
Attachments	array<object>	Attachment List
	object
Name	string	Attachment Name	003.jpg
Url	string	Temporary Accessible Attachment Address	https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "Message": "success",
  "RequestId": "AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD",
  "Success": true,
  "Data": [
    {
      "Type": 1,
      "Status": 6,
      "Tip": "null",
      "DialogId": 9999,
      "CreateTime": 1623396736000,
      "Dialog": {
        "Schema": "null",
        "Content": "ECS backup failed"
      },
      "User": {
        "Role": 2,
        "Name": "agent"
      },
      "Attachments": [
        {
          "Name": "003.jpg",
          "Url": "https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	param.illegal	Params illegal.	-
401	illegal.auth	You are not authorized to perform the operation.	You are not authorized to perform this operation.
500	System.error	An error occurred while processing your request.	An error occurred while processing your request. Please try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history