跳到主要内容

GET 线索详情

GET 查询。query 参数:id(线索ID,必填)。

接口编码所需范围后端接口
sales.lead.detailsales:readGET /v1/lead/detail(comap-sales)

请求参数(query)

字段类型必填说明
idinteger(int64)是线索 ID

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

请求示例

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

响应 data 字段

字段类型必填说明
idinteger(int64)—线索ID
leadNostring—线索编号
subjectTypestring—主体类型:ENTERPRISE/INDIVIDUAL
leadNamestring—统一线索名称
companyNamestring—公司名称
contactNamestring—联系人姓名
contactTitlestring—联系人职位
phonestring—联系电话
emailstring—邮箱
sourceIdinteger(int64)—线索来源ID
sourceNamestring—线索来源名称
sourceColorstring—线索来源颜色
statusIdinteger(int64)—线索状态ID
statusNamestring—线索状态名称
statusColorstring—线索状态颜色
industryIdinteger(int64)—行业ID
industryNamestring—行业名称
assigneeIdinteger(int64)—负责人ID
assigneeNamestring—负责人名称
assigneeAvatarstring—负责人头像
poolIdinteger(int64)—当前线索池 ID
poolNamestring—当前线索池名称
sourcePoolIdinteger(int64)—最近来源池 ID
sourcePoolNamestring—最近来源池名称
poolEnteredByinteger(int64)—最近入池操作人 ID
poolEnteredByNamestring—最近入池操作人名称
poolEnteredAtstring(date-time)—最近入池时间
ownershipVersioninteger(int32)—归属乐观锁版本
scoreinteger(int32)—线索评分
estimatedAmountnumber—预估金额
regionstring—地区
isPublicSeainteger(int32)—是否公海线索
lastContactTimestring(date-time)—最后联系时间
lastFollowAtstring(date-time)—最近跟进时间
intentionLevelIdinteger(int64)—当前意向等级配置ID
intentionLevelNamestring—当前意向等级名称
intentionLevelColorstring—当前意向等级颜色
tagsstring[]—标签列表
createdAtstring(date-time)—创建时间
customFieldValuesobject—自定义字段值(fieldName -> value,label=sales_lead)
descriptionstring—描述
claimedAtstring(date-time)—领取时间
claimedByinteger(int64)—领取人ID
claimedByNamestring—领取人名称
convertedOpportunityIdinteger(int64)—转化后的商机ID
createByinteger(int64)—创建人ID
createByNamestring—创建人名称

错误处理​

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

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

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

← 返回线索