ListTicketNotes - Ticket System API - Alibaba Cloud Documentation Center

Retrieves the communication records for a 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
TicketId	string	Yes	The ticket ID.	0005PYGCW
Uid	string	No	The UID.	1936753548534516

Response parameters

Parameter	Type	Description	Example
	object
AccessDeniedDetail	string	The details of the permission error. An empty string is returned if you have the required permissions.	{\"AuthAction\":\"ram:ListTicketNotes\",\"AuthPrincipalDisplayName\":\"2146216584788xxxxx\",\"AuthPrincipalOwnerId\":\"1135850448xxxxx\",\"AuthPrincipalType\":\"SubUser\",\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\"}
Code	integer	The return code for the API request.	0
Message	string	The error message. This parameter is returned when `Success` is `false`.	success
RequestId	string	The unique ID of the request. Each request has a unique ID.	AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD
Success	boolean	Indicates whether the call was successful. A value of `true` indicates a successful call.	true
Data	array<object>	The return value, which is a list of communication records for the specified ticket.
	object
Type	integer	The type of communication. Valid values: `1`: Card, which corresponds to `Schema`. `2`: Text, which corresponds to `Content`.	1
Status	integer	The status of the communication message. Valid values: `1`: Unread. `2`: Read.	6
Tip	string	This parameter is not in use.	null
DialogId	integer	The unique ID of the communication record.	9999
CreateTime	integer	The UNIX timestamp when the communication message was created.	1623396736000
Dialog	object	The ticket communication record object.
Schema	string	The system card for the ticket communication record. This parameter is reserved for future use. Currently, you can use the `Content` parameter to retrieve the plain text.	null
Content	string	The content of the ticket communication.	ECS backup failed
User	object	The user in the communication.
Role	integer	The role of the user in the communication. This parameter distinguishes between customer service agents and customers. Valid values: `2`: Customer service agent. `3`: Customer.	2
Name	string	The name of the user.	agent
Attachments	array<object>	The list of attachments.
	object
Name	string	The name of the attachment.	003.jpg
Url	string	A temporary URL to access the attachment.	https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "{\\\"AuthAction\\\":\\\"ram:ListTicketNotes\\\",\\\"AuthPrincipalDisplayName\\\":\\\"2146216584788xxxxx\\\",\\\"AuthPrincipalOwnerId\\\":\\\"1135850448xxxxx\\\",\\\"AuthPrincipalType\\\":\\\"SubUser\\\",\\\"NoPermissionType\\\":\\\"ImplicitDeny\\\",\\\"PolicyType\\\":\\\"AccountLevelIdentityBasedPolicy\\\"}",
  "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.
403	No permissions	No permissions to access.	RAM authentication does not have permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.