跳到主要内容

GET 商机详情

GET 查询。query 参数:id(商机ID,必填)。

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

请求参数(query)

字段类型必填说明
idinteger(int64)是—

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

请求示例

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

响应 data 字段

字段类型必填说明
idinteger(int64)—商机ID
opportunityNostring—商机编号
namestring—商机名称
customerIdinteger(int64)—客户ID
customerNamestring—客户名称
contactIdinteger(int64)—联系人ID
contactNamestring—联系人名称
contactTitlestring—联系人职务
contactPhonestring—联系电话
contactEmailstring—联系人邮箱
stageIdinteger(int64)—阶段ID
stageNamestring—阶段名称
stageColorstring—阶段颜色
stageCodestring—阶段编码
sourceIdinteger(int64)—来源ID
sourceNamestring—来源名称
amountnumber—预期金额
probabilityinteger(int32)—成功概率
expectedCloseDatestring(date-time)—预期成交日期
assigneeIdinteger(int64)—负责人ID
assigneeNamestring—负责人名称
assigneeAvatarstring—负责人头像
prioritystring—优先级
trafficLightColorstring—红绿灯颜色
descriptionstring—描述
competitorsstring—竞争对手(多个用逗号分隔)
lastFollowUpTimestring(date-time)—最后跟进时间
quotationCountinteger(int32)—关联报价数量
createdAtstring(date-time)—创建时间
updateTimestring(date-time)—更新时间
followedByMeboolean—当前登录用户是否已关注该商机
customFieldValuesobject—自定义字段值 (fieldName → value)
products10OpportunityProductVO[]—关联产品列表
stageHistory6StageHistoryVO[]—阶段变更历史
changeLog6ChangeLogVO[]—变更日志
quotations6QuotationBriefVO[]—关联报价列表
leadIdinteger(int64)—来源线索ID
lostReasonstring—输单原因
lostReasonIdinteger(int64)—输单原因ID(关联商机输单原因配置)
lostReasonNamestring—输单原因名称(快照展示用,原因被停用或改名后仍按当前配置回显)
winningCompetitorstring—中标竞争对手(输单原因为竞争对手中标时有值)
createByinteger(int64)—创建人ID
createByNamestring—创建人名称

错误处理​

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

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

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

← 返回商机