调用ListTicketNotes获取工单沟通记录_工单系统API(tickets)-阿里云帮助中心

获取工单沟通记录。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
TicketId	string	是	工单编号	0005PYGCW
Uid	string	否	UID	1936753548534516

返回参数

名称	类型	描述	示例值
	object
AccessDeniedDetail	string	无权限错误详细信息。如果有权限，则返回空字符串。	{\"AuthAction\":\"ram:ListTicketNotes\",\"AuthPrincipalDisplayName\":\"2146216584788xxxxx\",\"AuthPrincipalOwnerId\":\"1135850448xxxxx\",\"AuthPrincipalType\":\"SubUser\",\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\"}
Code	integer	接口请求结果返回码	0
Message	string	错误信息, 当 success=false 的时候, 可以取到 message	入参非法
RequestId	string	接口请求的唯一 ID, 每次调用 requestID 唯一	AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD
Success	boolean	调用接口返回是否成功, true 代表调用正常	true
Data	array<object>	返回值, 即指定工单的对话记录列表数据
	object
Type	integer	对话类型 1 卡片, 即 schema 2 文本, 即 content	1
Status	integer	沟通消息状态字段, 参考值未读=1、已读=2	6
Tip	string	暂不使用的字段	null
DialogId	integer	对话记录唯一 ID 标识	9999
CreateTime	integer	沟通消息创建时间的时间戳	1623396736000
Dialog	object	工单沟通记录对象
Schema	string	工单沟通记录系统卡片, 将来开放系统卡片对接能力时使用, 目前阶段用 content 取纯文本内容即可	null
Content	string	工单沟通内容	你好, 我的ECS续费失败, 请问是什么原因
User	object	对话的用户
Role	integer	对话用户角色, 区分小二和用户使用 2, 客服 3, 用户	3
Name	string	对话用户名称	工单小二
Attachments	array<object>	附件列表
	object
Name	string	附件名称	003.jpg
Url	string	临时可访问的附件地址	https://gts-workorder.oss-cn-beijing.aliyuncs.com/20221003/cbc00fb0-b612-4d89-a75b-8d535f750f9f/image.png

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "{\\\"AuthAction\\\":\\\"ram:ListTicketNotes\\\",\\\"AuthPrincipalDisplayName\\\":\\\"2146216584788xxxxx\\\",\\\"AuthPrincipalOwnerId\\\":\\\"1135850448xxxxx\\\",\\\"AuthPrincipalType\\\":\\\"SubUser\\\",\\\"NoPermissionType\\\":\\\"ImplicitDeny\\\",\\\"PolicyType\\\":\\\"AccountLevelIdentityBasedPolicy\\\"}",
  "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	错误码	错误信息	描述
400	param.illegal	Params illegal.
401	illegal.auth	You are not authorized to perform the operation.	您没有操作权限
500	System.error	An error occurred while processing your request.	系统出现未知错误，请重试
403	No permissions	No permissions to access.	RAM鉴权无权限

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

变更历史

更多信息，参考变更详情。