All Products
Search
Document Center

Ticket System API:ListTicketNotes

Last Updated:May 10, 2023

Queries the communication records of a ticket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

ListTicketNotes

The operation that you want to perform. Set the value to ListTicketNotes.

TicketId

String

Yes

G2BKRWG

The ticket ID.

Language

String

No

zh

The language that you use, supporting English, Chinese, and Japanese.

Valid values: en, zh, and jp, which indicate English, Chinese, and Japanese, respectively.

Response parameters

Parameter

Type

Example

Description

Code

Integer

200

The status code.

Data

Struct

The data returned after the call succeeds.

List

Array

The list of communication records.

Content

String

I have a question.

The communication content.

FromOfficial

Boolean

false

Indicates whether the reply is sent by a user or an after-sales support engineer. The value true indicates a reply from an after-sales support engineer. The value false indicates a reply from a user.

GmtCreated

Integer

1586920240

The timestamp when the reply was sent. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

NoteId

String

CT24GHXT

The reply ID.

Message

String

success

The prompt message.

RequestId

String

CA6204AC-6AA9-4CFA-9310-7DFD20C19EBC

The ID of the request.

Success

Boolean

true

Indicates whether the request is successful. The value true indicates a success. The value false indicates a failure.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListTicketNotes
&<Common request parameters>

Sample success responses

XML format

<Message>success</Message>
<Data>
    <List>
        <NoteId>CT24GHXT</NoteId>
        <FromOfficial>false</FromOfficial>
        <Content>I have a question.</Content>
        <GmtCreated>1586920240</GmtCreated>
    </List>
</Data>
<Code>200</Code>
<Success>true</Success>

JSON format

{
  "Message": "success",
  "Data": {
    "List": [
      {
        "NoteId": "CT24GHXT",
        "FromOfficial": false,
        "Content": "I have a question.",
        "GmtCreated": 1586920240
      }
    ]
  },
  "Code": 200,
  "Success": true
  }

Error codes

HTTP status code

Error code

Error message

Description

400

param.illegal

The specified parameter is invalid. Please check the parameter.

The error message returned because there are invalid parameters. Modify the parameter settings as required.

500

System.error

An error occurred while processing your request.

The error message returned because an internal error has occurred. Try again later.

For a list of error codes, visit the API Error Center.