全部产品
Search
文档中心

:ListTicketNotes - 获取工单沟通记录

更新时间:Mar 03, 2024

获取工单沟通记录。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TicketIdstring

工单编号

0005PYGCW
Uidstring

UID

1936753548534516

返回参数

名称类型描述示例值
object
Codeinteger

接口请求结果返回码

0
Messagestring

错误信息, 当 success=false 的时候, 可以取到 message

入参非法
RequestIdstring

接口请求的唯一 ID, 每次调用 requestID 唯一

AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD
Successboolean

调用接口返回是否成功, true 代表调用正常

true
Dataobject []

返回值, 即指定工单的对话记录列表数据

Typeinteger

对话类型 1 卡片, 即 schema 2 文本, 即 content

1
Statusinteger

沟通消息状态字段, 参考值 未读=1、已读=2

6
Tipstring

暂不使用的字段

null
DialogIdlong

对话记录唯一 ID 标识

9999
CreateTimelong

沟通消息创建时间的时间戳

1623396736000
Dialogobject

工单沟通记录对象

Schemastring

工单沟通记录系统卡片, 将来开放系统卡片对接能力时使用, 目前阶段用 content 取纯文本内容即可

null
Contentstring

工单沟通内容

你好, 我的ECS续费失败, 请问是什么原因
Userobject

对话的用户

Roleinteger

对话用户角色, 区分小二和用户使用 2, 客服 3, 用户

3
Namestring

对话用户名称

工单小二
Attachmentsobject []

附件列表

Namestring

附件名称

003.jpg
Urlstring

临时可访问的附件地址

https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Message": "入参非法",
  "RequestId": "AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD",
  "Success": true,
  "Data": [
    {
      "Type": 1,
      "Status": 6,
      "Tip": "null",
      "DialogId": 9999,
      "CreateTime": 1623396736000,
      "Dialog": {
        "Schema": "null",
        "Content": "你好, 我的ECS续费失败, 请问是什么原因"
      },
      "User": {
        "Role": 3,
        "Name": "工单小二"
      },
      "Attachments": [
        {
          "Name": "003.jpg",
          "Url": "https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400param.illegalParams illegal.-
401illegal.authYou are not authorized to perform the operation.您没有操作权限
500System.errorAn error occurred while processing your request.系统出现未知错误,请重试

访问错误中心查看更多错误码。