Help Center/Service Tickets/API Reference/API v2 (Recommended)/Ticket Message Management/Querying Instant Messages in Polling Mode
Updated on 2025-11-07 GMT+08:00
View PDF

Querying Instant Messages in Polling Mode

Function

Query instant messages in polling mode.

URI

GET /v2/servicerequest/cases/instant-messages

Table 1 Query parameters

Parameter

Mandatory

Type

Description

case_ids

Yes

Array

Specifies the service ticket ID.

Array length: 0–100

last_message_time_id

No

String

Specifies the last time when messages were queried.

Minimum length: 0

Maximum length: 64

group_id

No

String

Specifies the group ID.

Minimum length: 0

Maximum length: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

imstatus

Array of ImStatusV2 objects

Specifies the status list.

Array length: 0–100

immsg

Array of UserInstantIncidentMsgV2 objects

Specifies the message content list.

Array length: 0–100

last_message_time_id

String

Specifies the last time when messages were queried.

Minimum length: 0

Maximum length: 64

Table 4 ImStatusV2

Parameter

Type

Description

status

Integer

Specifies the status.

Minimum value: 0

Maximum value: 1

incident_id

String

Specifies the service ticket ID.

Minimum length: 0

Maximum length: 64

Table 5 UserInstantIncidentMsgV2

Parameter

Type

Description

incident_id

String

Specifies the service ticket ID.

Minimum length: 0

Maximum length: 64

message_list

Array of QueryMessageInfoV2 objects

Specifies the list of messages.

Array length: 0 - 65535

Table 6 QueryMessageInfoV2

Parameter

Type

Description

type

Integer

Specifies the type. It can be deleted.

Minimum value: 0

Maximum value: 1

replier_type

Integer

Specifies the replier type.

Minimum value: 0

Maximum value: 3

replier

String

Specifies the replier ID.

Minimum length: 0

Maximum length: 64

content

String

Specifies the message content.

Minimum length: 0

Maximum length: 400

create_time

String

Specifies the creation time.

replier_name

String

Specifies the replier name.

Minimum length: 0

Maximum length: 256

is_first_message

Integer

Specifies whether it is the first message.

Minimum value: 0

Maximum value: 1

iam_user_type

Integer

Specifies the sub-user type.

Minimum value: 0

Maximum value: 3

accessory_list

Array of SimpleAccessoryV2 objects

Specifies the attachment list.

Array length: 0 - 5

Table 7 SimpleAccessoryV2

Parameter

Type

Description

accessory_id

String

Specifies the attachment ID.

Minimum length: 0

Maximum length: 64

file_actual_name

String

Specifies the actual name of the attachment.

Minimum length: 0

Maximum length: 256

Request Example

GET https://{endpoint}/v2/servicerequest/cases/instant-messages?case_ids=case-123

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "imstatus" : [ {
    "status" : null,
    "incident_id" : null
  } ],
  "immsg" : [ {
    "incident_id" : null,
    "message_list" : [ {
      "type" : 0,
      "replier" : "test",
      "content" : "test",
      "create_time" : "2020-07-09 00:00:00",
      "replier_name" : "test",
      "is_first_message" : 1,
      "iam_user_type" : 0,
      "accessory_list" : [ {
        "accessory_id" : "123",
        "file_actual_name" : "test"
      } ]
    } ]
  } ],
  "last_message_time_id" : 1594296177490
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.