Help Center> Service Tickets> API Reference> API v2 (Recommended)> Service Ticket Message Management> Querying Unread Messages
View PDF

Querying Unread Messages

Function Description

To query unread messages.

Debugging

You can debug this API in API Explorer.

URI

GET /v2/servicerequest/cases/instant-messages/unread

Table 1 Query parameters

Parameter

Mandatory

Type

Description

case_ids

Yes

Array

Specifies the service ticket ID.

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-Site

No

Integer

Specifies the site.

The value can be 0 (China site) or 1 (International site). If this parameter is left blank, it is 0 by default.

Minimum value: 0

Maximum value: 1

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

imunread

Array of ImUnreadV2 objects

Specifies the list of unread messages.
Table 4 ImUnreadV2

Parameter

Type

Description

status

Integer

Specifies the status.

Minimum value: 0

Maximum value: 20

incident_id

String

Specifies the service ticket ID.

Minimum length: 0

Maximum length: 64

unread_num

Integer

Indicates the number of unread messages.

Minimum value: 0

Maximum value: 65535

Request Example

GET https://{endpoint}/v2/servicerequest/cases/instant-messages/unread

null

Response Example

Status code: 200

Code 200 is returned.

{
  "imunread" : [ {
    "status" : 1,
    "incident_id" : "case-123",
    "unread_num" : 1
  } ]
}

Status Code

Status Code

Description

200

Code 200 is returned.

Error Code

See here.