Querying Unread Messages
Function
Query unread messages.
URI
GET /v2/servicerequest/cases/instant-messages/unread
|
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
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
imunread |
Array of ImUnreadV2 objects |
Specifies the list of unread messages. |
|
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 Codes
|
Status Code |
Description |
|---|---|
|
200 |
Code 200 is returned if the operation is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
