查询评论列表接口 - 尘锋SCRM开放平台

POST https://qw-openapi-tx.dustess.com/comment/v1/get?accessToken=

Content-Type: application/json

接口限制：每分钟调用600次；

请求参数

请求参数名	类型	说明	是否必须
objectType	`String`	指评论数据关联的业务类型，如跟进记录："FollowRecord"	`true`
objectId	`String`	指业务数据id，如跟进记录id；查询优先级最高，与查询时间范围参数二选一	`false`
createTimeStart	`Int`	基于`评论数据创建时间`查询的`起始时间`，秒时间戳，传`0`或者不传，默认查询最近7天，最大支持查询1个月的数据	`false`
createTimeEnd	`Int`	基于`评论数据创建时间`查询的`结束时间`，秒时间戳，传`0`或者不传，默认查询最近7天，最大支持查询1个月的数据	`false`
pageToken	`String`	分页标记，第一次请求不填，表示基于查询时间范围从头开始遍历；下次遍历可使用当前页返回的最后一条`评论数据Id`作为`pageToken`来获取下一页数据，当返回数据为空时，代表遍历完成	`false`
pageSize	`Int`	查询记录条数，默认10条，最大500条	`false`

请求参数示例
json - Request-Example:

{
    "pageSize": 10,
    "objectType": "FollowRecord",
    "createTimeStart": 0,
    "createTimeEnd": 0
}

成功响应

响应参数名	类型	说明
success	`Bool`	成功标识，`true`为成功，`false`为失败
code	`Int`	响应码，0:成功
msg	`String`	消息提示
data	`Object[]`	评论数据
data.id	`String`	评论id
data.objectType	`String`	指评论数据关联的业务类型，如跟进记录："FollowRecord"
data.objectId	`String`	指业务数据id，如跟进记录id；
data.createTime	`Int`	评论数据的创建时间，秒时间戳
data.content	`String`	评论的具体内容，如在评论中@员工，格式为@{{uid}}
data.atList	`String[]`	评论@员工的uid列表
data.createUid	`String`	评论人，员工uid

成功响应示例

{
    "code": 0,
    "data": {
        "data": [
            {
                "atList": [
                    "111"
                ],
                "content": "评论@{{111}}",
                "createTime": 1692861613,
                "createUid": "111",
                "id": "185411780661477376",
                "objectId": "2e7460a1-422b-11ee-917c-063bf73ecb05",
                "objectType": "FollowRecord"
            }
        ]
    },
    "msg": "OK",
    "traceId": "XXXXXXX"
}

错误响应示例

{
	"success": false,
	"code": 10001,
	"msg": "system unknown error",
	"data": []
}