跳到主要内容

POST 创建拜访计划

POST 新增。body 为 JSON 对象。必填:name(计划名称)、customerId(客户ID)、plannedDate(计划拜访时间 yyyy-MM-dd HH:mm)。可选:contactId(联系人ID)、opportunityId(商机ID)、purposeId(拜访目的配置ID)、assigneeId(负责人,默认当前用户)、remark(备注)。新建状态为待执行。

接口编码所需范围后端接口
sales.visit-plan.createsales:writePOST /v1/visit-plan/create(comap-sales)

必填字段

字段依据
name参数说明、接口规格
customerId参数说明、接口规格
plannedDate参数说明、接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
namestring是计划名称
customerIdinteger(int64)是客户ID
contactIdinteger(int64)—联系人ID
opportunityIdinteger(int64)—商机ID
plannedDatestring是计划拜访日期时间(yyyy-MM-dd HH:mm)
purposeIdinteger(int64)—拜访目的配置ID
remarkstring—备注
assigneeIdinteger(int64)—负责人用户ID(为空则默认当前登录用户)

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.visit-plan.create",
"body": {
"name": "string",
"customerId": "1961000000000000001",
"plannedDate": "string"
}
}'

错误处理​

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

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

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

← 返回visit-plan