探马OpenAPI

查询商机配置

POST

/api/v3/opportunity/config/get

客户&线索&待分配/商机

请求参数

Header 参数

appId

string

应用 appId

必需

示例值:

timestamp

string

请求时间戳

必需

示例值:

sign

string

请求消息签名值

必需

示例值:

appKey

string

应用 appKey

可选

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/opportunity/config/get' \
--header 'appId: {{appId}}' \
--header 'appId;' \
--header 'timestamp: {{timestamp}}' \
--header 'timestamp;' \
--header 'sign: {{sign}}' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'appKey;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

array [object {10}]

必需

typeName

string

类型名称

必需

typeId

integer

类型id

必需

defaultType

boolean

是否是默认类型

必需

allowSkip

boolean

是否允许跨阶段跳转

必需

allowGoBack

boolean

是否允许回退

必需

stages

array [object {10}]

阶段列表

必需

fields

array [object {10}]

商机字段

必需

allowInvalidGoBack

boolean

允许输单/无效阶段回退

必需

allowDeleteOpportunity

boolean

仅允许员工删除商机

必需

deleteOpportunityDate

integer

允许删除天数

必需

示例

{
  "code": 0,
  "message": "string",
  "data": [
    {
      "typeName": "string",
      "typeId": 0,
      "defaultType": true,
      "allowSkip": true,
      "allowGoBack": true,
      "stages": [
        {
          "id": 0,
          "name": "string",
          "rank": 0,
          "possibility": 0,
          "requirement": "string",
          "remind": true,
          "remindAfterDays": [
            "string"
          ],
          "children": [
            {
              "id": 0,
              "name": "string",
              "rank": 0,
              "possibility": 0,
              "requirement": "string",
              "remind": true,
              "remindAfterDays": [
                "string"
              ],
              "children": [
                "string"
              ],
              "customerFields": null,
              "requiredOppTypeFields": null
            }
          ],
          "customerFields": [
            {
              "fieldId": 0,
              "name": "string",
              "type": 0
            }
          ],
          "requiredOppTypeFields": [
            {
              "name": "string",
              "required": true,
              "rank": 0,
              "type": 0,
              "maxUnicode": 0,
              "id": 0,
              "options": [
                {
                  "id": 0,
                  "name": "string"
                }
              ],
              "scale": 0
            }
          ]
        }
      ],
      "fields": [
        {
          "id": 0,
          "name": "string",
          "required": true,
          "type": 0,
          "options": [
            {
              "id": 0,
              "name": "string"
            }
          ],
          "scale": 0,
          "maxUnicode": 0,
          "minUnicode": null,
          "pattern": null,
          "rank": 0
        }
      ],
      "allowInvalidGoBack": true,
      "allowDeleteOpportunity": true,
      "deleteOpportunityDate": 0
    }
  ]
}

修改于 2023-06-09 07:45:32

写线索&待分配客户跟进

获取商机列表