跳到主要内容

GET 按客户查询跟进记录

GET 查询。query 参数:customerId(客户ID,必填)。

接口编码所需范围后端接口
sales.follow-up.list-by-customersales:readGET /v1/follow-up/list-by-customer(comap-sales)

请求参数(query)

字段类型必填说明
customerIdinteger(int64)是客户ID

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.follow-up.list-by-customer",
"query": {
"customerId": "1961000000000000001"
}
}'

响应 data 字段

字段类型必填说明
bizTypestring—关联业务类型:CUSTOMER/OPPORTUNITY/LEAD
bizIdinteger(int64)—关联业务 ID
bizNamestring—关联业务名称
leadIdinteger(int64)—关联线索 ID
leadNostring—线索编号
leadNamestring—线索名称
leadIsPublicSeainteger(int32)—线索是否在公海:0否,1是
idinteger(int64)—跟进记录ID
customerIdinteger(int64)—客户ID
customerNamestring—客户名称
followedboolean—当前用户是否已关注本条跟进记录
contactIdinteger(int64)—联系人ID
contactNamestring—联系人名称
opportunityIdinteger(int64)—商机ID
opportunityNamestring—商机名称
visitPlanIdinteger(int64)—引用的拜访计划ID
visitPlanNameSnapshotstring—拜访计划名称快照
visitPlanTimeSnapshotstring(date-time)—计划拜访时间快照
visitPurposeNameSnapshotstring—拜访目的名称快照
typeIdinteger(int64)—跟进方式ID
typeNamestring—跟进方式名称
typeColorstring—跟进方式颜色
typeIconstring—跟进方式图标
contentstring—跟进内容
resultstring—跟进结果
resultCodestring—跟进结果编码
resultNamestring—跟进结果名称
followUpAtstring(date-time)—实际跟进时间
participantNamesstring[]—参与人名称列表
leadStatusBeforestring—跟进前的线索状态
leadStatusAfterstring—跟进后的线索状态
scoreBeforeinteger(int32)—跟进前的线索评分
scoreAfterinteger(int32)—跟进后的线索评分
intentionLevelIdinteger(int64)—意向等级配置 ID
intentionLevelNamestring—意向等级名称
intentionLevelColorstring—意向等级颜色
nextFollowDatestring(date-time)—下次跟进日期
nextFollowActionstring—下次跟进计划行动
assigneeIdinteger(int64)—跟进人ID
assigneeNamestring—跟进人名称
assigneeAvatarstring—跟进人头像
createdAtstring(date-time)—创建时间
updatedAtstring(date-time)—更新时间
attachments4FollowUpAttachmentVO[]—跟进附件
legacyCommentboolean—是否为旧评论兼容数据
customFieldValuesobject—自定义字段值 (fieldName → value)

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回follow-up