更新时间:2023-12-18 GMT+08:00

查询留言

功能介绍

查询留言

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/servicerequest/cases/{case_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

case_id

String

工单id

最小长度:0

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

group_id

String

组id

最小长度:0

最大长度:64

offset

Integer

查询偏移量

最小值:0

最大值:65535

limit

Integer

查询数量

最小值:0

最大值:100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:5000

X-Language

String

语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。

会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。

最小长度:1

最大长度:32

X-Time-Zone

String

环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。

涉及时间的数据会根据环境时区处理。

最小长度:1

最大长度:32

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数

最小值:0

最大值:65535

message_list

Array of QueryMessageInfoV2 objects

留言列表

数组长度:0 - 65535

表5 QueryMessageInfoV2

参数

参数类型

描述

type

Integer

类型,可以删除

最小值:0

最大值:1

replier_type

Integer

回复人类型

最小值:0

最大值:3

replier

String

回复人id

最小长度:0

最大长度:64

content

String

留言内容

最小长度:0

最大长度:400

create_time

String

创建时间

replier_name

String

回复人名称

最小长度:0

最大长度:256

is_first_message

Integer

是否是第一条留言

最小值:0

最大值:1

iam_user_type

Integer

子用户类型

最小值:0

最大值:3

accessory_list

Array of SimpleAccessoryV2 objects

附件列表

数组长度:0 - 5

表6 SimpleAccessoryV2

参数

参数类型

描述

accessory_id

String

附件id

最小长度:0

最大长度:64

file_actual_name

String

附件实际名称

最小长度:0

最大长度:256

请求示例

GET https://{endpoint}/v2/servicerequest/cases/case-123/messages

null

响应示例

状态码: 200

成功返回200

{
  "count" : 1,
  "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"
    } ]
  } ]
}

状态码

状态码

描述

200

成功返回200

错误码

请参见错误码