跳到主要内容

GET 商机分页查询

GET 分页查询。query 参数:pageNum、pageSize 及商机筛选字段。 高级筛选 advancedFilters(可选,JSON 字符串):{"字段名":{"op":"算子","value":"值"}},多字段 AND;简写 {"字段名":"值"} 文本模糊、其余精确。算子:equals/eq、not_equals/neq、contains、not_contains、starts_with、ends_with、greater_than、greater_equal、less_than、less_equal、before、after、between(起止用 ~ 或 , 分隔)、in、not_in(多值用 , 分隔)、is_empty、is_not_empty(无需 value)。字段名取响应记录中的字段名;JSON 非法会报错;该能力依赖检索索引,索引未就绪时结果为空。 可用于筛选的字段清单(含租户自定义字段)经 system.field.list 查询。

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

请求参数(query)

本接口的 query 参数由后端查询对象整体展开,接口规格未保留各字段的原始 类型,故类型列统一显示为 string。实际取值语义见「说明」列,按自然类型 传即可(如 "pageNum": 1),服务端会完成转换。

字段类型必填说明
keywordstring—关键词(模糊搜索商机名称)
customerIdstring—客户ID
stageIdstring—商机阶段ID
sourceIdstring—商机来源ID
assigneeIdstring—负责人ID
ownerScopestring—范围:MINE-我负责的 TEAM-下属负责的(数据权限下属,不含本人)WATCHED-我关注的(与报价/客户 ownerScope 语义一致,英文枚举串) /
sortFieldstring—列表排序字段:amount | expectedCloseDate | createTime | updateTime | customerName | assigneeName,默认 createTime
sortOrderstring—列表排序方向:asc | desc,默认 desc
prioritystring—优先级(HIGH/MEDIUM/LOW)
expectedCloseDateStartstring—预期成交日期-开始
expectedCloseDateEndstring—预期成交日期-结束
createTimeStartstring—创建时间-开始 (nullable
createTimeEndstring—创建时间-结束 (nullable
advancedFiltersstring—高级筛选条件(JSON 字符串)。格式 {"字段名":{"op":"算子","value":"值"}},多个字段之间为 AND;简写 {"字段名":"值"} 时文本字段模糊匹配、其余精确匹配。算子:equals/eq、not_equals/neq、contains、not_contains、starts_with、ends_with、greater_than、greater_equal、less_than、less_equal、before、after、between(起止用 ~ 或 , 分隔)、in、not_in(多值用 , 分隔)、is_empty、is_not_empty(后两者无需 value)。字段名取响应记录中的字段名。JSON 非法时报错,不会静默忽略。该能力依赖检索索引,索引未就绪时结果为空。
pageNumstring—页码,从 1 开始
pageSizestring—每页返回的数量

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

请求示例

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

响应 data 字段(分页结构:records[] + total)

字段类型必填说明
records32OpportunityPageVO[]——
totalinteger(int64)——
sizeinteger(int64)——
currentinteger(int64)——
orders2OrderItem[]——
optimizeCountSqlPageOpportunityPageVO——
searchCountPageOpportunityPageVO——
optimizeJoinOfCountSqlboolean——
maxLimitinteger(int64)——
countIdstring——
pagesinteger(int64)——

错误处理​

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

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

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

← 返回商机