Version Update Time Status Author Description

v2025-11-07 11:33:01

2025-11-07 11:33:01

auto

@root

Created by smart-doc

1.官网相关接口

1.1.api文档

1.1.1.分类列表

Type: GET

Author: wangqidong created on 2024/6/3

Content-Type: application/x-www-form-urlencoded

Description: 分类列表

Query-parameters:

Parameter Type Description Required Since Example

hasDeptItem

boolean

No comments found.

false

-

true

Request-example:

curl -X GET -i '/mt/portal/apiDoc/categoryList?hasDeptItem=true'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {}
  ],
  "timestamp": 0,
  "traceId": ""
}

1.1.2.文档列表

Type: POST

Author: wangqidong created on 2024/6/3

Content-Type: application/json

Description: 文档列表

Body-parameters:

Parameter Type Description Required Since Example

categoryCode

string

分类编码

false

-

keyword

string

关键字,支持产品名、apiKey搜索

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/portal/apiDoc/queryList' --data '{
  "categoryCode": "",
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─checkItem

string

检测项编码

-

└─checkItemName

string

检测项编码

-

└─categoryCode

string

分类编码

-

└─apiName

string

产品名

-

└─dataAdvantage

string

数据优势

-

└─respTime

string

响应时间

-

└─backgroundImg

string

背景图

-

└─description

string

描述

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "checkItem": "",
      "checkItemName": "",
      "categoryCode": "",
      "apiName": "",
      "dataAdvantage": "",
      "respTime": "",
      "backgroundImg": "",
      "description": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

1.1.3.文档详情

Type: POST

Author: wangqidong created on 2024/6/3

Content-Type: application/json

Description: 文档详情

Body-parameters:

Parameter Type Description Required Since Example

id

int64

No comments found.

false

-

0

checkItem

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/portal/apiDoc/queryDetail' --data '{
  "id": 0,
  "checkItem": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

apiId

-

0

└─checkItem

string

检测项编码

-

└─checkItemName

string

检测项名称

-

└─categoryCode

string

分类编码

-

└─categoryName

string

分类名称

-

└─subcategoryCode

string

下级分类编码

-

└─subcategoryName

string

下级分类名称

-

└─apiName

string

产品名

-

└─apiPath

string

接口地址

-

└─requestMethod

string

请求方式

-

└─contentType

string

contentType

-

└─paramSchema

array

请求参数描述

-

     └─type

string

类型,table-表格,text-文本 对于请求参数和响应参数原则上只会是表格,text存在字段描述等场景

-

     └─title

string

标题,可能为空,为空不显示

-

     └─columns

array

列定义

-

          └─columnId

string

列id

-

          └─columnTitle

string

列标题

-

     └─rows

array

行数据,JSONObject的key为DocSchemaColumn中定义的columnId 有几个占用key不可以使用 properties: 子对象或列表属性 schemaIconText:字段详细描述点击按钮的文字 schemaId:对应fieldSchema大对象的key schemaPath: 描述跳转地址 taskMode: 在线测试字段展示方式,hidden-隐藏,file-文件上传,option-选项 options:在线测试字段选项,如:[{"label":"手机号","value":1}]

-

└─paramsExample

string

请求示例

-

└─respSchema

array

响应描述

-

     └─type

string

类型,table-表格,text-文本 对于请求参数和响应参数原则上只会是表格,text存在字段描述等场景

-

     └─title

string

标题,可能为空,为空不显示

-

     └─columns

array

列定义

-

          └─columnId

string

列id

-

          └─columnTitle

string

列标题

-

     └─rows

array

行数据,JSONObject的key为DocSchemaColumn中定义的columnId 有几个占用key不可以使用 properties: 子对象或列表属性 schemaIconText:字段详细描述点击按钮的文字 schemaId:对应fieldSchema大对象的key schemaPath: 描述跳转地址 taskMode: 在线测试字段展示方式,hidden-隐藏,file-文件上传,option-选项 options:在线测试字段选项,如:[{"label":"手机号","value":1}]

-

└─respExample

string

响应示例

-

└─fieldSchema

object

字段描述

-

     └─mapKey

object

-

          └─type

string

类型,table-表格,text-文本 对于请求参数和响应参数原则上只会是表格,text存在字段描述等场景

-

          └─title

string

标题,可能为空,为空不显示

-

          └─columns

array

列定义

-

          └─columnId

string

列id

-

          └─columnTitle

string

列标题

-

          └─rows

array

行数据,JSONObject的key为DocSchemaColumn中定义的columnId 有几个占用key不可以使用 properties: 子对象或列表属性 schemaIconText:字段详细描述点击按钮的文字 schemaId:对应fieldSchema大对象的key schemaPath: 描述跳转地址 taskMode: 在线测试字段展示方式,hidden-隐藏,file-文件上传,option-选项 options:在线测试字段选项,如:[{"label":"手机号","value":1}]

-

└─errorCodeSchema

array

错误码描述

-

     └─type

string

类型,table-表格,text-文本 对于请求参数和响应参数原则上只会是表格,text存在字段描述等场景

-

     └─title

string

标题,可能为空,为空不显示

-

     └─columns

array

列定义

-

          └─columnId

string

列id

-

          └─columnTitle

string

列标题

-

     └─rows

array

行数据,JSONObject的key为DocSchemaColumn中定义的columnId 有几个占用key不可以使用 properties: 子对象或列表属性 schemaIconText:字段详细描述点击按钮的文字 schemaId:对应fieldSchema大对象的key schemaPath: 描述跳转地址 taskMode: 在线测试字段展示方式,hidden-隐藏,file-文件上传,option-选项 options:在线测试字段选项,如:[{"label":"手机号","value":1}]

-

└─upgradePeriod

string

更新周期

-

└─dataAdvantage

string

数据优势

-

└─feeType

string

计费方式

-

└─docUrl

string

文档下载地址

-

└─respTime

string

响应时间

-

└─backgroundImg

string

背景图

-

└─description

string

描述

-

└─tags

array

标签

-

""","""

└─isCollected

boolean

是否已收藏

-

true

└─taskTemplate

string

批量任务模板

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{"code":0,"msg":"","data":{"id":0,"checkItem":"","checkItemName":"","categoryCode":"","categoryName":"","subcategoryCode":"","subcategoryName":"","apiName":"","apiPath":"","requestMethod":"","contentType":"","paramSchema":[{"type":"","title":"","columns":[{"columnId":"","columnTitle":""}],"rows":[{}]}],"paramsExample":"","respSchema":[{"type":"","title":"","columns":[{"columnId":"","columnTitle":""}],"rows":[{}]}],"respExample":"","fieldSchema":{"mapKey":{"type":"","title":"","columns":[{"columnId":"","columnTitle":""}],"rows":[{}]}}"errorCodeSchema":[{"type":"","title":"","columns":[{"columnId":"","columnTitle":""}],"rows":[{}]}],"upgradePeriod":"","dataAdvantage":"","feeType":"","docUrl":"","respTime":"","backgroundImg":"","description":"","tags":[""],"isCollected":true,"taskTemplate":""},"timestamp":0,"traceId":""}

1.1.4.操作收藏

Type: POST

Author: wangqidong created on 2024/6/3

Content-Type: application/json

Description: 前端无需关心是收藏还是取消收藏

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

产品编码

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/portal/apiDoc/dealCollect' --data '{
  "checkItem": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.诺尔数据后台

2.1.预警管理

2.1.1.异常预警配置

Type: POST

Author: wangqidong created on 2024/10/26

Content-Type: application/json

Description: 异常预警配置

Body-parameters:

Parameter Type Description Required Since Example

checkItemList

array

产品列表

true

-

""","""

periodSeconds

int32

周期,单位:秒

true

-

0

errorCount

int32

异常数量

true

-

0

contacts

array

联系人id

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/forewarn/configItem' --data '{
  "checkItemList": [
    ""
  ],
  "periodSeconds": 0,
  "errorCount": 0,
  "contacts": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.1.2.删除异常预警

Type: POST

Author: wangqidong created on 2024/10/26

Content-Type: application/json

Description: 删除异常预警

Body-parameters:

Parameter Type Description Required Since Example

checkItemList

array

产品编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/forewarn/deleteItem' --data '{
  "checkItemList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.1.3.异常预警列表

Type: POST

Author: wangqidong created on 2024/10/26

Content-Type: application/json

Description: 异常预警列表

Body-parameters:

Parameter Type Description Required Since Example

queryForAdd

boolean

是否查询未添加告警的产品,默认false

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/forewarn/itemList' --data '{
  "queryForAdd": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─checkItem

string

检测项

-

└─itemName

string

检测项名称

-

└─periodSeconds

int32

周期,单位:秒

-

0

└─errorCount

int32

异常数量

-

0

└─contactList

array

联系人

-

     └─id

int64

联系人id

-

0

     └─linkman

string

联系人姓名

-

     └─mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

-

     └─email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

-

     └─webhook

string

webhook

-

     └─isDefault

boolean

是否默认联系人

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "checkItem": "",
      "itemName": "",
      "periodSeconds": 0,
      "errorCount": 0,
      "contactList": [
        {
          "id": 0,
          "linkman": "",
          "mobile": "",
          "email": "",
          "webhook": "",
          "isDefault": true
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.1.4.查询所有预警联系人

Type: GET

Author: wangqidong created on 2024/10/26

Content-Type: application/x-www-form-urlencoded

Description: 查询所有预警联系人

Request-example:

curl -X GET -i '/mt/beeback/forewarn/queryAllContacts'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

联系人id

-

0

└─linkman

string

联系人姓名

-

└─mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

-

└─email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

-

└─webhook

string

webhook

-

└─isDefault

boolean

是否默认联系人

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "linkman": "",
      "mobile": "",
      "email": "",
      "webhook": "",
      "isDefault": true
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.1.5.新增联系人

Type: POST

Author: wangqidong created on 2024/10/26

Content-Type: application/json

Description: 新增联系人

Body-parameters:

Parameter Type Description Required Since Example

id

int64

联系人id

false

-

0

linkman

string

联系人姓名

false

-

mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

false

-

email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

false

-

webhook

string

webhook

false

-

isDefault

boolean

是否默认联系人

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/forewarn/addContacts' --data '{
  "id": 0,
  "linkman": "",
  "mobile": "",
  "email": "",
  "webhook": "",
  "isDefault": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.1.6.删除联系人

Type: POST

Author: wangqidong created on 2024/10/26

Content-Type: application/json

Description: 删除联系人

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/forewarn/deleteContacts' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.2.api数据管理

2.2.1.调用记录

Type: POST

Author: wangqidong created on 2024/10/24

Content-Type: application/json

Description: 调用记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

查询关键字

false

-

idCard

string

身份证号

false

-

deptIdList

array

客户id

false

-

"0,0"

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

itemCodeList

array

产品编码

false

-

""","""

isFee

int32

是否计费

false

-

0

success

int32

是否成功

false

-

0

cacheFlag

int32

是否为缓存数据 0否 1是

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiData/recordList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "idCard": "",
  "deptIdList": [
    0
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss",
  "itemCodeList": [
    ""
  ],
  "isFee": 0,
  "success": 0,
  "cacheFlag": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─seqNo

string

流水号

-

     └─appId

string

机构appId

-

     └─deptId

int64

机构id

-

0

     └─result

string

检测结果

-

     └─fee

number

产生费用

-

0

     └─success

int32

是否成功

-

0

     └─resultMsg

string

数据源返回信息

-

     └─resultCode

int32

数据源返回code

-

0

     └─tradeNo

string

交易单号

-

     └─name

string

客户名称

-

     └─idCard

string

身份证

-

     └─mobile

string

手机号码

-

     └─sign

string

签名

-

     └─phoneRegion

string

号码归属地

-

     └─isFee

int32

是否计费

-

0

     └─deptName

string

机构名称

-

     └─tag

string

标识

-

     └─time

string

请求时间 单位:ms

-

     └─requestIp

string

No comments found.

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

     └─extend

string

附加信息

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "checkItem": "",
        "checkItemName": "",
        "seqNo": "",
        "appId": "",
        "deptId": 0,
        "result": "",
        "fee": 0,
        "success": 0,
        "resultMsg": "",
        "resultCode": 0,
        "tradeNo": "",
        "name": "",
        "idCard": "",
        "mobile": "",
        "sign": "",
        "phoneRegion": "",
        "isFee": 0,
        "deptName": "",
        "tag": "",
        "time": "",
        "requestIp": "",
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "encryptionType": "",
        "extend": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.2.2.导出调用记录

Type: POST

Author: wangqidong created on 2024/10/24

Content-Type: application/json

Description: 导出调用记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

查询关键字

false

-

idCard

string

身份证号

false

-

deptIdList

array

客户id

false

-

"0,0"

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

itemCodeList

array

产品编码

false

-

""","""

isFee

int32

是否计费

false

-

0

success

int32

是否成功

false

-

0

cacheFlag

int32

是否为缓存数据 0否 1是

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiData/recordExport' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "idCard": "",
  "deptIdList": [
    0
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss",
  "itemCodeList": [
    ""
  ],
  "isFee": 0,
  "success": 0,
  "cacheFlag": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.2.3.调用明细

Type: GET

Author: wangqidong created on 2024/10/24

Content-Type: application/x-www-form-urlencoded

Description: 调用明细

Path-parameters:

Parameter Type Description Required Since Example

seqNo

string

流水号

true

-

Request-example:

curl -X GET -i '/mt/beeback/apiData/recordDetail/{seqNo}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─deptName

string

客户名称

-

└─checkItem

string

检测项

-

└─checkItemName

string

检测项名称

-

└─tag

string

标识

-

└─tradeNo

string

交易单号

-

└─seqNo

string

流水号

-

└─appId

string

机构appId

-

└─deptId

int64

机构id

-

0

└─result

string

检测结果

-

└─isFee

int32

是否计费

-

0

└─isFeeDesc

string

是否计费

-

└─fee

number

产生费用

-

0

└─success

int32

是否成功

-

0

└─resultMsg

string

数据源返回信息

-

└─resultCode

int32

数据源返回code

-

0

└─cacheFlag

int32

是否为缓存数据 0实时数据 1缓存数据

-

0

└─name

string

客户名称

-

└─idCard

string

身份证

-

└─mobile

string

手机号码

-

└─sign

string

签名

-

└─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

└─phoneRegion

string

号码归属地

-

└─finalSource

string

请求数据源

-

└─time

string

耗时 单位:ms

-

└─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─requestIp

string

请求ip

-

└─upstreamRecordList

array

上游调用明细

-

     └─id

int64

主键

-

0

     └─seqNo

string

调用链流水号

-

     └─dataSourceCode

string

数据源编码

-

     └─dataSourceName

string

数据源编码

-

     └─thirdSeqNo

string

第三方流水号

-

     └─reqParam

string

调用参数

-

     └─response

string

返回结果

-

     └─url

string

调用地址

-

     └─time

int32

耗时 :s

-

0

     └─stack

string

异常栈

-

     └─item

string

产品编码

-

     └─extra

string

附加信息

-

     └─outerName

string

外部源名称

-

     └─isFee

int32

是否计费 0不计费 1计费

-

0

     └─outerType

int32

外部源代号

-

0

     └─deptName

string

机构名称

-

     └─appId

string

机构名称

-

     └─tag

string

标记

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─extend

string

附加信息

-

└─orgCode

string

组织编码

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "deptName": "",
    "checkItem": "",
    "checkItemName": "",
    "tag": "",
    "tradeNo": "",
    "seqNo": "",
    "appId": "",
    "deptId": 0,
    "result": "",
    "isFee": 0,
    "isFeeDesc": "",
    "fee": 0,
    "success": 0,
    "resultMsg": "",
    "resultCode": 0,
    "cacheFlag": 0,
    "name": "",
    "idCard": "",
    "mobile": "",
    "sign": "",
    "encryptionType": "",
    "phoneRegion": "",
    "finalSource": "",
    "time": "",
    "createDate": "yyyy-MM-dd HH:mm:ss",
    "requestIp": "",
    "upstreamRecordList": [
      {
        "id": 0,
        "seqNo": "",
        "dataSourceCode": "",
        "dataSourceName": "",
        "thirdSeqNo": "",
        "reqParam": "",
        "response": "",
        "url": "",
        "time": 0,
        "stack": "",
        "item": "",
        "extra": "",
        "outerName": "",
        "isFee": 0,
        "outerType": 0,
        "deptName": "",
        "appId": "",
        "tag": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "extend": "",
    "orgCode": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.3.任务管理

2.3.1.单笔测试

Type: POST

Author: wangqidong created on 2024/10/31

Content-Type: application/json

Description: 单笔测试

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

产品编码

true

-

params

object

请求参数

true

-

└─name

string

No comments found.

false

-

└─idCard

string

No comments found.

false

-

└─name2

string

No comments found.

false

-

└─idCard2

string

No comments found.

false

-

└─mobile

string

No comments found.

false

-

└─tradeNo

string

No comments found.

false

-

└─plateNumber

string

No comments found.

false

-

└─certNo

string

No comments found.

false

-

└─vin

string

No comments found.

false

-

└─provinceCode

string

No comments found.

false

-

└─scene

string

No comments found.

false

-

└─type

string

No comments found.

false

-

└─apiKeys

string

No comments found.

false

-

└─deptId

int32

No comments found.

false

-

0

└─callBack

string

No comments found.

false

-

└─url

string

No comments found.

false

-

└─base64

string

No comments found.

false

-

└─keyWord

string

No comments found.

false

-

└─entName

string

No comments found.

false

-

└─entCode

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiTask/test' --data '{
  "checkItem": "",
  "params": {
    "name": "",
    "idCard": "",
    "name2": "",
    "idCard2": "",
    "mobile": "",
    "tradeNo": "",
    "plateNumber": "",
    "certNo": "",
    "vin": "",
    "provinceCode": "",
    "scene": "",
    "type": "",
    "apiKeys": "",
    "deptId": 0,
    "callBack": "",
    "url": "",
    "base64": "",
    "keyWord": "",
    "entName": "",
    "entCode": ""
  }
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

2.3.2.提交批量任务

Type: POST

Author: wangqidong created on 2024/10/31

Content-Type: multipart/form-data

Description: 提交批量任务

Query-parameters:

Parameter Type Description Required Since Example

taskName

string

任务名称

true

-

checkItem

string

产品编码

true

-

encryptionType

int32

1:明文(默认),2:MD5,3:SHA256,4:SM3

true

-

1

saveAsDraft

boolean

是否保存草稿,默认false

true

-

false

Body-parameters:

Parameter Type Description Required Since Example

file

file

样本文件

true

-

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/mt/beeback/apiTask/submitBatch?taskName=&checkItem=&encryptionType=1&saveAsDraft=false'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.3.3.任务列表

Type: POST

Author: wangqidong created on 2024/10/31

Content-Type: application/json

Description: 任务列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

部门id,无需传递

false

-

0

checkItem

string

产品编码

false

-

keyword

string

任务名称模糊匹配

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiTask/taskList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "checkItem": "",
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─taskNo

string

批次单号

-

     └─taskName

string

任务名称

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─checkItem

string

产品编码

-

     └─itemName

string

产品名称

-

     └─state

int32

状态

-

0

     └─taskParams

string

任务参数

-

     └─sampleCount

int32

样本数量

-

0

     └─finishedCount

int32

已完成数量

-

0

     └─password

string

结果解压密码

-

     └─executeTime

string

执行时间

-

yyyy-MM-dd HH:mm:ss

     └─finishTime

string

完成时间

-

yyyy-MM-dd HH:mm:ss

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "taskNo": "",
        "taskName": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "checkItem": "",
        "itemName": "",
        "state": 0,
        "taskParams": "",
        "sampleCount": 0,
        "finishedCount": 0,
        "password": "",
        "executeTime": "yyyy-MM-dd HH:mm:ss",
        "finishTime": "yyyy-MM-dd HH:mm:ss",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.3.4.执行任务

Type: POST

Author: wangqidong created on 2024/10/31

Content-Type: application/json

Description: 执行任务

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiTask/execute' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.3.5.删除任务

Type: POST

Author: wangqidong created on 2024/10/31

Content-Type: application/json

Description: 删除任务

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiTask/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.3.6.下载结果

Type: POST

Author: wangqidong created on 2024/10/31

Content-Type: application/json

Description: 下载结果

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/apiTask/downloadResult' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

2.4.组织信息

2.4.1.查询登录信息

Type: GET

Author: wangqidong created on 2024/10/22

Content-Type: application/x-www-form-urlencoded

Description: 查询登录信息

Query-parameters:

Parameter Type Description Required Since Example

mustRefresh

boolean

No comments found.

false

-

true

Request-example:

curl -X GET -i '/mt/beeback/dept/querySession?mustRefresh=true'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─loginId

string

登录id

-

└─stoken

string

登录token

-

└─userId

int64

用户id

-

0

└─username

string

用户名

-

└─nickname

string

昵称

-

└─mobile

string

手机号

-

└─merchantId

int64

当前登录的商户id

-

0

└─merchantName

string

商户名

-

└─enterpriseId

int64

企业id

-

0

└─enterpriseName

string

企业名称

-

└─industry

string

所属行业

-

└─authType

int32

登录用户认证类型,0-未认证,10-个人认证,20-企业认证

-

0

└─loginAppCode

string

登录端code

-

└─appcode

string

当前访问端code

-

└─appName

string

当前访问端名称

-

└─bizAppcode

string

业务应用编码(适用于管理后台访问业务数据)

-

└─requestIp

string

请求ip

-

└─agentId

int64

当前应用下代理id

-

0

└─salesmanId

int64

销售id

-

0

└─assistantId

int64

维护人id

-

0

└─tenantId

int64

租户id

-

0

└─bizTenantId

int64

业务租户id

-

0

└─tenantOwnerId

int64

租户所有者用户id

-

0

└─realName

string

真实姓名

-

└─linkman

string

联系人(商户)

-

└─linkMobile

string

联系方式(商户)

-

└─email

string

邮箱(商户)

-

└─isTemp

boolean

是否临时登录

-

true

└─terminal

enum

终端类型,android-安卓,ios-ios,harmony-鸿蒙
(See: 应用终端类型)

-

ANDROID

└─iv

int32

当前内部版本号

-

0

└─isTest

boolean

是否测试用户

-

true

└─refreshTime

int64

刷新时间戳

-

0

└─appId

string

接口appId

-

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "loginId": "",
    "stoken": "",
    "userId": 0,
    "username": "",
    "nickname": "",
    "mobile": "",
    "merchantId": 0,
    "merchantName": "",
    "enterpriseId": 0,
    "enterpriseName": "",
    "industry": "",
    "authType": 0,
    "loginAppCode": "",
    "appcode": "",
    "appName": "",
    "bizAppcode": "",
    "requestIp": "",
    "agentId": 0,
    "salesmanId": 0,
    "assistantId": 0,
    "tenantId": 0,
    "bizTenantId": 0,
    "tenantOwnerId": 0,
    "realName": "",
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "isTemp": true,
    "terminal": "",
    "iv": 0,
    "isTest": true,
    "refreshTime": 0,
    "appId": "",
    "deptId": 0,
    "deptName": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.4.2.开发者信息

Type: POST

Author: wangqidong created on 2024/10/22

Content-Type: application/json

Description: 开发者信息

Body-parameters:

Parameter Type Description Required Since Example

env

string

账户类型,prod:正式,test:测试

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/dept/developerInfo' --data '{
  "env": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─appId

string

接口appId

-

└─appSecret

string

appSecret

-

└─env

string

账户类型,prod:正式,test:测试

-

└─status

int32

状态 0:试用。1:正常

-

0

└─whiteIpList

string

ip白名单,多个逗号分割 whiteIpList=off

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deptId": 0,
      "deptName": "",
      "appId": "",
      "appSecret": "",
      "env": "",
      "status": 0,
      "whiteIpList": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.4.3.设置ip白名单

Type: POST

Author: wangqidong created on 2024/10/22

Content-Type: application/json

Description: 设置ip白名单

Body-parameters:

Parameter Type Description Required Since Example

enable

boolean

是否开启白名单

true

-

true

ipList

string

白名单ip,多个逗号分割,enable为true时必填

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/dept/saveWhiteIpList' --data '{
  "enable": true,
  "ipList": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.4.4.申请开发者账号

Type: POST

Author: wangqidong created on 2024/10/22

Content-Type: application/json

Description: 申请开发者账号

Body-parameters:

Parameter Type Description Required Since Example

env

string

账户类型,prod:正式,test:测试

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/dept/applyDeveloper' --data '{
  "env": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.5.对账单

2.5.1.账单列表

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 账单列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

billDateGte

string

账单月份大于

false

-

billDateLte

string

账单月份小于

false

-

statementNoList

array

账单编号

false

-

""","""

deptIdList

array

前端无需传递

false

-

"0,0"

stateList

array

账单状态

false

-

"0,0"

invoiceStateList

array

开票状态

false

-

"0,0"

overdraftTypeList

array

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

false

-

"0,0"

paymentStateList

array

回款状态,0:未回款,10:部分回款,20:已回款

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "billDateGte": "",
  "billDateLte": "",
  "statementNoList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "invoiceStateList": [
    0
  ],
  "overdraftTypeList": [
    0
  ],
  "paymentStateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─userId

int64

客户id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─stateDesc

string

账单状态

-

     └─invoiceState

int32

开票状态

-

0

     └─totalAmount

number

总金额

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─notInvoicedAmount

number

未开票金额

-

0

     └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─billDetailList

array

账单明细(详情会返回)

-

          └─id

int64

No comments found.

-

0

          └─billDate

string

账单日期

-

          └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─checkItem

string

检测项

-

          └─checkItemName

string

检测项名称

-

          └─tag

string

标记

-

          └─dataSourceId

int32

数据源id

-

0

          └─dataSource

string

数据源

-

          └─dataSourceCode

string

数据源代号

-

          └─checkConfigId

int32

数据源配置id

-

0

          └─count

int32

调用笔数

-

0

          └─freeCount

int32

免费次数

-

0

          └─chargeCount

int32

计费次数

-

0

          └─price

number

单价

-

0

          └─totalFee

number

总费用

-

0

          └─totalCost

number

总成本

-

0

          └─settledAmount

number

已结算金额

-

0

          └─statementNo

string

对账单号

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─emails

array

通知邮箱地址

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─settledAmount

number

已结算金额

-

0

     └─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

     └─sendRecordList

array

账单发送记录

-

          └─receiverList

array

收件人

-

""","""

          └─ccList

array

抄送

-

""","""

          └─attachmentUrl

string

账单附件地址

-

          └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

          └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

     └─paymentStateDesc

string

回款状态

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "userId": 0,
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "stateDesc": "",
        "invoiceState": 0,
        "totalAmount": 0,
        "invoicedAmount": 0,
        "notInvoicedAmount": 0,
        "confirmDate": "yyyy-MM-dd HH:mm:ss",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "billDetailList": [
          {
            "id": 0,
            "billDate": "",
            "billType": "",
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "checkItem": "",
            "checkItemName": "",
            "tag": "",
            "dataSourceId": 0,
            "dataSource": "",
            "dataSourceCode": "",
            "checkConfigId": 0,
            "count": 0,
            "freeCount": 0,
            "chargeCount": 0,
            "price": 0,
            "totalFee": 0,
            "totalCost": 0,
            "settledAmount": 0,
            "statementNo": "",
            "createDate": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "emails": [
          ""
        ],
        "attachmentUrl": "",
        "settledAmount": 0,
        "overdraftType": 0,
        "sendRecordList": [
          {
            "receiverList": [
              ""
            ],
            "ccList": [
              ""
            ],
            "attachmentUrl": "",
            "sendTime": "yyyy-MM-dd HH:mm:ss",
            "state": 0
          }
        ],
        "paymentStateDesc": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.5.2.账单详情

Type: GET

Author: wangqidong created on 2024/10/29

Content-Type: application/x-www-form-urlencoded

Description: 账单详情

Path-parameters:

Parameter Type Description Required Since Example

statementNo

string

No comments found.

true

-

Request-example:

curl -X GET -i '/mt/beeback/billStatement/detail/{statementNo}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

id

-

0

└─statementNo

string

账单编号

-

└─billDate

string

账单月份

-

└─userId

int64

客户id

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─appId

string

appid

-

└─state

int32

账单状态

-

0

└─stateDesc

string

账单状态

-

└─invoiceState

int32

开票状态

-

0

└─totalAmount

number

总金额

-

0

└─invoicedAmount

number

已开票金额

-

0

└─notInvoicedAmount

number

未开票金额

-

0

└─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

└─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

└─billDetailList

array

账单明细(详情会返回)

-

     └─id

int64

No comments found.

-

0

     └─billDate

string

账单日期

-

     └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标记

-

     └─dataSourceId

int32

数据源id

-

0

     └─dataSource

string

数据源

-

     └─dataSourceCode

string

数据源代号

-

     └─checkConfigId

int32

数据源配置id

-

0

     └─count

int32

调用笔数

-

0

     └─freeCount

int32

免费次数

-

0

     └─chargeCount

int32

计费次数

-

0

     └─price

number

单价

-

0

     └─totalFee

number

总费用

-

0

     └─totalCost

number

总成本

-

0

     └─settledAmount

number

已结算金额

-

0

     └─statementNo

string

对账单号

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─emails

array

通知邮箱地址

-

""","""

└─attachmentUrl

string

账单附件地址

-

└─settledAmount

number

已结算金额

-

0

└─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

└─sendRecordList

array

账单发送记录

-

     └─receiverList

array

收件人

-

""","""

     └─ccList

array

抄送

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

     └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

└─paymentStateDesc

string

回款状态

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "statementNo": "",
    "billDate": "",
    "userId": 0,
    "deptId": 0,
    "deptName": "",
    "appId": "",
    "state": 0,
    "stateDesc": "",
    "invoiceState": 0,
    "totalAmount": 0,
    "invoicedAmount": 0,
    "notInvoicedAmount": 0,
    "confirmDate": "yyyy-MM-dd HH:mm:ss",
    "invoiceTime": "yyyy-MM-dd HH:mm:ss",
    "billDetailList": [
      {
        "id": 0,
        "billDate": "",
        "billType": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "dataSourceId": 0,
        "dataSource": "",
        "dataSourceCode": "",
        "checkConfigId": 0,
        "count": 0,
        "freeCount": 0,
        "chargeCount": 0,
        "price": 0,
        "totalFee": 0,
        "totalCost": 0,
        "settledAmount": 0,
        "statementNo": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "emails": [
      ""
    ],
    "attachmentUrl": "",
    "settledAmount": 0,
    "overdraftType": 0,
    "sendRecordList": [
      {
        "receiverList": [
          ""
        ],
        "ccList": [
          ""
        ],
        "attachmentUrl": "",
        "sendTime": "yyyy-MM-dd HH:mm:ss",
        "state": 0
      }
    ],
    "paymentStateDesc": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.5.3.未开票统计

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 未开票统计

Body-parameters:

Parameter Type Description Required Since Example

statementNoList

array

账单编号,传null统计全部可开票账单

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/invoiceCalculate' --data '{
  "statementNoList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalAmountSum

number

账单金额合计

-

0

└─invoicedAmountSum

number

已开票金额合计

-

0

└─notInvoicedAmountSum

number

未开票金额

-

0

└─statementDetails

array

No comments found.

-

     └─statementId

int64

对账单id

-

0

     └─statementNo

string

对账单编号

-

     └─invoiceAmount

number

开票金额

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalAmountSum": 0,
    "invoicedAmountSum": 0,
    "notInvoicedAmountSum": 0,
    "statementDetails": [
      {
        "statementId": 0,
        "statementNo": "",
        "invoiceAmount": 0
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.5.4.确认账单

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 确认账单

Body-parameters:

Parameter Type Description Required Since Example

statementNoList

array

账单编号,不传代表确认全部

false

-

""","""

deptId

int64

前端无需传递

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/confirm' --data '{
  "statementNoList": [
    ""
  ],
  "deptId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.5.5.申请开票

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 申请开票

Body-parameters:

Parameter Type Description Required Since Example

statementNoList

array

账单编号,不传默认全部开票

false

-

""","""

invoiceAmount

number

开票金额

true

-

0

invoiceType

string

开票类型,normal-普票,special-专票

true

-

headerName

string

抬头

true

-

tin

string

税号

true

-

email

string

邮箱

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/applyInvoice' --data '{
  "statementNoList": [
    ""
  ],
  "invoiceAmount": 0,
  "invoiceType": "",
  "headerName": "",
  "tin": "",
  "email": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.5.6.开票记录

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 开票记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

机构id

false

-

0

deptIdList

array

机构id

false

-

"0,0"

stateList

array

开票状态

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/invoiceList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─invoiceType

string

开票类型,normal-普票,special-专票

-

     └─state

int32

开票状态

-

0

     └─invoiceAmount

number

开票金额

-

0

     └─statementList

array

包含的账单编号

-

          └─id

int64

id

-

0

          └─statementNo

string

账单编号

-

          └─billDate

string

账单月份

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─state

int32

账单状态

-

0

          └─invoiceState

int32

开票状态

-

0

          └─invoicedAmount

number

已开票金额

-

0

          └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─headerName

string

发票抬头

-

     └─tin

string

税号

-

     └─email

string

邮箱

-

     └─invoiceTime

string

开具时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceUrl

string

发票地址

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptId": 0,
        "deptName": "",
        "invoiceType": "",
        "state": 0,
        "invoiceAmount": 0,
        "statementList": [
          {
            "id": 0,
            "statementNo": "",
            "billDate": "",
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "state": 0,
            "invoiceState": 0,
            "invoicedAmount": 0,
            "invoiceTime": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "headerName": "",
        "tin": "",
        "email": "",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "invoiceUrl": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.5.7.开票记录明细

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 开票记录明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/invoiceDetail' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

id

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─invoiceType

string

开票类型,normal-普票,special-专票

-

└─state

int32

开票状态

-

0

└─invoiceAmount

number

开票金额

-

0

└─statementList

array

包含的账单编号

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─invoiceState

int32

开票状态

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

└─headerName

string

发票抬头

-

└─tin

string

税号

-

└─email

string

邮箱

-

└─invoiceTime

string

开具时间

-

yyyy-MM-dd HH:mm:ss

└─invoiceUrl

string

发票地址

-

└─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "deptId": 0,
    "deptName": "",
    "invoiceType": "",
    "state": 0,
    "invoiceAmount": 0,
    "statementList": [
      {
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "invoiceState": 0,
        "invoicedAmount": 0,
        "invoiceTime": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "headerName": "",
    "tin": "",
    "email": "",
    "invoiceTime": "yyyy-MM-dd HH:mm:ss",
    "invoiceUrl": "",
    "createDate": "yyyy-MM-dd HH:mm:ss"
  },
  "timestamp": 0,
  "traceId": ""
}

2.5.8.发送发票到邮箱

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 发送发票到邮箱

Body-parameters:

Parameter Type Description Required Since Example

id

int64

开票记录id

true

-

0

email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/billStatement/sendInvoiceEmail' --data '{
  "id": 0,
  "email": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.6.合同

2.6.1.合同列表

Type: POST

Author: wangqidong created on 2025/4/7

Content-Type: application/json

Description: 合同列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

stateList

array

状态

false

-

"0,0"

excludeStateList

array

排除的状态

false

-

"0,0"

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/deptContract/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "stateList": [
    0
  ],
  "excludeStateList": [
    0
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

组织id

-

0

     └─deptName

string

组织名称

-

     └─userId

int64

用户id

-

0

     └─contractNo

string

合同编号

-

     └─templateCode

string

合同模板编码

-

     └─contractName

string

合同名称

-

     └─state

int32

状态

-

0

     └─deptItemCount

int32

授权产品数量

-

0

     └─signerMobile

string

签署人手机号

-

     └─contractUrl

string

合同地址

-

     └─version

int32

合同版本

-

0

     └─versionName

string

版本名称

-

     └─submitTime

string

发起时间

-

yyyy-MM-dd HH:mm:ss

     └─signEndTime

string

签署截止时间

-

yyyy-MM-dd HH:mm:ss

     └─finishTime

string

签署完成时间

-

yyyy-MM-dd HH:mm:ss

     └─expireTime

string

合同过期时间

-

yyyy-MM-dd HH:mm:ss

     └─rejectReason

string

拒签原因

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "userId": 0,
        "contractNo": "",
        "templateCode": "",
        "contractName": "",
        "state": 0,
        "deptItemCount": 0,
        "signerMobile": "",
        "contractUrl": "",
        "version": 0,
        "versionName": "",
        "submitTime": "yyyy-MM-dd HH:mm:ss",
        "signEndTime": "yyyy-MM-dd HH:mm:ss",
        "finishTime": "yyyy-MM-dd HH:mm:ss",
        "expireTime": "yyyy-MM-dd HH:mm:ss",
        "rejectReason": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.6.2.获取签署信息

Type: GET

Author: wangqidong created on 2025/4/7

Content-Type: application/x-www-form-urlencoded

Description: 获取签署信息

Path-parameters:

Parameter Type Description Required Since Example

contractNo

string

No comments found.

true

-

Request-example:

curl -X GET -i '/mt/beeback/deptContract/getSignInfo/{contractNo}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─deptId

int64

组织id

-

0

└─contractNo

string

合同编号

-

└─templateCode

string

合同模板编码

-

└─mobile

string

签署人手机号

-

└─signUrl

string

签署链接

-

└─signQrCode

string

签署二维码地址

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "deptId": 0,
    "contractNo": "",
    "templateCode": "",
    "mobile": "",
    "signUrl": "",
    "signQrCode": ""
  },
  "timestamp": 0,
  "traceId": ""
}

2.6.3.发送签署短信

Type: POST

Author: wangqidong created on 2025/4/7

Content-Type: application/json

Description: 发送签署短信

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

mobile

string

手机号

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/deptContract/resendSms' --data '{
  "contractNo": "",
  "mobile": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.7.首页数据

2.7.1.核心统计

Type: GET

Author: wangqidong created on 2024/10/23

Content-Type: application/x-www-form-urlencoded

Description: 核心统计

Request-example:

curl -X GET -i '/mt/beeback/index/coreStatistics'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─balance

number

账户余额

-

0

└─overdueAmount

number

欠费金额

-

0

└─overdraftQuota

number

可透支额度

-

0

└─unconfirmedBillCount

int64

未确认账单数量

-

0

└─mineItemCount

int64

我的产品数

-

0

└─applyingItemCount

int64

申请中的产品数量

-

0

└─unreadMsgCount

int64

未读消息数

-

0

└─waitPrefectCount

int32

待完善信息数量

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "balance": 0,
    "overdueAmount": 0,
    "overdraftQuota": 0,
    "unconfirmedBillCount": 0,
    "mineItemCount": 0,
    "applyingItemCount": 0,
    "unreadMsgCount": 0,
    "waitPrefectCount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

2.7.2.调用统计

Type: POST

Author: wangqidong created on 2024/10/23

Content-Type: application/json

Description: 调用统计

Body-parameters:

Parameter Type Description Required Since Example

unit

string

日期类型,DAYS:按日,MONTHS:按月;按日最长选31日,按月最长选36个月 Validation[Pattern(regexp=DAYS|MONTHS)]

true

-

startDate

string

开始日期,按月格式:2024-01,按日格式:2024-01-01

true

-

endDate

string

结束日期,按月格式:2024-01,按日格式:2024-01-01

true

-

keyword

string

搜索关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/index/apiStatistics' --data '{
  "unit": "",
  "startDate": "",
  "endDate": "",
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalCount

int32

总次数

-

0

└─totalFee

number

总费用

-

0

└─itemCounts

array

产品调用次数统计

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称,包括tag

-

     └─tag

string

标签

-

     └─count

int32

调用笔数

-

0

     └─fee

number

总费用

-

0

└─itemFees

array

产品调用费用统计

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称,包括tag

-

     └─tag

string

标签

-

     └─count

int32

调用笔数

-

0

     └─fee

number

总费用

-

0

└─dates

array

按日期统计

-

     └─date

string

日期

-

     └─items

array

前10个检测项名称

-

          └─checkItem

string

检测项

-

          └─checkItemName

string

检测项名称,包括tag

-

          └─tag

string

标签

-

          └─count

int32

调用笔数

-

0

          └─fee

number

总费用

-

0

     └─itemCount

int32

检测项数量

-

0

     └─totalCount

int32

总数量

-

0

     └─totalFee

number

总金额

-

0

└─checkItems

array

产品项

-

""","""

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalCount": 0,
    "totalFee": 0,
    "itemCounts": [
      {
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "count": 0,
        "fee": 0
      }
    ],
    "itemFees": [
      {
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "count": 0,
        "fee": 0
      }
    ],
    "dates": [
      {
        "date": "",
        "items": [
          {
            "checkItem": "",
            "checkItemName": "",
            "tag": "",
            "count": 0,
            "fee": 0
          }
        ],
        "itemCount": 0,
        "totalCount": 0,
        "totalFee": 0
      }
    ],
    "checkItems": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.8.客户产品管理

2.8.1.搜索产品

Type: POST

Author: wangqidong created on 2024/10/24

Content-Type: application/json

Description: 搜索产品

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

queryCollected

boolean

查询已收藏

false

-

true

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

categoryCode

string

分类

false

-

deptId

int64

组织id

false

-

0

excludeDeptId

int64

排除用户拥有的产品

false

-

0

checkItemList

array

产品编码列表

false

-

""","""

excludeCheckItemList

array

排除的产品编码列表

false

-

""","""

deptIdList

array

No comments found.

false

-

"0,0"

deptItemStateList

array

No comments found.

false

-

"0,0"

compareDeptId

int64

用于判断该用户有没有授权产品

false

-

0

isFusion

boolean

是否聚合产品

false

-

true

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

state

int32

状态,-1:已下架,10:已上架,5:异常

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/deptItem/searchItems' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "queryCollected": true,
  "applicable": true,
  "categoryCode": "",
  "deptId": 0,
  "excludeDeptId": 0,
  "checkItemList": [
    ""
  ],
  "excludeCheckItemList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "deptItemStateList": [
    0
  ],
  "compareDeptId": 0,
  "isFusion": true,
  "checkType": 0,
  "state": 0,
  "cacheFlag": 0,
  "feeType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.8.2.申请产品

Type: POST

Author: wangqidong created on 2024/10/24

Content-Type: application/json

Description: 申请产品

Body-parameters:

Parameter Type Description Required Since Example

checkItemList

array

申请开通的产品

true

-

└─itemCode

string

产品编码

true

-

└─itemName

string

产品名称

false

-

applyRemark

string

申请备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/deptItem/apply' --data '{
  "checkItemList": [
    {
      "itemCode": "",
      "itemName": ""
    }
  ],
  "applyRemark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

2.8.3.我的产品

Type: POST

Author: wangqidong created on 2024/10/24

Content-Type: application/json

Description: 我的产品

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

checkItemList

array

产品编码列表

false

-

""","""

stateList

array

状态列表

false

-

"0,0"

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

categoryCode

string

分类

false

-

taskType

int32

是否可在线测试,10-单笔测试,20-批量测试

false

-

0

merchantId

int64

商户id

false

-

0

deptIdList

array

组织id

false

-

"0,0"

fusionDeptItemId

int64

聚合产品授权记录id

false

-

0

idList

array

指定deptItemId

false

-

"0,0"

queryAdjusting

boolean

是否查询调整中记录

false

-

true

contractStateList

array

合同签署状态

false

-

"0,0"

isFusion

boolean

是否是聚合产品

false

-

true

crmQuery

boolean

No comments found.

false

-

true

querySpreader

boolean

查询推广员信息

false

-

true

matchSpreaderMonth

string

No comments found.

false

-

spreaderId

int64

推广方id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/deptItem/mineList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "checkItemList": [
    ""
  ],
  "stateList": [
    0
  ],
  "applicable": true,
  "categoryCode": "",
  "taskType": 0,
  "merchantId": 0,
  "deptIdList": [
    0
  ],
  "fusionDeptItemId": 0,
  "idList": [
    0
  ],
  "queryAdjusting": true,
  "contractStateList": [
    0
  ],
  "isFusion": true,
  "crmQuery": true,
  "querySpreader": true,
  "matchSpreaderMonth": "",
  "spreaderId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.9.钱包账户

2.9.1.查询钱包账户

Type: POST

Author: wangqidong created on 2025/2/12

Content-Type: application/json

Description: 查询钱包账户

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/wallet/wallet/list' --data '{}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

钱包id

-

0

└─userId

int64

用户id

-

0

└─accountName

string

账户名

-

└─accountType

int32

账户类型,10-个人账户,20-企业账户

-

0

└─isDefault

boolean

是否默认钱包

-

true

└─state

int32

钱包状态,-1-已锁定,0-待开通,10-正常

-

0

└─balance

number

账户余额

-

0

└─overdraftState

int32

后付状态,-1-已锁定,0-预充值(不允许超支),10-预充值(允许超支),20-月结

-

0

└─overdraftQuota

number

可透支额度

-

0

└─forewarnThreshold

number

预警阈值

-

0

└─forewarnContactList

array

预警联系人信息

-

     └─id

int64

联系人id

-

0

     └─linkman

string

联系人姓名

-

     └─mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

-

     └─email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

-

     └─webhook

string

webhook

-

     └─isDefault

boolean

是否默认联系人

-

true

└─payRouteList

array

支付路由列表

-

     └─appcode

string

专属应用编码

-

     └─appName

string

专属应用名称

-

     └─properSceneList

array

专属场景

-

""","""

└─tenantId

int64

租户id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "userId": 0,
      "accountName": "",
      "accountType": 0,
      "isDefault": true,
      "state": 0,
      "balance": 0,
      "overdraftState": 0,
      "overdraftQuota": 0,
      "forewarnThreshold": 0,
      "forewarnContactList": [
        {
          "id": 0,
          "linkman": "",
          "mobile": "",
          "email": "",
          "webhook": "",
          "isDefault": true
        }
      ],
      "payRouteList": [
        {
          "appcode": "",
          "appName": "",
          "properSceneList": [
            ""
          ]
        }
      ],
      "tenantId": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

2.9.2.钱包流水

Type: POST

Author: wangqidong created on 2025/2/12

Content-Type: application/json

Description: 钱包流水

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

assignWalletId

int64

钱包账户id

true

-

0

flowType

string

流水类型,in-收入,out-支出

false

-

bizTypeList

array

业务类型,bizPay-支付,recharge-账户充值,refund-退款

false

-

""","""

createTimeGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/wallet/wallet/flowList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "assignWalletId": 0,
  "flowType": "",
  "bizTypeList": [
    ""
  ],
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─walletId

int64

钱包id

-

0

     └─flowNo

string

流水号

-

     └─flowType

string

流水类型,in-收入,out-支出

-

     └─bizType

string

业务类型,pay-支付,recharge-账户充值,refund-退款

-

     └─payMethod

string

支付方式

-

     └─businessNo

string

业务单号

-

     └─feeName

string

费用项名称

-

     └─flowAmount

number

金额

-

0

     └─afterBalance

number

操作后余额

-

0

     └─tenantId

int64

租户id

-

0

     └─appcode

string

应用编码

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "walletId": 0,
        "flowNo": "",
        "flowType": "",
        "bizType": "",
        "payMethod": "",
        "businessNo": "",
        "feeName": "",
        "flowAmount": 0,
        "afterBalance": 0,
        "tenantId": 0,
        "appcode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

2.9.3.申请充值

Type: POST

Author: wangqidong created on 2025/2/12

Content-Type: application/json

Description: 申请充值

Body-parameters:

Parameter Type Description Required Since Example

walletId

int64

账户id,未指定取登录用户匹配

false

-

0

rechargeAmount

number

充值金额金额

true

-

0

payMethod

enum

支付方式
(See: 支付方式)

false

-

WALLET

payerOpenid

string

支付人openid

false

-

applyAppType

string

申请的支付端类型,mini:小程序,wechatMp:微信公众号,pc:pc网站,app:app,h5:h5

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/wallet/applyRecharge' --data '{
  "walletId": 0,
  "rechargeAmount": 0,
  "payMethod": "",
  "payerOpenid": "",
  "applyAppType": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─payNo

string

支付单号

-

└─payType

string

业务类型,pay-支付,recharge-账户充值,refund-退款

-

└─payMethod

string

支付方式

-

└─businessType

string

业务类型(业务方指定)

-

└─businessNo

string

业务单号

-

└─state

int32

状态

-

0

└─feeName

string

费用项名称

-

└─originAmount

number

原始金额

-

0

└─amount

number

需支付金额

-

0

└─applyPayResult

object

申请支付结果(传递了支付方式会返回)

-

     └─isPaid

boolean

是否已支付

-

true

     └─logo

string

Logo

-

     └─payData

object

支付数据

-

          └─logo

string

Logo

-

          └─expireSeconds

int32

剩余可支付时间(秒)

-

0

          └─payUrl

string

支付地址

-

          └─payInfo

string

支付信息

-

          └─wechatPayExtra

object

微信支付额外字段

-

               └─appId

string

appid

-

               └─timeStamp

string

时间戳

-

               └─nonceStr

string

随机字符串

-

               └─package

string

支付地址

-

               └─signType

string

签名类型,默认为RSA,仅支持RSA。

-

               └─paySign

string

签名

-

     └─payAccountId

int64

No comments found.

-

0

     └─walletFlowNo

string

钱包流水编号,钱包支付会记录

-

└─extraData

object

额外数据

-

     └─giveQuota

number

赠送金额

-

0

     └─onlyNewGive

boolean

赠送金额是否新客专享

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "payNo": "",
    "payType": "",
    "payMethod": "",
    "businessType": "",
    "businessNo": "",
    "state": 0,
    "feeName": "",
    "originAmount": 0,
    "amount": 0,
    "applyPayResult": {
      "isPaid": true,
      "logo": "",
      "payData": {
        "logo": "",
        "expireSeconds": 0,
        "payUrl": "",
        "payInfo": "",
        "wechatPayExtra": {
          "appId": "",
          "timeStamp": "",
          "nonceStr": "",
          "package": "",
          "signType": "",
          "paySign": ""
        }
      },
      "payAccountId": 0,
      "walletFlowNo": ""
    },
    "extraData": {
      "giveQuota": 0,
      "onlyNewGive": true
    }
  },
  "timestamp": 0,
  "traceId": ""
}

2.9.4.查询钱包预警

Type: POST

Author: wangqidong created on 2025/2/12

Content-Type: application/json

Description: 查询钱包预警

Body-parameters:

Parameter Type Description Required Since Example

walletId

int64

专属钱包场景

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/wallet/queryWallet' --data '{
  "walletId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─walletId

int64

钱包id

-

0

└─balance

number

账户余额

-

0

└─overdraftState

int32

后付状态,0-预充值(不允许超支),10-预充值(允许超支),20-月结

-

0

└─overdraftQuota

number

可透支额度

-

0

└─forewarnThreshold

number

预警阈值

-

0

└─forewarnContactList

array

预警联系人,多个逗号分割

-

     └─id

int64

联系人id

-

0

     └─linkman

string

联系人姓名

-

     └─mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

-

     └─email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

-

     └─webhook

string

webhook

-

     └─isDefault

boolean

是否默认联系人

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "walletId": 0,
    "balance": 0,
    "overdraftState": 0,
    "overdraftQuota": 0,
    "forewarnThreshold": 0,
    "forewarnContactList": [
      {
        "id": 0,
        "linkman": "",
        "mobile": "",
        "email": "",
        "webhook": "",
        "isDefault": true
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

2.9.5.配置账户余额预警

Type: POST

Author: wangqidong created on 2025/2/12

Content-Type: application/json

Description: 配置账户余额预警

Body-parameters:

Parameter Type Description Required Since Example

walletId

int64

钱包id

true

-

0

forewarnThreshold

number

预警阈值 Validation[DecimalMin(value=0, message=预警阈值不能低于0); DecimalMax(value=100000, message=预警阈值不能超过100000)]

true

-

0

forewarnContactList

array

预警联系人id

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/beeback/wallet/configWallet' --data '{
  "walletId": 0,
  "forewarnThreshold": 0,
  "forewarnContactList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.运营平台

3.1.CrmMarketingController

3.1.1.营销客户列表

Type: POST

Author: wangqidong created on 2025/10/20

Content-Type: application/json

Description: 营销客户列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/marketing/cust/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─custCode

string

客户编码

-

     └─custName

string

客户名

-

     └─userId

int64

用户id

-

0

     └─price

number

单价

-

0

     └─includeDeptIds

array

营销订阅客户列表

-

"0,0"

     └─sftpServer

string

sftp服务器,ip+端口

-

     └─sftpUser

string

sftp账号

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "custCode": "",
        "custName": "",
        "userId": 0,
        "price": 0,
        "includeDeptIds": [
          0
        ],
        "sftpServer": "",
        "sftpUser": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.1.2.可订阅客户列表

Type: POST

Author: wangqidong created on 2025/10/20

Content-Type: application/json

Description: 可订阅客户列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

assistantId

int64

维护人id

false

-

0

nonAssistantId

boolean

是否无销售员

false

-

true

state

int32

企业状态,0:未认证,10:已认证

false

-

0

createTimeGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

customerNatureList

array

客户业务类型

false

-

""","""

deptIds

array

包括的组织id

false

-

"0,0"

excludeDeptIds

array

排除的组织id

false

-

"0,0"

merchantIdList

array

商户id

false

-

"0,0"

gainChannel

string

No comments found.

false

-

excludeCheckItem

string

移除已开通产品的客户

false

-

salesmanId

int64

销售员id

false

-

0

matchMonth

string

匹配月份

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/marketing/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "assistantId": 0,
  "nonAssistantId": true,
  "state": 0,
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss",
  "customerType": 0,
  "customerNatureList": [
    ""
  ],
  "deptIds": [
    0
  ],
  "excludeDeptIds": [
    0
  ],
  "merchantIdList": [
    0
  ],
  "gainChannel": "",
  "excludeCheckItem": "",
  "salesmanId": 0,
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─organizationId

int64

组织id

-

0

     └─merchantId

int64

商户id

-

0

     └─mobile

string

手机号

-

     └─organizationName

string

组织名称

-

     └─aliasName

string

组织别名

-

     └─state

int32

企业状态,0:待审核,10:正常

-

0

     └─overdraftType

enum

超支类型

-

UNACTIVATED

     └─logo

string

企业logo

-

     └─assistantId

int64

维护人id

-

0

     └─assistantName

string

维护人姓名

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─email

string

邮箱

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─industry

string

所属行业

-

     └─enableDevelop

boolean

开发者权限是否开通

-

true

     └─deptId

int64

开发账户id

-

0

     └─appId

string

接口appId

-

     └─appSecret

string

接口密钥,

-

     └─authRecord

object

认证记录

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─userId

int64

用户id

-

0

          └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

          └─state

int32

状态

-

0

          └─enterpriseName

string

企业姓名

-

          └─enterpriseNo

string

统一社会信用编码

-

          └─realName

string

真实姓名/法人姓名

-

          └─idCard

string

身份证号/法人身份证

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─idCardFront

string

身份证/法人身份证正面

-

          └─idCardBack

string

法人身份证法人身份证反面

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─linkman

string

联系人

-

          └─linkMobile

string

联系电话

-

          └─linkEmail

string

联系人邮箱

-

          └─linkPosition

string

联系人职位

-

          └─businessDesc

string

业务介绍

-

          └─addressInfo

object

地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─industry

enum

行业编码

-

LEASE3C

          └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

          └─auditRemark

string

审核意见

-

          └─sourceAppcode

string

注册系统编码

-

          └─tenantId

int64

租户id

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─certificationList

array

资质文件

-

""","""

     └─whiteIpList

string

ip白名单

-

     └─addressInfo

object

地址信息

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─sourceAppcode

string

注册系统编码

-

     └─enabledApps

array

已开通应用编码

-

          └─appcode

string

应用编码

-

          └─appName

string

应用名称

-

          └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

          └─systemCode

string

所属系统编码

-

          └─domain

string

域名

-

          └─logo

string

应用logo

-

          └─tenantId

int64

默认所属租户id

-

0

          └─bizAppList

array

关联的业务系统

-

     └─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─enterpriseDesc

string

企业描述

-

     └─customerNature

string

客户业务类型

-

     └─opportunitySalesmanId

int64

商机业务员id

-

0

     └─opportunityRoleType

string

商机业务员类型

-

     └─subscribeCount

int32

订阅数量

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "organizationId": 0,
        "merchantId": 0,
        "mobile": "",
        "organizationName": "",
        "aliasName": "",
        "state": 0,
        "overdraftType": 0,
        "logo": "",
        "assistantId": 0,
        "assistantName": "",
        "linkman": "",
        "linkMobile": "",
        "email": "",
        "customerType": 0,
        "industry": "",
        "enableDevelop": true,
        "deptId": 0,
        "appId": "",
        "appSecret": "",
        "authRecord": {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "userId": 0,
          "authType": 0,
          "state": 0,
          "enterpriseName": "",
          "enterpriseNo": "",
          "realName": "",
          "idCard": "",
          "mobile": "",
          "businessImg": "",
          "idCardFront": "",
          "idCardBack": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "linkman": "",
          "linkMobile": "",
          "linkEmail": "",
          "linkPosition": "",
          "businessDesc": "",
          "addressInfo": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "industry": "",
          "auditTime": "yyyy-MM-dd HH:mm:ss",
          "auditRemark": "",
          "sourceAppcode": "",
          "tenantId": 0
        },
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "certificationList": [
          ""
        ],
        "whiteIpList": "",
        "addressInfo": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "sourceAppcode": "",
        "enabledApps": [
          {
            "appcode": "",
            "appName": "",
            "appType": "",
            "systemCode": "",
            "domain": "",
            "logo": "",
            "tenantId": 0,
            "bizAppList": [
              {
                "$ref": ".."
              }
            ]
          }
        ],
        "nearFollowDate": "yyyy-MM-dd",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "enterpriseDesc": "",
        "customerNature": "",
        "opportunitySalesmanId": 0,
        "opportunityRoleType": "",
        "subscribeCount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.1.3.订阅客户

Type: POST

Author: wangqidong created on 2025/10/20

Content-Type: application/json

Description: 订阅客户

Body-parameters:

Parameter Type Description Required Since Example

custCode

string

客户编码

true

-

deptIds

array

订阅客户列表

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/marketing/cust/saveSubscribe' --data '{
  "custCode": "",
  "deptIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.2.页面配置

3.2.1.保存页面菜单

Type: POST

Author: wangqidong created on 2024/11/14

Content-Type: application/json

Description: 保存页面菜单

Body-parameters:

Parameter Type Description Required Since Example

id

int64

菜单id,修改必传

false

-

0

code

string

菜单编码,同一目录下不可重复

true

-

title

string

菜单名称,同一目录下不可重复

true

-

pid

int64

上级菜单id

false

-

0

component

string

组件,同一目录下不可重复

false

-

icon

string

图标

false

-

isDir

boolean

是否是目录

false

-

true

path

string

路径,同一目录下不可重复

false

-

highlightMenu

string

高亮菜单

false

-

redirectUrl

string

重定向地址

false

-

enable

boolean

是否启用

false

-

true

hidden

boolean

是否隐藏

false

-

true

hiddenSidebar

boolean

是否隐藏侧边栏

false

-

true

cacheable

boolean

是否缓存

false

-

true

buttons

array

按钮

false

-

└─label

string

按钮名称

false

-

└─value

string

按钮编码

false

-

sort

int32

排序

false

-

0

extra

object

扩展属性

false

-

appcode

string

应用编码

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/pageConfig/save' --data '{
  "id": 0,
  "code": "",
  "title": "",
  "pid": 0,
  "component": "",
  "icon": "",
  "isDir": true,
  "path": "",
  "highlightMenu": "",
  "redirectUrl": "",
  "enable": true,
  "hidden": true,
  "hiddenSidebar": true,
  "cacheable": true,
  "buttons": [
    {
      "label": "",
      "value": ""
    }
  ],
  "sort": 0,
  "extra": {},
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.2.2.查询菜单

Type: POST

Author: wangqidong created on 2024/11/14

Content-Type: application/json

Description: 查询菜单

Body-parameters:

Parameter Type Description Required Since Example

appcode

string

应用编码

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/pageConfig/list' --data '{
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─code

string

菜单编码

-

└─title

string

菜单名称

-

└─pid

int64

上级菜单id

-

0

└─pTitle

string

上级菜单名称

-

└─level

int32

部门等级,最多3级

-

0

└─component

string

组件

-

└─icon

string

图标

-

└─isDir

boolean

是否是目录

-

true

└─path

string

路径

-

└─highlightMenu

string

高亮菜单

-

└─redirectUrl

string

重定向地址

-

└─enable

boolean

是否启用

-

true

└─hidden

boolean

是否隐藏

-

true

└─hiddenSidebar

boolean

是否隐藏侧边栏

-

true

└─cacheable

boolean

是否缓存

-

true

└─buttons

array

按钮

-

     └─label

string

按钮名称

-

     └─value

string

按钮编码

-

└─extra

object

扩展属性

-

└─sort

int32

排序

-

0

└─appcode

string

应用编码

-

└─subList

array

下级菜单列表

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "code": "",
      "title": "",
      "pid": 0,
      "pTitle": "",
      "level": 0,
      "component": "",
      "icon": "",
      "isDir": true,
      "path": "",
      "highlightMenu": "",
      "redirectUrl": "",
      "enable": true,
      "hidden": true,
      "hiddenSidebar": true,
      "cacheable": true,
      "buttons": [
        {
          "label": "",
          "value": ""
        }
      ],
      "extra": {},
      "sort": 0,
      "appcode": "",
      "subList": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.2.3.删除菜单

Type: POST

Author: wangqidong created on 2024/11/14

Content-Type: application/json

Description: 删除菜单

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/pageConfig/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.账单管理

3.3.1.账单列表

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 账单列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

billDateGte

string

账单月份大于,格式:2024-01

false

-

billDateLte

string

账单月份小于,格式:2024-01

false

-

statementNoList

array

账单编号

false

-

""","""

deptIdList

array

客户id

false

-

"0,0"

stateList

array

账单状态

false

-

"0,0"

invoiceStateList

array

开票状态

false

-

"0,0"

overdraftTypeList

array

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "billDateGte": "",
  "billDateLte": "",
  "statementNoList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "invoiceStateList": [
    0
  ],
  "overdraftTypeList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─userId

int64

客户id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─stateDesc

string

账单状态

-

     └─invoiceState

int32

开票状态

-

0

     └─totalAmount

number

总金额

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─notInvoicedAmount

number

未开票金额

-

0

     └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─billDetailList

array

账单明细(详情会返回)

-

          └─id

int64

No comments found.

-

0

          └─billDate

string

账单日期

-

          └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─checkItem

string

检测项

-

          └─checkItemName

string

检测项名称

-

          └─tag

string

标记

-

          └─dataSourceId

int32

数据源id

-

0

          └─dataSource

string

数据源

-

          └─dataSourceCode

string

数据源代号

-

          └─checkConfigId

int32

数据源配置id

-

0

          └─count

int32

调用笔数

-

0

          └─freeCount

int32

免费次数

-

0

          └─chargeCount

int32

计费次数

-

0

          └─price

number

单价

-

0

          └─totalFee

number

总费用

-

0

          └─totalCost

number

总成本

-

0

          └─settledAmount

number

已结算金额

-

0

          └─statementNo

string

对账单号

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─emails

array

通知邮箱地址

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─settledAmount

number

已结算金额

-

0

     └─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

     └─sendRecordList

array

账单发送记录

-

          └─receiverList

array

收件人

-

""","""

          └─ccList

array

抄送

-

""","""

          └─attachmentUrl

string

账单附件地址

-

          └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

          └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

     └─paymentStateDesc

string

回款状态

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "userId": 0,
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "stateDesc": "",
        "invoiceState": 0,
        "totalAmount": 0,
        "invoicedAmount": 0,
        "notInvoicedAmount": 0,
        "confirmDate": "yyyy-MM-dd HH:mm:ss",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "billDetailList": [
          {
            "id": 0,
            "billDate": "",
            "billType": "",
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "checkItem": "",
            "checkItemName": "",
            "tag": "",
            "dataSourceId": 0,
            "dataSource": "",
            "dataSourceCode": "",
            "checkConfigId": 0,
            "count": 0,
            "freeCount": 0,
            "chargeCount": 0,
            "price": 0,
            "totalFee": 0,
            "totalCost": 0,
            "settledAmount": 0,
            "statementNo": "",
            "createDate": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "emails": [
          ""
        ],
        "attachmentUrl": "",
        "settledAmount": 0,
        "overdraftType": 0,
        "sendRecordList": [
          {
            "receiverList": [
              ""
            ],
            "ccList": [
              ""
            ],
            "attachmentUrl": "",
            "sendTime": "yyyy-MM-dd HH:mm:ss",
            "state": 0
          }
        ],
        "paymentStateDesc": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.2.账单统计

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 账单统计

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

billDateGte

string

账单月份大于,格式:2024-01

false

-

billDateLte

string

账单月份小于,格式:2024-01

false

-

statementNoList

array

账单编号

false

-

""","""

deptIdList

array

客户id

false

-

"0,0"

stateList

array

账单状态

false

-

"0,0"

invoiceStateList

array

开票状态

false

-

"0,0"

overdraftTypeList

array

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/statistics' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "billDateGte": "",
  "billDateLte": "",
  "statementNoList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "invoiceStateList": [
    0
  ],
  "overdraftTypeList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalAmountSum

number

总金额

-

0

└─invoicedAmountSum

number

已开票金额

-

0

└─settledAmountSum

number

已结算金额

-

0

└─receivableAmountSum

number

未结算金额合计

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalAmountSum": 0,
    "invoicedAmountSum": 0,
    "settledAmountSum": 0,
    "receivableAmountSum": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.3.账单导出

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 账单导出

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

billDateGte

string

账单月份大于,格式:2024-01

false

-

billDateLte

string

账单月份小于,格式:2024-01

false

-

statementNoList

array

账单编号

false

-

""","""

deptIdList

array

客户id

false

-

"0,0"

stateList

array

账单状态

false

-

"0,0"

invoiceStateList

array

开票状态

false

-

"0,0"

overdraftTypeList

array

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/export' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "billDateGte": "",
  "billDateLte": "",
  "statementNoList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "invoiceStateList": [
    0
  ],
  "overdraftTypeList": [
    0
  ]
}'

Response-example:

Return void.

3.3.4.账单详情

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 账单详情

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

statementNo

string

对账单号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/detail' --data '{
  "deptId": 0,
  "statementNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

id

-

0

└─statementNo

string

账单编号

-

└─billDate

string

账单月份

-

└─userId

int64

客户id

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─appId

string

appid

-

└─state

int32

账单状态

-

0

└─stateDesc

string

账单状态

-

└─invoiceState

int32

开票状态

-

0

└─totalAmount

number

总金额

-

0

└─invoicedAmount

number

已开票金额

-

0

└─notInvoicedAmount

number

未开票金额

-

0

└─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

└─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

└─billDetailList

array

账单明细(详情会返回)

-

     └─id

int64

No comments found.

-

0

     └─billDate

string

账单日期

-

     └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标记

-

     └─dataSourceId

int32

数据源id

-

0

     └─dataSource

string

数据源

-

     └─dataSourceCode

string

数据源代号

-

     └─checkConfigId

int32

数据源配置id

-

0

     └─count

int32

调用笔数

-

0

     └─freeCount

int32

免费次数

-

0

     └─chargeCount

int32

计费次数

-

0

     └─price

number

单价

-

0

     └─totalFee

number

总费用

-

0

     └─totalCost

number

总成本

-

0

     └─settledAmount

number

已结算金额

-

0

     └─statementNo

string

对账单号

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─emails

array

通知邮箱地址

-

""","""

└─attachmentUrl

string

账单附件地址

-

└─settledAmount

number

已结算金额

-

0

└─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

└─sendRecordList

array

账单发送记录

-

     └─receiverList

array

收件人

-

""","""

     └─ccList

array

抄送

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

     └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

└─paymentStateDesc

string

回款状态

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "statementNo": "",
    "billDate": "",
    "userId": 0,
    "deptId": 0,
    "deptName": "",
    "appId": "",
    "state": 0,
    "stateDesc": "",
    "invoiceState": 0,
    "totalAmount": 0,
    "invoicedAmount": 0,
    "notInvoicedAmount": 0,
    "confirmDate": "yyyy-MM-dd HH:mm:ss",
    "invoiceTime": "yyyy-MM-dd HH:mm:ss",
    "billDetailList": [
      {
        "id": 0,
        "billDate": "",
        "billType": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "dataSourceId": 0,
        "dataSource": "",
        "dataSourceCode": "",
        "checkConfigId": 0,
        "count": 0,
        "freeCount": 0,
        "chargeCount": 0,
        "price": 0,
        "totalFee": 0,
        "totalCost": 0,
        "settledAmount": 0,
        "statementNo": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "emails": [
      ""
    ],
    "attachmentUrl": "",
    "settledAmount": 0,
    "overdraftType": 0,
    "sendRecordList": [
      {
        "receiverList": [
          ""
        ],
        "ccList": [
          ""
        ],
        "attachmentUrl": "",
        "sendTime": "yyyy-MM-dd HH:mm:ss",
        "state": 0
      }
    ],
    "paymentStateDesc": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.5.合并账单明细

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 合并账单明细

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

statementNo

string

对账单号

true

-

mergeDetailIds

array

合并明细id

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/mergeDetail' --data '{
  "deptId": 0,
  "statementNo": "",
  "mergeDetailIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.6.修改账单

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 修改账单

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

statementNo

string

账单编号

true

-

canInvoiceAmount

number

可开票金额

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/modifyStatement' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "statementNo": "",
  "canInvoiceAmount": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.7.手动保存账单明细

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 手动保存账单明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id,不为空代表编辑

false

-

0

statementNo

string

对账单号,新增必填

false

-

checkItem

string

产品编码

true

-

checkItemName

string

产品名称

false

-

count

int32

调用笔数

false

-

0

chargeCount

int32

计费次数

false

-

0

price

number

单价

false

-

0

totalFee

number

总费用

false

-

0

settledAmount

number

已结算金额

false

-

0

receivableAmount

number

未结算金额

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/saveSubBill' --data '{
  "id": 0,
  "statementNo": "",
  "checkItem": "",
  "checkItemName": "",
  "count": 0,
  "chargeCount": 0,
  "price": 0,
  "totalFee": 0,
  "settledAmount": 0,
  "receivableAmount": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.8.移除账单明细

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 移除账单明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/removeSubBill' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.9.获取账单附件

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 获取账单附件

Body-parameters:

Parameter Type Description Required Since Example

billId

int64

账单id

true

-

0

rebuildForce

boolean

是否强制重新生成,默认false

false

-

true

appcode

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/gainAttachment' --data '{
  "billId": 0,
  "rebuildForce": true,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.10.查询账单发送邮箱

Type: GET

Author: wangqidong created on 2024/10/29

Content-Type: application/x-www-form-urlencoded

Description: 查询账单发送邮箱

Path-parameters:

Parameter Type Description Required Since Example

deptId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/bill/selectReceivers/{deptId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─receiverList

array

收件人

-

""","""

└─ccList

array

抄送

-

""","""

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "receiverList": [
      ""
    ],
    "ccList": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.11.核准账单

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 核准账单

Body-parameters:

Parameter Type Description Required Since Example

billId

int64

账单id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/recheck' --data '{
  "billId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.12.发送账单

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 发送账单

Body-parameters:

Parameter Type Description Required Since Example

billId

int64

账单id

true

-

0

receiverList

array

收件人 Validation[Size(max=10, min=0, message=收件人最多10个)]

true

-

""","""

ccList

array

抄送 Validation[Size(max=10, min=0, message=抄送最多10个)]

false

-

""","""

attachmentUrl

string

附件地址

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/resend' --data '{
  "billId": 0,
  "receiverList": [
    ""
  ],
  "ccList": [
    ""
  ],
  "attachmentUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.13.作废账单

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 作废账单

Body-parameters:

Parameter Type Description Required Since Example

ids

array

ids

true

-

"0,0"

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invalidate' --data '{
  "ids": [
    0
  ],
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.14.归档

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 归档

Body-parameters:

Parameter Type Description Required Since Example

ids

array

ids

true

-

"0,0"

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/archive' --data '{
  "ids": [
    0
  ],
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.15.删除账单

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 删除账单

Body-parameters:

Parameter Type Description Required Since Example

ids

array

ids

true

-

"0,0"

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/delete' --data '{
  "ids": [
    0
  ],
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.16.未开票统计

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 未开票统计

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

statementNoList

array

账单编号,传null统计全部可开票账单

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invoice/calculate' --data '{
  "deptId": 0,
  "statementNoList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalAmountSum

number

账单金额合计

-

0

└─invoicedAmountSum

number

已开票金额合计

-

0

└─notInvoicedAmountSum

number

未开票金额

-

0

└─statementDetails

array

No comments found.

-

     └─statementId

int64

对账单id

-

0

     └─statementNo

string

对账单编号

-

     └─invoiceAmount

number

开票金额

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalAmountSum": 0,
    "invoicedAmountSum": 0,
    "notInvoicedAmountSum": 0,
    "statementDetails": [
      {
        "statementId": 0,
        "statementNo": "",
        "invoiceAmount": 0
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.17.新增开票

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 新增开票

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

statementNoList

array

账单编号,不传默认全部开票

false

-

""","""

invoiceAmount

number

开票金额

true

-

0

invoiceType

string

开票类型,normal-普票,special-专票

true

-

headerName

string

抬头

true

-

tin

string

税号

true

-

email

string

邮箱

true

-

invoiceUrl

string

发票地址

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invoice/add' --data '{
  "deptId": 0,
  "statementNoList": [
    ""
  ],
  "invoiceAmount": 0,
  "invoiceType": "",
  "headerName": "",
  "tin": "",
  "email": "",
  "invoiceUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.18.开票记录

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 开票记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

机构id

false

-

0

deptIdList

array

机构id

false

-

"0,0"

stateList

array

开票状态

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invoice/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─invoiceType

string

开票类型,normal-普票,special-专票

-

     └─state

int32

开票状态

-

0

     └─invoiceAmount

number

开票金额

-

0

     └─statementList

array

包含的账单编号

-

          └─id

int64

id

-

0

          └─statementNo

string

账单编号

-

          └─billDate

string

账单月份

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─state

int32

账单状态

-

0

          └─invoiceState

int32

开票状态

-

0

          └─invoicedAmount

number

已开票金额

-

0

          └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─headerName

string

发票抬头

-

     └─tin

string

税号

-

     └─email

string

邮箱

-

     └─invoiceTime

string

开具时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceUrl

string

发票地址

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptId": 0,
        "deptName": "",
        "invoiceType": "",
        "state": 0,
        "invoiceAmount": 0,
        "statementList": [
          {
            "id": 0,
            "statementNo": "",
            "billDate": "",
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "state": 0,
            "invoiceState": 0,
            "invoicedAmount": 0,
            "invoiceTime": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "headerName": "",
        "tin": "",
        "email": "",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "invoiceUrl": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.19.开票审核

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 开票审核

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

auditType

string

审核类型,pass-通过,reject-拒绝

true

-

rejectReason

string

拒绝原因

false

-

invoiceUrl

string

发票文件地址

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invoice/audit' --data '{
  "id": 0,
  "auditType": "",
  "rejectReason": "",
  "invoiceUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.20.完成开票

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 完成开票

Body-parameters:

Parameter Type Description Required Since Example

id

int64

开票记录id

true

-

0

invoiceUrl

string

发票文件地址

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invoice/finish' --data '{
  "id": 0,
  "invoiceUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.21.开票记录明细

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 开票记录明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/invoice/detail' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

id

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─invoiceType

string

开票类型,normal-普票,special-专票

-

└─state

int32

开票状态

-

0

└─invoiceAmount

number

开票金额

-

0

└─statementList

array

包含的账单编号

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─invoiceState

int32

开票状态

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

└─headerName

string

发票抬头

-

└─tin

string

税号

-

└─email

string

邮箱

-

└─invoiceTime

string

开具时间

-

yyyy-MM-dd HH:mm:ss

└─invoiceUrl

string

发票地址

-

└─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "deptId": 0,
    "deptName": "",
    "invoiceType": "",
    "state": 0,
    "invoiceAmount": 0,
    "statementList": [
      {
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "invoiceState": 0,
        "invoicedAmount": 0,
        "invoiceTime": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "headerName": "",
    "tin": "",
    "email": "",
    "invoiceTime": "yyyy-MM-dd HH:mm:ss",
    "invoiceUrl": "",
    "createDate": "yyyy-MM-dd HH:mm:ss"
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.22.发送发票到邮箱

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 发送发票到邮箱

Body-parameters:

Parameter Type Description Required Since Example

id

int64

开票记录id

true

-

0

email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/sendInvoiceEmail' --data '{
  "id": 0,
  "email": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.23.上游账单统计

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 上游账单统计

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

billType

string

日期类型,source_daily:按日,source_monthly:按月 Validation[Pattern(regexp=source_daily|source_monthly)]

true

-

startDate

string

开始日期,按月格式:2024-01,按日格式:2024-01-01

false

-

endDate

string

结束日期,按月格式:2024-01,按日格式:2024-01-01

false

-

dataSourceIdList

array

上游数据源id

false

-

"0,0"

checkItemList

array

产品编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/upstream/statistics' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "billType": "",
  "startDate": "",
  "endDate": "",
  "dataSourceIdList": [
    0
  ],
  "checkItemList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalCount

int32

总笔数

-

0

└─totalCost

number

总成本

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalCount": 0,
    "totalCost": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.24.上游账单列表

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 上游账单列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

billType

string

日期类型,source_daily:按日,source_monthly:按月 Validation[Pattern(regexp=source_daily|source_monthly)]

true

-

startDate

string

开始日期,按月格式:2024-01,按日格式:2024-01-01

false

-

endDate

string

结束日期,按月格式:2024-01,按日格式:2024-01-01

false

-

dataSourceIdList

array

上游数据源id

false

-

"0,0"

checkItemList

array

产品编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/upstream/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "billType": "",
  "startDate": "",
  "endDate": "",
  "dataSourceIdList": [
    0
  ],
  "checkItemList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

No comments found.

-

0

     └─billDate

string

账单日期

-

     └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标记

-

     └─dataSourceId

int32

数据源id

-

0

     └─dataSource

string

数据源

-

     └─dataSourceCode

string

数据源代号

-

     └─checkConfigId

int32

数据源配置id

-

0

     └─count

int32

调用笔数

-

0

     └─freeCount

int32

免费次数

-

0

     └─chargeCount

int32

计费次数

-

0

     └─price

number

单价

-

0

     └─totalFee

number

总费用

-

0

     └─totalCost

number

总成本

-

0

     └─settledAmount

number

已结算金额

-

0

     └─statementNo

string

对账单号

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "billDate": "",
        "billType": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "dataSourceId": 0,
        "dataSource": "",
        "dataSourceCode": "",
        "checkConfigId": 0,
        "count": 0,
        "freeCount": 0,
        "chargeCount": 0,
        "price": 0,
        "totalFee": 0,
        "totalCost": 0,
        "settledAmount": 0,
        "statementNo": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.25.上游账单导出

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 上游账单导出

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

billType

string

日期类型,source_daily:按日,source_monthly:按月 Validation[Pattern(regexp=source_daily|source_monthly)]

true

-

startDate

string

开始日期,按月格式:2024-01,按日格式:2024-01-01

false

-

endDate

string

结束日期,按月格式:2024-01,按日格式:2024-01-01

false

-

dataSourceIdList

array

上游数据源id

false

-

"0,0"

checkItemList

array

产品编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/upstream/export' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "billType": "",
  "startDate": "",
  "endDate": "",
  "dataSourceIdList": [
    0
  ],
  "checkItemList": [
    ""
  ]
}'

Response-example:

Return void.

3.3.26.回款记录列表

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 回款记录列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

customerIds

array

客户id

false

-

"0,0"

salesmanIds

array

回款销售员id

false

-

"0,0"

stateList

array

状态,0:待审核,10:已通过,-10:已驳回

false

-

"0,0"

paymentDateGte

string

回款日期大于等于

false

-

yyyy-MM-dd

paymentDateLte

string

回款日期小于等于

false

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/payment/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "customerIds": [
    0
  ],
  "salesmanIds": [
    0
  ],
  "stateList": [
    0
  ],
  "paymentDateGte": "yyyy-MM-dd",
  "paymentDateLte": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─paymentNo

string

回款单号

-

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

回款销售员id

-

0

     └─salesmanName

string

回款销售员名称

-

     └─amount

number

回款金额

-

0

     └─residueAmount

number

结清账单剩余金额(充值到账户)

-

0

     └─afterDebtAmount

number

剩余未回款金额

-

0

     └─state

int32

状态,0:待审核,10:已通过,-10:已驳回

-

0

     └─paymentDate

string

回款日期

-

yyyy-MM-dd

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─certificateList

array

回款凭证,多个逗号分割

-

""","""

     └─remark

string

备注

-

     └─settleDetails

array

账单结算明细,详情接口返回

-

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─id

int64

id

-

0

          └─statementNo

string

账单编号

-

          └─billDate

string

账单月份

-

          └─userId

int64

客户id

-

0

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─state

int32

账单状态

-

0

          └─stateDesc

string

账单状态

-

          └─invoiceState

int32

开票状态

-

0

          └─totalAmount

number

总金额

-

0

          └─invoicedAmount

number

已开票金额

-

0

          └─notInvoicedAmount

number

未开票金额

-

0

          └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

          └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

          └─emails

array

通知邮箱地址

-

""","""

          └─attachmentUrl

string

账单附件地址

-

          └─paymentAmount

number

已回款金额

-

0

          └─settleAmount

number

该笔回款结算金额

-

0

     └─rejectReason

string

驳回原因

-

     └─royaltyRate

number

提成比例

-

0

     └─royaltyAmount

number

提成金额

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "paymentNo": "",
        "customerId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "amount": 0,
        "residueAmount": 0,
        "afterDebtAmount": 0,
        "state": 0,
        "paymentDate": "yyyy-MM-dd",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "certificateList": [
          ""
        ],
        "remark": "",
        "settleDetails": [
          {
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "id": 0,
            "statementNo": "",
            "billDate": "",
            "userId": 0,
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "state": 0,
            "stateDesc": "",
            "invoiceState": 0,
            "totalAmount": 0,
            "invoicedAmount": 0,
            "notInvoicedAmount": 0,
            "confirmDate": "yyyy-MM-dd HH:mm:ss",
            "invoiceTime": "yyyy-MM-dd HH:mm:ss",
            "emails": [
              ""
            ],
            "attachmentUrl": "",
            "paymentAmount": 0,
            "settleAmount": 0
          }
        ],
        "rejectReason": "",
        "royaltyRate": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.27.回款记录合计

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 回款记录合计

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

customerIds

array

客户id

false

-

"0,0"

salesmanIds

array

回款销售员id

false

-

"0,0"

stateList

array

状态,0:待审核,10:已通过,-10:已驳回

false

-

"0,0"

paymentDateGte

string

回款日期大于等于

false

-

yyyy-MM-dd

paymentDateLte

string

回款日期小于等于

false

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/payment/sum' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "customerIds": [
    0
  ],
  "salesmanIds": [
    0
  ],
  "stateList": [
    0
  ],
  "paymentDateGte": "yyyy-MM-dd",
  "paymentDateLte": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─amountSum

number

回款金额合计

-

0

└─royaltyAmountSum

number

提成金额合计

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "amountSum": 0,
    "royaltyAmountSum": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.3.28.回款审核

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 回款审核

Body-parameters:

Parameter Type Description Required Since Example

paymentNo

string

回款单号

true

-

auditType

string

审核类型,pass-通过,reject-拒绝

true

-

rejectReason

string

驳回原因

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/payment/audit' --data '{
  "paymentNo": "",
  "auditType": "",
  "rejectReason": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.3.29.产品账单列表

Type: POST

Author: wangqidong created on 2024/10/29

Content-Type: application/json

Description: 产品账单列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

billType

string

账单类型 cust_daily:按日,cust_monthly:按月

true

-

billDateGte

string

账单日期大于等于,按日格式:2025-11-01,按月格式:2025-11

false

-

billDateLte

string

账单日期小于等于,按日格式:2025-11-01,按月格式:2025-11

false

-

deptIds

array

机构id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/bill/beeBill/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "billType": "",
  "billDateGte": "",
  "billDateLte": "",
  "deptIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

No comments found.

-

0

     └─billDate

string

账单日期

-

     └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标记

-

     └─dataSourceId

int32

数据源id

-

0

     └─dataSource

string

数据源

-

     └─dataSourceCode

string

数据源代号

-

     └─checkConfigId

int32

数据源配置id

-

0

     └─count

int32

调用笔数

-

0

     └─freeCount

int32

免费次数

-

0

     └─chargeCount

int32

计费次数

-

0

     └─price

number

单价

-

0

     └─totalFee

number

总费用

-

0

     └─totalCost

number

总成本

-

0

     └─settledAmount

number

已结算金额

-

0

     └─statementNo

string

对账单号

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "billDate": "",
        "billType": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "dataSourceId": 0,
        "dataSource": "",
        "dataSourceCode": "",
        "checkConfigId": 0,
        "count": 0,
        "freeCount": 0,
        "chargeCount": 0,
        "price": 0,
        "totalFee": 0,
        "totalCost": 0,
        "settledAmount": 0,
        "statementNo": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.4.组织管理

3.4.1.保存部门

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 保存部门

Body-parameters:

Parameter Type Description Required Since Example

id

int64

部门id,修改必填

false

-

0

pid

int64

上级部门

false

-

0

name

string

部门名称

true

-

mangerStaffId

int64

管理员id

false

-

0

remark

string

备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/dept/save' --data '{
  "id": 0,
  "pid": 0,
  "name": "",
  "mangerStaffId": 0,
  "remark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.4.2.查询部门

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 查询部门

Body-parameters:

Parameter Type Description Required Since Example

idList

array

部门id

false

-

"0,0"

pidList

array

上级部门

false

-

"0,0"

name

string

部门名称

false

-

querySub

boolean

是否查询下级部门

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/dept/list' --data '{
  "idList": [
    0
  ],
  "pidList": [
    0
  ],
  "name": "",
  "querySub": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─merchantId

int64

商户id

-

0

└─pid

int64

上级部门id

-

0

└─pname

string

上级部门名称

-

└─name

string

部门名称

-

└─level

int32

部门等级,最多3级

-

0

└─mangerStaffId

int64

管理员id

-

0

└─mangerStaffName

string

管理员姓名

-

└─remark

string

备注

-

└─subList

array

下级部门

-

└─appcode

string

应用编码

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "merchantId": 0,
      "pid": 0,
      "pname": "",
      "name": "",
      "level": 0,
      "mangerStaffId": 0,
      "mangerStaffName": "",
      "remark": "",
      "subList": [
        {
          "$ref": ".."
        }
      ],
      "appcode": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.4.3.删除部门

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 删除部门

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/dept/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.4.4.保存角色

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 保存角色

Body-parameters:

Parameter Type Description Required Since Example

id

int64

角色id,修改必传

false

-

0

name

string

角色名称

true

-

menus

array

菜单权限

false

-

└─pageMenuId

int64

菜单id,不能是目录

false

-

0

└─operableButtons

array

可操作的按钮权限

false

-

""","""

remark

string

备注

false

-

appcode

string

应用编码

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/role/save' --data '{
  "id": 0,
  "name": "",
  "menus": [
    {
      "pageMenuId": 0,
      "operableButtons": [
        ""
      ]
    }
  ],
  "remark": "",
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.4.5.查询角色

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 查询角色

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

id

int64

角色id

false

-

0

name

string

角色名称

false

-

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/role/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "id": 0,
  "name": "",
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─code

string

编码

-

     └─merchantId

int64

商户id

-

0

     └─name

string

角色名称

-

     └─menus

array

菜单权限

-

          └─pageMenuId

int64

菜单id,不能是目录

-

0

          └─operableButtons

array

可操作的按钮权限

-

""","""

     └─deletable

boolean

是否允许删除

-

true

     └─remark

string

备注

-

     └─effectUserId

int64

生效用户id,为空代表应用级别

-

0

     └─appcode

string

应用编码

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "code": "",
        "merchantId": 0,
        "name": "",
        "menus": [
          {
            "pageMenuId": 0,
            "operableButtons": [
              ""
            ]
          }
        ],
        "deletable": true,
        "remark": "",
        "effectUserId": 0,
        "appcode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.4.6.删除角色

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 删除角色

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/role/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.4.7.查询可绑定的用户

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 查询可绑定的用户

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/queryBindableUserList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─username

string

用户名

-

     └─organizationName

string

组织名

-

     └─nickname

string

昵称

-

     └─mobile

string

手机号

-

     └─wechatOpenid

string

微信openid

-

     └─state

int32

用户状态,0:初始状态,-1:已注销,10-正常

-

0

     └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

     └─authTime

string

认证时间

-

yyyy-MM-dd HH:mm:ss

     └─idCard

string

身份证号码

-

     └─portrait

string

头像

-

     └─realName

string

真实姓名

-

     └─email

string

邮箱

-

     └─wechatNo

string

微信号

-

     └─wechatNickname

string

微信昵称

-

     └─sourceAppcode

string

注册系统编码

-

     └─sourceDesc

string

用户来源

-

     └─sourceType

string

用户来源

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─linkAddress

object

联系地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─invitationCode

string

邀请码

-

     └─isTest

boolean

是否测试用户

-

true

     └─tenantId

int64

所属租户id

-

0

     └─roleList

array

权限

-

""","""

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "username": "",
        "organizationName": "",
        "nickname": "",
        "mobile": "",
        "wechatOpenid": "",
        "state": 0,
        "authType": 0,
        "authTime": "yyyy-MM-dd HH:mm:ss",
        "idCard": "",
        "portrait": "",
        "realName": "",
        "email": "",
        "wechatNo": "",
        "wechatNickname": "",
        "sourceAppcode": "",
        "sourceDesc": "",
        "sourceType": "",
        "linkman": "",
        "linkMobile": "",
        "linkAddress": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "invitationCode": "",
        "isTest": true,
        "tenantId": 0,
        "roleList": [
          ""
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.4.8.新增员工

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 新增员工

Body-parameters:

Parameter Type Description Required Since Example

departmentId

int64

部门id

false

-

0

name

string

姓名

true

-

mobile

string

手机号 Validation[Pattern(regexp=1[3-9]\d{9}, message=手机号码格式错误)]

true

-

email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]), message=邮箱格式错误)]

false

-

roleIds

array

角色id

false

-

"0,0"

remark

string

备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/staff/add' --data '{
  "departmentId": 0,
  "name": "",
  "mobile": "",
  "email": "",
  "roleIds": [
    0
  ],
  "remark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

int64

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": 0,
  "timestamp": 0,
  "traceId": ""
}

3.4.9.编辑员工

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 编辑员工

Body-parameters:

Parameter Type Description Required Since Example

id

int64

员工id,修改必传

true

-

0

departmentId

int64

部门id

false

-

0

name

string

姓名

false

-

mobile

string

手机号 Validation[Pattern(regexp=1[3-9]\d{9}, message=手机号码格式错误)]

false

-

email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]), message=邮箱格式错误)]

false

-

roleIds

array

角色id

false

-

"0,0"

remark

string

备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/staff/edit' --data '{
  "id": 0,
  "departmentId": 0,
  "name": "",
  "mobile": "",
  "email": "",
  "roleIds": [
    0
  ],
  "remark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.4.10.查询员工

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 查询员工

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

merchantId

int64

商户id

true

-

0

id

int64

员工id

false

-

0

departmentId

int64

部门id

false

-

0

keyword

string

关键字

false

-

queryScene

string

查询场景:addSalesman-新增销售员

false

-

excludeIdList

array

排除的员工id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/staff/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "merchantId": 0,
  "id": 0,
  "departmentId": 0,
  "keyword": "",
  "queryScene": "",
  "excludeIdList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─merchantId

int64

商户id

-

0

     └─departmentId

int64

部门id

-

0

     └─userId

int64

用户id

-

0

     └─name

string

姓名

-

     └─mobile

string

手机号

-

     └─email

string

邮箱

-

     └─roles

array

角色

-

          └─roleId

int64

角色id

-

0

          └─roleCode

string

角色编码

-

          └─name

string

角色名称

-

          └─appcode

string

应用编码

-

     └─maxWalletQuota

number

钱包调用限额

-

0

     └─usedWalletQuota

number

已使用限额(明细接口才会返回)

-

0

     └─remark

string

备注

-

     └─appcode

string

可见应用,为空皆可见

-

     └─tenantId

int64

No comments found.

-

0

     └─customerCount

int64

客户数

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "merchantId": 0,
        "departmentId": 0,
        "userId": 0,
        "name": "",
        "mobile": "",
        "email": "",
        "roles": [
          {
            "roleId": 0,
            "roleCode": "",
            "name": "",
            "appcode": ""
          }
        ],
        "maxWalletQuota": 0,
        "usedWalletQuota": 0,
        "remark": "",
        "appcode": "",
        "tenantId": 0,
        "customerCount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.4.11.删除员工

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 删除员工

Body-parameters:

Parameter Type Description Required Since Example

id

int64

员工id

true

-

0

confirmed

boolean

是否二次确认,默认false

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/staff/delete' --data '{
  "id": 0,
  "confirmed": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.4.12.员工交接

Type: POST

Author: wangqidong created on 2024/11/13

Content-Type: application/json

Description: 员工交接

Body-parameters:

Parameter Type Description Required Since Example

staffId

int64

需要交接的员工id

true

-

0

effectMonth

string

生效月份,为空默认当月生效

false

-

details

array

交接明细

false

-

└─customerId

int64

客户id

true

-

0

└─targetStaffId

int64

交接对象员工id

true

-

0

└─gradeCode

string

等级编码

false

-

└─royaltyRate

number

提成比例,0-1

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/org/staff/handover' --data '{
  "staffId": 0,
  "effectMonth": "",
  "details": [
    {
      "customerId": 0,
      "targetStaffId": 0,
      "gradeCode": "",
      "royaltyRate": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.销售绩效管理

3.5.1.客户绑定列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 客户绑定列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

customerNameLike

string

客户名

false

-

salesmanIds

array

当前销售员id

false

-

"0,0"

gradeCodes

array

客户分级

false

-

""","""

nearFollowDateGte

string

最近拜访时间大于等于,nearFollowDateGte和nearFollowDateLt仅支持传递一个

false

-

yyyy-MM-dd

nearFollowDateLt

string

最近拜访时间小于,nearFollowDateGte和nearFollowDateLt仅支持传递一个

false

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/maintain/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "customerNameLike": "",
  "salesmanIds": [
    0
  ],
  "gradeCodes": [
    ""
  ],
  "nearFollowDateGte": "yyyy-MM-dd",
  "nearFollowDateLt": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

当前销售员id

-

0

     └─salesmanName

string

当前销售员名

-

     └─state

int32

是否有效

-

0

     └─effectMonth

string

生效月份

-

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─customerState

int32

客户状态,-1:已失效, 0:待审核,10:正常

-

0

     └─joinTime

string

入驻时间

-

yyyy-MM-dd HH:mm:ss

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─industry

string

所属行业

-

     └─deptId

int64

No comments found.

-

0

     └─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "customerId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "state": 0,
        "effectMonth": "",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "customerState": 0,
        "joinTime": "yyyy-MM-dd HH:mm:ss",
        "linkman": "",
        "linkMobile": "",
        "industry": "",
        "deptId": 0,
        "contractState": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.2.指派记录

Type: GET

Author: wangqidong created on 2025/8/19

Content-Type: application/x-www-form-urlencoded

Description: 指派记录

Path-parameters:

Parameter Type Description Required Since Example

customerId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/sales/maintain/assignHistories/{customerId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

当前销售员id

-

0

└─salesmanName

string

当前销售员名

-

└─state

int32

是否有效

-

0

└─effectMonth

string

生效月份

-

└─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

客户分级

-

└─royaltyRate

number

提成比例,0-1

-

0

└─gainChannel

string

获客渠道

-

└─customerState

int32

客户状态,-1:已失效, 0:待审核,10:正常

-

0

└─joinTime

string

入驻时间

-

yyyy-MM-dd HH:mm:ss

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─industry

string

所属行业

-

└─deptId

int64

No comments found.

-

0

└─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "customerId": 0,
      "customerName": "",
      "salesmanId": 0,
      "salesmanName": "",
      "state": 0,
      "effectMonth": "",
      "assignTime": "yyyy-MM-dd HH:mm:ss",
      "gradeCode": "",
      "royaltyRate": 0,
      "gainChannel": "",
      "customerState": 0,
      "joinTime": "yyyy-MM-dd HH:mm:ss",
      "linkman": "",
      "linkMobile": "",
      "industry": "",
      "deptId": 0,
      "contractState": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.5.3.批量指派

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 批量指派

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id

true

-

0

infoList

array

指派内容

true

-

└─customerId

int64

客户id

true

-

0

└─gradeCode

string

客户分级

false

-

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

业绩开始月份,格式:yyyy-MM

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/maintain/batchAssign' --data '{
  "salesmanId": 0,
  "infoList": [
    {
      "customerId": 0,
      "gradeCode": "",
      "royaltyRate": 0,
      "effectMonth": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.4.指派

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 指派

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id

true

-

0

customerId

int64

客户id

true

-

0

deptId

int64

组织id

false

-

0

gradeCode

string

客户分级

false

-

royaltyRate

number

提成比例,0-1

false

-

0

effectMonth

string

业绩开始月份,格式:yyyy-MM,为空默认当月

false

-

gainChannel

string

获客渠道

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/maintain/assign' --data '{
  "salesmanId": 0,
  "customerId": 0,
  "deptId": 0,
  "gradeCode": "",
  "royaltyRate": 0,
  "effectMonth": "",
  "gainChannel": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.5.分级列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 分级列表

Body-parameters:

Parameter Type Description Required Since Example

gradeCodeList

array

分级编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/grade/list' --data '{
  "gradeCodeList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

等级编码

-

└─royaltyRate

number

提成比例,0-1

-

0

└─enabled

boolean

是否启用

-

true

└─remark

string

备注

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "gradeCode": "",
      "royaltyRate": 0,
      "enabled": true,
      "remark": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.5.6.保存客户分级

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 保存客户分级

Body-parameters:

Parameter Type Description Required Since Example

id

int64

不为空代表编辑

false

-

0

gradeCode

string

等级编码

true

-

royaltyRate

number

提成比例,0-1

false

-

0

enabled

boolean

是否启用

false

-

true

remark

string

备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/grade/save' --data '{
  "id": 0,
  "gradeCode": "",
  "royaltyRate": 0,
  "enabled": true,
  "remark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.7.销售业绩列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售业绩列表

Body-parameters:

Parameter Type Description Required Since Example

salesmanIds

array

销售员id

false

-

"0,0"

dateType

string

统计日期类型,daily-按天统计,monthly-按月统计,yearly-按年

true

-

statisticsDate

string

统计日期

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/perf/list' --data '{
  "salesmanIds": [
    0
  ],
  "dateType": "",
  "statisticsDate": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名称

-

└─dateType

string

统计日期类型,monthly-按月统计,yearly-按年

-

└─statisticsDate

string

统计日期

-

└─salesAmount

number

总金额

-

0

└─chargeCalls

int32

计费笔数

-

0

└─paymentAmount

number

回款金额

-

0

└─salesTarget

number

销售目标

-

0

└─royaltyAmount

number

预计提成金额

-

0

└─kpiDetails

array

kpi明细

-

     └─code

string

kpi编码

-

     └─name

string

kpi名称

-

     └─target

string

目标

-

     └─weight

number

权重占比

-

0

     └─reachRate

number

完成率

-

0

└─reachKpiRate

number

绩效达成率

-

0

└─kpiRoyaltyAmount

number

绩效提成

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "salesmanId": 0,
      "salesmanName": "",
      "dateType": "",
      "statisticsDate": "",
      "salesAmount": 0,
      "chargeCalls": 0,
      "paymentAmount": 0,
      "salesTarget": 0,
      "royaltyAmount": 0,
      "kpiDetails": [
        {
          "code": "",
          "name": "",
          "target": "",
          "weight": 0,
          "reachRate": 0
        }
      ],
      "reachKpiRate": 0,
      "kpiRoyaltyAmount": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.5.8.销售目标列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售目标列表

Body-parameters:

Parameter Type Description Required Since Example

salesmanIds

array

销售员id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/target/list' --data '{
  "salesmanIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名称

-

└─monthTarget

number

月度目标

-

0

└─quarterTarget

number

季度目标

-

0

└─yearTarget

number

年度目标

-

0

└─effectMonth

string

开始生效月份

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "salesmanId": 0,
      "salesmanName": "",
      "monthTarget": 0,
      "quarterTarget": 0,
      "yearTarget": 0,
      "effectMonth": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.5.9.销售目标变更记录

Type: GET

Author: wangqidong created on 2025/8/19

Content-Type: application/x-www-form-urlencoded

Description: 销售目标变更记录

Path-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/sales/target/changeList/{salesmanId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名称

-

└─monthTarget

number

月度目标

-

0

└─quarterTarget

number

季度目标

-

0

└─yearTarget

number

年度目标

-

0

└─effectMonth

string

开始生效月份

-

└─beforeMonthTarget

number

变更前月度目标

-

0

└─beforeQuarterTarget

number

变更前季度目标

-

0

└─beforeYearTarget

number

变更前年度目标

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "salesmanId": 0,
      "salesmanName": "",
      "monthTarget": 0,
      "quarterTarget": 0,
      "yearTarget": 0,
      "effectMonth": "",
      "beforeMonthTarget": 0,
      "beforeQuarterTarget": 0,
      "beforeYearTarget": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.5.10.保存销售目标

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 保存销售目标

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id

true

-

0

monthTarget

number

月度目标

false

-

0

quarterTarget

number

季度目标

false

-

0

yearTarget

number

年度目标

false

-

0

effectMonth

string

生效月份,yyyy-MM Validation[Pattern(regexp=^\d{4}-(0[1-9]|1[0-2])$, message=生效月份格式错误)]

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/target/save' --data '{
  "salesmanId": 0,
  "monthTarget": 0,
  "quarterTarget": 0,
  "yearTarget": 0,
  "effectMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.11.销售员列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售员列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

No comments found.

false

-

salesmanIds

array

销售员id

false

-

"0,0"

roleType

string

角色类型,inner-内部员工,outer-外部推广人

false

-

excludeSalesmanIds

array

No comments found.

false

-

"0,0"

customerId

int64

No comments found.

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "salesmanIds": [
    0
  ],
  "roleType": "",
  "excludeSalesmanIds": [
    0
  ],
  "customerId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─salesmanId

int64

销售员id

-

0

     └─salesmanStaffId

int64

销售员员工id

-

0

     └─salesmanName

string

销售员名称

-

     └─mobile

string

手机号

-

     └─email

string

邮箱

-

     └─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

     └─beePriceConfigList

array

api价格配置,详情才会返回

-

          └─checkItem

string

产品编码

-

          └─itemName

string

产品名称

-

          └─checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

-

0

          └─feeType

int32

计费方式,10-查询计费,20-查得计费

-

0

          └─price

number

单价

-

0

          └─floorPrice

number

销售底价

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "salesmanId": 0,
        "salesmanStaffId": 0,
        "salesmanName": "",
        "mobile": "",
        "email": "",
        "roleType": "",
        "beePriceConfigList": [
          {
            "checkItem": "",
            "itemName": "",
            "checkType": 0,
            "feeType": 0,
            "price": 0,
            "floorPrice": 0
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.12.销售员详情

Type: GET

Author: wangqidong created on 2025/8/19

Content-Type: application/x-www-form-urlencoded

Description: 销售员详情

Path-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/sales/salesman/detail/{salesmanId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─salesmanId

int64

销售员id

-

0

└─salesmanStaffId

int64

销售员员工id

-

0

└─salesmanName

string

销售员名称

-

└─mobile

string

手机号

-

└─email

string

邮箱

-

└─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

└─beePriceConfigList

array

api价格配置,详情才会返回

-

     └─checkItem

string

产品编码

-

     └─itemName

string

产品名称

-

     └─checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

-

0

     └─feeType

int32

计费方式,10-查询计费,20-查得计费

-

0

     └─price

number

单价

-

0

     └─floorPrice

number

销售底价

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "salesmanId": 0,
    "salesmanStaffId": 0,
    "salesmanName": "",
    "mobile": "",
    "email": "",
    "roleType": "",
    "beePriceConfigList": [
      {
        "checkItem": "",
        "itemName": "",
        "checkType": 0,
        "feeType": 0,
        "price": 0,
        "floorPrice": 0
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.13.新增销售员

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 新增销售员

Body-parameters:

Parameter Type Description Required Since Example

salesmanStaffId

int64

销售员工id

true

-

0

roleType

string

销售员类型,inner-内部销售,outer-推广方

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/add' --data '{
  "salesmanStaffId": 0,
  "roleType": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.14.编辑销售员

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 编辑销售员

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id

true

-

0

beePriceConfigList

array

底价(全量更新)

false

-

└─checkItem

string

产品编码

true

-

└─floorPrice

number

销售底价

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/edit' --data '{
  "salesmanId": 0,
  "beePriceConfigList": [
    {
      "checkItem": "",
      "floorPrice": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.15.编辑销售员最低销售价

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 编辑销售员最低销售价

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id

true

-

0

checkItem

string

产品编码

true

-

floorPrice

number

销售底价

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/editFloorPrice' --data '{
  "salesmanId": 0,
  "checkItem": "",
  "floorPrice": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.16.绩效指标记录

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 绩效指标记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

salesmanId

int64

销售员id

true

-

0

isValid

boolean

是否有效

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/kpi/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "salesmanId": 0,
  "isValid": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─salesmanId

int64

销售员id,0:全局配置

-

0

     └─salesmanName

string

销售员名称

-

     └─isEffect

boolean

是否当前有效

-

true

     └─effectMonth

string

开始生效月份

-

     └─targets

object

销售目标

-

          └─month

number

月度目标

-

0

          └─quarter

number

季度目标

-

0

          └─year

number

年度目标

-

0

     └─details

array

明细

-

          └─code

string

kpi编码

-

          └─name

string

kpi名称

-

          └─target

string

目标

-

          └─weight

number

权重占比

-

0

          └─reachRate

number

完成率

-

0

     └─ver

string

版本

-

     └─tags

string

变更标记

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "salesmanId": 0,
        "salesmanName": "",
        "isEffect": true,
        "effectMonth": "",
        "targets": {
          "month": 0,
          "quarter": 0,
          "year": 0
        },
        "details": [
          {
            "code": "",
            "name": "",
            "target": "",
            "weight": 0,
            "reachRate": 0
          }
        ],
        "ver": "",
        "tags": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.17.保存绩效指标

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 保存绩效指标

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id,0:全局配置

true

-

0

details

array

明细,重置接口无需传递

false

-

└─code

string

kpi编码

false

-

└─name

string

kpi名称

false

-

└─target

string

目标

false

-

└─weight

number

权重占比

false

-

0

└─reachRate

number

完成率

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/kpi/save' --data '{
  "salesmanId": 0,
  "details": [
    {
      "code": "",
      "name": "",
      "target": "",
      "weight": 0,
      "reachRate": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.18.重置绩效指标

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 重置绩效指标

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id,0:全局配置

true

-

0

details

array

明细,重置接口无需传递

false

-

└─code

string

kpi编码

false

-

└─name

string

kpi名称

false

-

└─target

string

目标

false

-

└─weight

number

权重占比

false

-

0

└─reachRate

number

完成率

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/kpi/reset' --data '{
  "salesmanId": 0,
  "details": [
    {
      "code": "",
      "name": "",
      "target": "",
      "weight": 0,
      "reachRate": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.19.销售统计列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

matchMonth

string

匹配月份

true

-

keyword

string

No comments found.

false

-

roleType

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/statisticsList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "matchMonth": "",
  "keyword": "",
  "roleType": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─salesmanId

int64

销售员user_id

-

0

     └─salesmanStaffId

int64

销售员员工id

-

0

     └─salesmanName

string

销售员名称

-

     └─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

     └─mobile

string

手机号

-

     └─email

string

邮箱

-

     └─statisticsDate

string

统计日期

-

     └─customerCount

int32

客户数

-

0

     └─deptItemCount

int32

产品数

-

0

     └─salesAmount

number

总金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "salesmanId": 0,
        "salesmanStaffId": 0,
        "salesmanName": "",
        "roleType": "",
        "mobile": "",
        "email": "",
        "statisticsDate": "",
        "customerCount": 0,
        "deptItemCount": 0,
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.20.销售客户统计列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售客户统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

salesmanId

int64

销售员id

true

-

0

customerId

int64

客户id

false

-

0

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/customerStatisticsList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "salesmanId": 0,
  "customerId": 0,
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─organizationId

int64

组织id

-

0

     └─merchantId

int64

商户id

-

0

     └─mobile

string

手机号

-

     └─organizationName

string

组织名称

-

     └─aliasName

string

组织别名

-

     └─state

int32

企业状态,0:待审核,10:正常

-

0

     └─overdraftType

enum

超支类型

-

UNACTIVATED

     └─logo

string

企业logo

-

     └─assistantId

int64

维护人id

-

0

     └─assistantName

string

维护人姓名

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─email

string

邮箱

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─industry

string

所属行业

-

     └─enableDevelop

boolean

开发者权限是否开通

-

true

     └─deptId

int64

开发账户id

-

0

     └─appId

string

接口appId

-

     └─appSecret

string

接口密钥,

-

     └─authRecord

object

认证记录

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─userId

int64

用户id

-

0

          └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

          └─state

int32

状态

-

0

          └─enterpriseName

string

企业姓名

-

          └─enterpriseNo

string

统一社会信用编码

-

          └─realName

string

真实姓名/法人姓名

-

          └─idCard

string

身份证号/法人身份证

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─idCardFront

string

身份证/法人身份证正面

-

          └─idCardBack

string

法人身份证法人身份证反面

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─linkman

string

联系人

-

          └─linkMobile

string

联系电话

-

          └─linkEmail

string

联系人邮箱

-

          └─linkPosition

string

联系人职位

-

          └─businessDesc

string

业务介绍

-

          └─addressInfo

object

地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─industry

enum

行业编码

-

LEASE3C

          └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

          └─auditRemark

string

审核意见

-

          └─sourceAppcode

string

注册系统编码

-

          └─tenantId

int64

租户id

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─certificationList

array

资质文件

-

""","""

     └─whiteIpList

string

ip白名单

-

     └─addressInfo

object

地址信息

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─sourceAppcode

string

注册系统编码

-

     └─enabledApps

array

已开通应用编码

-

          └─appcode

string

应用编码

-

          └─appName

string

应用名称

-

          └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

          └─systemCode

string

所属系统编码

-

          └─domain

string

域名

-

          └─logo

string

应用logo

-

          └─tenantId

int64

默认所属租户id

-

0

          └─bizAppList

array

关联的业务系统

-

     └─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─enterpriseDesc

string

企业描述

-

     └─customerNature

string

客户业务类型

-

     └─opportunitySalesmanId

int64

商机业务员id

-

0

     └─opportunityRoleType

string

商机业务员类型

-

     └─salesAmount

number

总金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "organizationId": 0,
        "merchantId": 0,
        "mobile": "",
        "organizationName": "",
        "aliasName": "",
        "state": 0,
        "overdraftType": 0,
        "logo": "",
        "assistantId": 0,
        "assistantName": "",
        "linkman": "",
        "linkMobile": "",
        "email": "",
        "customerType": 0,
        "industry": "",
        "enableDevelop": true,
        "deptId": 0,
        "appId": "",
        "appSecret": "",
        "authRecord": {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "userId": 0,
          "authType": 0,
          "state": 0,
          "enterpriseName": "",
          "enterpriseNo": "",
          "realName": "",
          "idCard": "",
          "mobile": "",
          "businessImg": "",
          "idCardFront": "",
          "idCardBack": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "linkman": "",
          "linkMobile": "",
          "linkEmail": "",
          "linkPosition": "",
          "businessDesc": "",
          "addressInfo": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "industry": "",
          "auditTime": "yyyy-MM-dd HH:mm:ss",
          "auditRemark": "",
          "sourceAppcode": "",
          "tenantId": 0
        },
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "certificationList": [
          ""
        ],
        "whiteIpList": "",
        "addressInfo": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "sourceAppcode": "",
        "enabledApps": [
          {
            "appcode": "",
            "appName": "",
            "appType": "",
            "systemCode": "",
            "domain": "",
            "logo": "",
            "tenantId": 0,
            "bizAppList": [
              {
                "$ref": ".."
              }
            ]
          }
        ],
        "nearFollowDate": "yyyy-MM-dd",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "enterpriseDesc": "",
        "customerNature": "",
        "opportunitySalesmanId": 0,
        "opportunityRoleType": "",
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.21.销售客户产品统计列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售客户产品统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

salesmanId

int64

销售员id

true

-

0

customerId

int64

客户id

false

-

0

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/deptItemStatisticsList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "salesmanId": 0,
  "customerId": 0,
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─salesAmount

number

总金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.5.22.销售客户产品统计列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 销售客户产品统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

salesmanId

int64

销售员id

true

-

0

customerId

int64

客户id

false

-

0

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesman/deptItemStatisticsExport' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "salesmanId": 0,
  "customerId": 0,
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.5.23.调用趋势统计

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 调用趋势统计

Body-parameters:

Parameter Type Description Required Since Example

customerIds

array

客户id

false

-

"0,0"

salesmanId

int64

销售员id

false

-

0

checkItemList

array

产品编码

false

-

""","""

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sales/salesTrendStatisticsList' --data '{
  "customerIds": [
    0
  ],
  "salesmanId": 0,
  "checkItemList": [
    ""
  ],
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalSalesAmount

number

总金额

-

0

└─totalChargeCalls

int32

总计费笔数

-

0

└─totalRoyaltyAmount

number

总提成金额(不考虑绩效目标)

-

0

└─details

array

明细

-

     └─statisticsDate

string

统计日期

-

     └─salesAmount

number

销售金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

     └─items

array

明细

-

          └─checkItem

string

产品编码

-

          └─itemName

string

产品名称

-

          └─salesAmount

number

销售金额

-

0

          └─chargeCalls

int32

计费笔数

-

0

          └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalSalesAmount": 0,
    "totalChargeCalls": 0,
    "totalRoyaltyAmount": 0,
    "details": [
      {
        "statisticsDate": "",
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0,
        "items": [
          {
            "checkItem": "",
            "itemName": "",
            "salesAmount": 0,
            "chargeCalls": 0,
            "royaltyAmount": 0
          }
        ]
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

3.6.首页数据

3.6.1.核心指标统计

Type: POST

Author: wangqidong created on 2024/11/23

Content-Type: application/json

Description: 核心指标统计

Body-parameters:

Parameter Type Description Required Since Example

dateType

int32

日期类型,10-今天,20-昨天,30-本月,40-上月

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/index/bee/coreStatistics' --data '{
  "dateType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─orderCount

int64

计费订单数量

-

0

└─comparedCount

int64

同比数量

-

0

└─orderCountIncreaseRate

number

订单数量增长百分比,负数代表下跌

-

0

└─orderAmount

number

订单金额

-

0

└─comparedAmount

number

同比金额

-

0

└─orderAmountIncreaseRate

number

订单金额增长百分比,负数代表下跌

-

0

└─upstreamCount

int64

上游数量

-

0

└─upstreamAmount

number

上游金额

-

0

└─cacheCount

int64

缓存量

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "orderCount": 0,
    "comparedCount": 0,
    "orderCountIncreaseRate": 0,
    "orderAmount": 0,
    "comparedAmount": 0,
    "orderAmountIncreaseRate": 0,
    "upstreamCount": 0,
    "upstreamAmount": 0,
    "cacheCount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.6.2.产品调用趋势

Type: POST

Author: wangqidong created on 2024/11/23

Content-Type: application/json

Description: 产品调用趋势

Body-parameters:

Parameter Type Description Required Since Example

unit

string

日期类型,DAYS:按日,MONTHS:按月;按日最长选31日,按月最长选36个月 Validation[Pattern(regexp=HOURS|DAYS|MONTHS)]

true

-

startDate

string

开始日期,按月格式:2024-01,按日格式:2024-01-01,按小时格式,2024-01-01 00:00:00

true

-

endDate

string

结束日期,按月格式:2024-01,按日格式:2024-01-01

true

-

deptIdList

array

客户组织id

false

-

"0,0"

checkItemList

array

产品编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/index/bee/apiCallStatistics' --data '{
  "unit": "",
  "startDate": "",
  "endDate": "",
  "deptIdList": [
    0
  ],
  "checkItemList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─date

string

日期

-

└─items

array

前10个检测项名称

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称,包括tag

-

     └─tag

string

标签

-

     └─count

int32

调用笔数

-

0

     └─fee

number

总费用

-

0

└─itemCount

int32

检测项数量

-

0

└─totalCount

int32

总数量

-

0

└─totalFee

number

总金额

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "date": "",
      "items": [
        {
          "checkItem": "",
          "checkItemName": "",
          "tag": "",
          "count": 0,
          "fee": 0
        }
      ],
      "itemCount": 0,
      "totalCount": 0,
      "totalFee": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.6.3.客户调用排行

Type: POST

Author: wangqidong created on 2024/11/23

Content-Type: application/json

Description: 客户调用排行

Body-parameters:

Parameter Type Description Required Since Example

dateType

int32

日期类型,10-今天,20-昨天,30-本月,40-上月

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/index/bee/customerRanking' --data '{
  "dateType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─deptId

int64

No comments found.

-

0

└─organizationId

int64

No comments found.

-

0

└─deptName

string

客户名称

-

└─count

int64

调用数量

-

0

└─amount

number

金额

-

0

└─royaltyAmount

number

提成

-

0

└─compareCount

int64

同比调用数量

-

0

└─compareAmount

number

同比金额

-

0

└─countIncreaseRate

number

调用数量增长百分比,负数代表下跌

-

0

└─amountIncreaseRate

number

金额增长百分比,负数代表下跌

-

0

└─royaltyAmountIncreaseRate

number

提成增长百分比,负数代表下跌

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deptId": 0,
      "organizationId": 0,
      "deptName": "",
      "count": 0,
      "amount": 0,
      "royaltyAmount": 0,
      "compareCount": 0,
      "compareAmount": 0,
      "countIncreaseRate": 0,
      "amountIncreaseRate": 0,
      "royaltyAmountIncreaseRate": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.6.4.客户调用统计

Type: POST

Author: wangqidong created on 2024/11/23

Content-Type: application/json

Description: 客户调用统计

Body-parameters:

Parameter Type Description Required Since Example

dateType

int32

日期类型,10-今天,20-昨天,30-本月,40-上月

true

-

0

deptId

int64

客户组织id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/index/bee/customerCallStatistics' --data '{
  "dateType": 0,
  "deptId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─checkItem

string

检测项

-

└─checkItemName

string

检测项名称,包括tag

-

└─tag

string

标签

-

└─count

int32

调用笔数

-

0

└─fee

number

总费用

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "checkItem": "",
      "checkItemName": "",
      "tag": "",
      "count": 0,
      "fee": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.6.5.待办

Type: GET

Author: wangqidong created on 2024/11/23

Content-Type: application/x-www-form-urlencoded

Description: 待办

Request-example:

curl -X GET -i '/mt/crm/index/bee/backlog'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─waitAuditAuthCount

int64

待审核认证数

-

0

└─waitAuditItemCount

int64

待审核产品数量

-

0

└─waitRecheckBillCount

int64

待核对账单数量

-

0

└─waitInvoiceCount

int64

待开票

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "waitAuditAuthCount": 0,
    "waitAuditItemCount": 0,
    "waitRecheckBillCount": 0,
    "waitInvoiceCount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.客户管理

3.7.1.注册客户

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 注册客户

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

username

string

用户名

false

-

organizationName

string

企业名称

true

-

aliasName

string

企业别名

false

-

enterpriseNo

string

统一社会信用代码

true

-

nickname

string

昵称

false

-

mobile

string

手机号

true

-

businessImg

string

营业执照

false

-

state

int32

用户状态,0:未激活,-1:已注销,10-正常

false

-

0

realName

string

真实姓名(法人姓名)

false

-

idCard

string

身份证号码(法人身份证号)

false

-

portrait

string

头像

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

invitationCode

string

邀请码

false

-

assistantId

int64

维护人userId

false

-

0

gradeCode

string

客户分级

false

-

royaltyRate

number

提成比例,0-1

false

-

0

gainChannel

string

获客渠道

false

-

royaltyEffectMonth

string

销售生效月份

false

-

customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

customerNature

string

客户业务类型

false

-

workspaceImgList

array

办公场所

false

-

""","""

certificationList

array

资质文件

false

-

""","""

appcodes

array

可用系统

true

-

└─relationId

int64

关联id

false

-

0

└─appcode

string

应用编码

true

-

└─bizAppcode

string

业务系统编码

false

-

└─appName

string

No comments found.

false

-

└─bizAppName

string

No comments found.

false

-

industry

string

所属行业

false

-

noticeAtOnce

boolean

是否立即通知用户

false

-

true

enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

false

-

isMonthlySettle

boolean

是否月结

false

-

true

overdraftQuota

number

可透支额度

false

-

0

opportunityId

int64

商机id

false

-

0

confirmRepeat

boolean

确认允许手机号重复,默认false

false

-

true

syncAppId

string

同步appId

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/register' --data '{
  "syncOtherEnv": true,
  "username": "",
  "organizationName": "",
  "aliasName": "",
  "enterpriseNo": "",
  "nickname": "",
  "mobile": "",
  "businessImg": "",
  "state": 0,
  "realName": "",
  "idCard": "",
  "portrait": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "invitationCode": "",
  "assistantId": 0,
  "gradeCode": "",
  "royaltyRate": 0,
  "gainChannel": "",
  "royaltyEffectMonth": "",
  "customerType": 0,
  "customerNature": "",
  "workspaceImgList": [
    ""
  ],
  "certificationList": [
    ""
  ],
  "appcodes": [
    {
      "relationId": 0,
      "appcode": "",
      "bizAppcode": "",
      "appName": "",
      "bizAppName": ""
    }
  ],
  "industry": "",
  "noticeAtOnce": true,
  "enterpriseDesc": "",
  "isMonthlySettle": true,
  "overdraftQuota": 0,
  "opportunityId": 0,
  "confirmRepeat": true,
  "syncAppId": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─organizationId

int64

组织id

-

0

└─merchantId

int64

商户id

-

0

└─mobile

string

手机号

-

└─organizationName

string

组织名称

-

└─aliasName

string

组织别名

-

└─state

int32

企业状态,0:待审核,10:正常

-

0

└─overdraftType

enum

超支类型

-

UNACTIVATED

└─logo

string

企业logo

-

└─assistantId

int64

维护人id

-

0

└─assistantName

string

维护人姓名

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─email

string

邮箱

-

└─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

└─industry

string

所属行业

-

└─enableDevelop

boolean

开发者权限是否开通

-

true

└─deptId

int64

开发账户id

-

0

└─appId

string

接口appId

-

└─appSecret

string

接口密钥,

-

└─authRecord

object

认证记录

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─userId

int64

用户id

-

0

     └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

     └─state

int32

状态

-

0

     └─enterpriseName

string

企业姓名

-

     └─enterpriseNo

string

统一社会信用编码

-

     └─realName

string

真实姓名/法人姓名

-

     └─idCard

string

身份证号/法人身份证

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─idCardFront

string

身份证/法人身份证正面

-

     └─idCardBack

string

法人身份证法人身份证反面

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─linkman

string

联系人

-

     └─linkMobile

string

联系电话

-

     └─linkEmail

string

联系人邮箱

-

     └─linkPosition

string

联系人职位

-

     └─businessDesc

string

业务介绍

-

     └─addressInfo

object

地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─industry

enum

行业编码

-

LEASE3C

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核意见

-

     └─sourceAppcode

string

注册系统编码

-

     └─tenantId

int64

租户id

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─certificationList

array

资质文件

-

""","""

└─whiteIpList

string

ip白名单

-

└─addressInfo

object

地址信息

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─sourceAppcode

string

注册系统编码

-

└─enabledApps

array

已开通应用编码

-

     └─appcode

string

应用编码

-

     └─appName

string

应用名称

-

     └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

     └─systemCode

string

所属系统编码

-

     └─domain

string

域名

-

     └─logo

string

应用logo

-

     └─tenantId

int64

默认所属租户id

-

0

     └─bizAppList

array

关联的业务系统

-

└─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

└─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

客户分级

-

└─royaltyRate

number

提成比例,0-1

-

0

└─gainChannel

string

获客渠道

-

└─enterpriseDesc

string

企业描述

-

└─customerNature

string

客户业务类型

-

└─opportunitySalesmanId

int64

商机业务员id

-

0

└─opportunityRoleType

string

商机业务员类型

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "organizationId": 0,
    "merchantId": 0,
    "mobile": "",
    "organizationName": "",
    "aliasName": "",
    "state": 0,
    "overdraftType": 0,
    "logo": "",
    "assistantId": 0,
    "assistantName": "",
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "customerType": 0,
    "industry": "",
    "enableDevelop": true,
    "deptId": 0,
    "appId": "",
    "appSecret": "",
    "authRecord": {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "userId": 0,
      "authType": 0,
      "state": 0,
      "enterpriseName": "",
      "enterpriseNo": "",
      "realName": "",
      "idCard": "",
      "mobile": "",
      "businessImg": "",
      "idCardFront": "",
      "idCardBack": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "linkman": "",
      "linkMobile": "",
      "linkEmail": "",
      "linkPosition": "",
      "businessDesc": "",
      "addressInfo": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "industry": "",
      "auditTime": "yyyy-MM-dd HH:mm:ss",
      "auditRemark": "",
      "sourceAppcode": "",
      "tenantId": 0
    },
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "certificationList": [
      ""
    ],
    "whiteIpList": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "sourceAppcode": "",
    "enabledApps": [
      {
        "appcode": "",
        "appName": "",
        "appType": "",
        "systemCode": "",
        "domain": "",
        "logo": "",
        "tenantId": 0,
        "bizAppList": [
          {
            "$ref": ".."
          }
        ]
      }
    ],
    "nearFollowDate": "yyyy-MM-dd",
    "assignTime": "yyyy-MM-dd HH:mm:ss",
    "gradeCode": "",
    "royaltyRate": 0,
    "gainChannel": "",
    "enterpriseDesc": "",
    "customerNature": "",
    "opportunitySalesmanId": 0,
    "opportunityRoleType": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.2.编辑注册申请

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑注册申请

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

username

string

用户名

false

-

organizationName

string

企业名称

true

-

aliasName

string

企业别名

false

-

enterpriseNo

string

统一社会信用代码

true

-

nickname

string

昵称

false

-

mobile

string

手机号

true

-

businessImg

string

营业执照

false

-

state

int32

用户状态,0:未激活,-1:已注销,10-正常

false

-

0

realName

string

真实姓名(法人姓名)

false

-

idCard

string

身份证号码(法人身份证号)

false

-

portrait

string

头像

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

invitationCode

string

邀请码

false

-

assistantId

int64

维护人userId

false

-

0

gradeCode

string

客户分级

false

-

royaltyRate

number

提成比例,0-1

false

-

0

gainChannel

string

获客渠道

false

-

royaltyEffectMonth

string

销售生效月份

false

-

customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

customerNature

string

客户业务类型

false

-

workspaceImgList

array

办公场所

false

-

""","""

certificationList

array

资质文件

false

-

""","""

appcodes

array

可用系统

true

-

└─relationId

int64

关联id

false

-

0

└─appcode

string

应用编码

true

-

└─bizAppcode

string

业务系统编码

false

-

└─appName

string

No comments found.

false

-

└─bizAppName

string

No comments found.

false

-

industry

string

所属行业

false

-

noticeAtOnce

boolean

是否立即通知用户

false

-

true

syncAppId

string

同步appId

false

-

enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

false

-

isMonthlySettle

boolean

是否月结

false

-

true

overdraftQuota

number

可透支额度

false

-

0

opportunityId

int64

商机id

false

-

0

applyId

int64

申请单号

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/editApply' --data '{
  "syncOtherEnv": true,
  "username": "",
  "organizationName": "",
  "aliasName": "",
  "enterpriseNo": "",
  "nickname": "",
  "mobile": "",
  "businessImg": "",
  "state": 0,
  "realName": "",
  "idCard": "",
  "portrait": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "invitationCode": "",
  "assistantId": 0,
  "gradeCode": "",
  "royaltyRate": 0,
  "gainChannel": "",
  "royaltyEffectMonth": "",
  "customerType": 0,
  "customerNature": "",
  "workspaceImgList": [
    ""
  ],
  "certificationList": [
    ""
  ],
  "appcodes": [
    {
      "relationId": 0,
      "appcode": "",
      "bizAppcode": "",
      "appName": "",
      "bizAppName": ""
    }
  ],
  "industry": "",
  "noticeAtOnce": true,
  "syncAppId": "",
  "enterpriseDesc": "",
  "isMonthlySettle": true,
  "overdraftQuota": 0,
  "opportunityId": 0,
  "applyId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─applyNo

string

申请单号,重新提交不变

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名

-

└─auditState

int32

状态,-10:已驳回,0:待审核,10:已通过

-

0

└─isOut

boolean

是否已过时(非最新申请记录)

-

true

└─submitInfo

object

提交明细

-

     └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

     └─username

string

用户名

-

     └─organizationName

string

企业名称

-

     └─aliasName

string

企业别名

-

     └─enterpriseNo

string

统一社会信用代码

-

     └─nickname

string

昵称

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─state

int32

用户状态,0:未激活,-1:已注销,10-正常

-

0

     └─realName

string

真实姓名(法人姓名)

-

     └─idCard

string

身份证号码(法人身份证号)

-

     └─portrait

string

头像

-

     └─email

string

邮箱

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─linkAddress

object

联系地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─invitationCode

string

邀请码

-

     └─assistantId

int64

维护人userId

-

0

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─royaltyEffectMonth

string

销售生效月份

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─customerNature

string

客户业务类型

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─appcodes

array

可用系统

-

          └─relationId

int64

关联id

-

0

          └─appcode

string

应用编码

-

          └─bizAppcode

string

业务系统编码

-

          └─appName

string

No comments found.

-

          └─bizAppName

string

No comments found.

-

     └─industry

string

所属行业

-

     └─noticeAtOnce

boolean

是否立即通知用户

-

true

     └─syncAppId

string

同步appId

-

     └─enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

-

     └─isMonthlySettle

boolean

是否月结

-

true

     └─overdraftQuota

number

可透支额度

-

0

     └─opportunityId

int64

商机id

-

0

└─submitRemark

string

提交备注

-

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─auditRemark

string

审核备注

-

└─auditImgList

array

审核图片

-

""","""

└─opportunityId

int64

商机id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "applyNo": "",
    "customerId": 0,
    "customerName": "",
    "salesmanId": 0,
    "salesmanName": "",
    "auditState": 0,
    "isOut": true,
    "submitInfo": {
      "syncOtherEnv": true,
      "username": "",
      "organizationName": "",
      "aliasName": "",
      "enterpriseNo": "",
      "nickname": "",
      "mobile": "",
      "businessImg": "",
      "state": 0,
      "realName": "",
      "idCard": "",
      "portrait": "",
      "email": "",
      "linkman": "",
      "linkMobile": "",
      "linkAddress": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "invitationCode": "",
      "assistantId": 0,
      "gradeCode": "",
      "royaltyRate": 0,
      "gainChannel": "",
      "royaltyEffectMonth": "",
      "customerType": 0,
      "customerNature": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "appcodes": [
        {
          "relationId": 0,
          "appcode": "",
          "bizAppcode": "",
          "appName": "",
          "bizAppName": ""
        }
      ],
      "industry": "",
      "noticeAtOnce": true,
      "syncAppId": "",
      "enterpriseDesc": "",
      "isMonthlySettle": true,
      "overdraftQuota": 0,
      "opportunityId": 0
    },
    "submitRemark": "",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "auditRemark": "",
    "auditImgList": [
      ""
    ],
    "opportunityId": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.3.客户注册申请列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 客户注册申请列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

applyNo

string

申请单号

false

-

salesmanId

int64

销售员id

false

-

0

keyword

string

关键字

false

-

auditStateList

array

审核状态

false

-

"0,0"

querySalesmanId

int64

查询人用户id

false

-

0

createTimeGte

string

申请时间大于等于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

申请时间小于等于

false

-

yyyy-MM-dd HH:mm:ss

auditTimeGte

string

审核时间大于等于

false

-

yyyy-MM-dd HH:mm:ss

auditTimeLte

string

审核时间小于等于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/applyList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "applyNo": "",
  "salesmanId": 0,
  "keyword": "",
  "auditStateList": [
    0
  ],
  "querySalesmanId": 0,
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss",
  "auditTimeGte": "yyyy-MM-dd HH:mm:ss",
  "auditTimeLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─applyNo

string

申请单号,重新提交不变

-

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

销售员id

-

0

     └─salesmanName

string

销售员名

-

     └─auditState

int32

状态,-10:已驳回,0:待审核,10:已通过

-

0

     └─isOut

boolean

是否已过时(非最新申请记录)

-

true

     └─submitInfo

object

提交明细

-

          └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

          └─username

string

用户名

-

          └─organizationName

string

企业名称

-

          └─aliasName

string

企业别名

-

          └─enterpriseNo

string

统一社会信用代码

-

          └─nickname

string

昵称

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─state

int32

用户状态,0:未激活,-1:已注销,10-正常

-

0

          └─realName

string

真实姓名(法人姓名)

-

          └─idCard

string

身份证号码(法人身份证号)

-

          └─portrait

string

头像

-

          └─email

string

邮箱

-

          └─linkman

string

联系人

-

          └─linkMobile

string

联系方式

-

          └─linkAddress

object

联系地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─invitationCode

string

邀请码

-

          └─assistantId

int64

维护人userId

-

0

          └─gradeCode

string

客户分级

-

          └─royaltyRate

number

提成比例,0-1

-

0

          └─gainChannel

string

获客渠道

-

          └─royaltyEffectMonth

string

销售生效月份

-

          └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

          └─customerNature

string

客户业务类型

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─appcodes

array

可用系统

-

               └─relationId

int64

关联id

-

0

               └─appcode

string

应用编码

-

               └─bizAppcode

string

业务系统编码

-

               └─appName

string

No comments found.

-

               └─bizAppName

string

No comments found.

-

          └─industry

string

所属行业

-

          └─noticeAtOnce

boolean

是否立即通知用户

-

true

          └─syncAppId

string

同步appId

-

          └─enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

-

          └─isMonthlySettle

boolean

是否月结

-

true

          └─overdraftQuota

number

可透支额度

-

0

          └─opportunityId

int64

商机id

-

0

     └─submitRemark

string

提交备注

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核备注

-

     └─auditImgList

array

审核图片

-

""","""

     └─opportunityId

int64

商机id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "applyNo": "",
        "customerId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "auditState": 0,
        "isOut": true,
        "submitInfo": {
          "syncOtherEnv": true,
          "username": "",
          "organizationName": "",
          "aliasName": "",
          "enterpriseNo": "",
          "nickname": "",
          "mobile": "",
          "businessImg": "",
          "state": 0,
          "realName": "",
          "idCard": "",
          "portrait": "",
          "email": "",
          "linkman": "",
          "linkMobile": "",
          "linkAddress": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "invitationCode": "",
          "assistantId": 0,
          "gradeCode": "",
          "royaltyRate": 0,
          "gainChannel": "",
          "royaltyEffectMonth": "",
          "customerType": 0,
          "customerNature": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "appcodes": [
            {
              "relationId": 0,
              "appcode": "",
              "bizAppcode": "",
              "appName": "",
              "bizAppName": ""
            }
          ],
          "industry": "",
          "noticeAtOnce": true,
          "syncAppId": "",
          "enterpriseDesc": "",
          "isMonthlySettle": true,
          "overdraftQuota": 0,
          "opportunityId": 0
        },
        "submitRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "auditRemark": "",
        "auditImgList": [
          ""
        ],
        "opportunityId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.4.客户注册申请详情

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 客户注册申请详情

Body-parameters:

Parameter Type Description Required Since Example

applyNo

string

申请单号,applyNo和applyId二选一

false

-

applyId

int64

申请id,applyNo和applyId二选一

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/applyDetail' --data '{
  "applyNo": "",
  "applyId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─applyNo

string

申请单号,重新提交不变

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名

-

└─auditState

int32

状态,-10:已驳回,0:待审核,10:已通过

-

0

└─isOut

boolean

是否已过时(非最新申请记录)

-

true

└─submitInfo

object

提交明细

-

     └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

     └─username

string

用户名

-

     └─organizationName

string

企业名称

-

     └─aliasName

string

企业别名

-

     └─enterpriseNo

string

统一社会信用代码

-

     └─nickname

string

昵称

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─state

int32

用户状态,0:未激活,-1:已注销,10-正常

-

0

     └─realName

string

真实姓名(法人姓名)

-

     └─idCard

string

身份证号码(法人身份证号)

-

     └─portrait

string

头像

-

     └─email

string

邮箱

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─linkAddress

object

联系地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─invitationCode

string

邀请码

-

     └─assistantId

int64

维护人userId

-

0

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─royaltyEffectMonth

string

销售生效月份

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─customerNature

string

客户业务类型

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─appcodes

array

可用系统

-

          └─relationId

int64

关联id

-

0

          └─appcode

string

应用编码

-

          └─bizAppcode

string

业务系统编码

-

          └─appName

string

No comments found.

-

          └─bizAppName

string

No comments found.

-

     └─industry

string

所属行业

-

     └─noticeAtOnce

boolean

是否立即通知用户

-

true

     └─syncAppId

string

同步appId

-

     └─enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

-

     └─isMonthlySettle

boolean

是否月结

-

true

     └─overdraftQuota

number

可透支额度

-

0

     └─opportunityId

int64

商机id

-

0

└─submitRemark

string

提交备注

-

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─auditRemark

string

审核备注

-

└─auditImgList

array

审核图片

-

""","""

└─opportunityId

int64

商机id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "applyNo": "",
    "customerId": 0,
    "customerName": "",
    "salesmanId": 0,
    "salesmanName": "",
    "auditState": 0,
    "isOut": true,
    "submitInfo": {
      "syncOtherEnv": true,
      "username": "",
      "organizationName": "",
      "aliasName": "",
      "enterpriseNo": "",
      "nickname": "",
      "mobile": "",
      "businessImg": "",
      "state": 0,
      "realName": "",
      "idCard": "",
      "portrait": "",
      "email": "",
      "linkman": "",
      "linkMobile": "",
      "linkAddress": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "invitationCode": "",
      "assistantId": 0,
      "gradeCode": "",
      "royaltyRate": 0,
      "gainChannel": "",
      "royaltyEffectMonth": "",
      "customerType": 0,
      "customerNature": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "appcodes": [
        {
          "relationId": 0,
          "appcode": "",
          "bizAppcode": "",
          "appName": "",
          "bizAppName": ""
        }
      ],
      "industry": "",
      "noticeAtOnce": true,
      "syncAppId": "",
      "enterpriseDesc": "",
      "isMonthlySettle": true,
      "overdraftQuota": 0,
      "opportunityId": 0
    },
    "submitRemark": "",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "auditRemark": "",
    "auditImgList": [
      ""
    ],
    "opportunityId": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.5.注册审核

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 注册审核

Body-parameters:

Parameter Type Description Required Since Example

applyNo

string

申请id

true

-

auditType

string

审核类型,pass-通过,reject-拒绝

true

-

auditRemark

string

审核备注

false

-

auditImgList

array

审核图片

false

-

""","""

gradeCode

string

等级编码

true

-

royaltyRate

number

提成比例,0-1

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/registerAudit' --data '{
  "applyNo": "",
  "auditType": "",
  "auditRemark": "",
  "auditImgList": [
    ""
  ],
  "gradeCode": "",
  "royaltyRate": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.6.同步注册客户

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 同步注册客户

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

username

string

用户名

false

-

organizationName

string

企业名称

true

-

aliasName

string

企业别名

false

-

enterpriseNo

string

统一社会信用代码

true

-

nickname

string

昵称

false

-

mobile

string

手机号

true

-

businessImg

string

营业执照

false

-

state

int32

用户状态,0:未激活,-1:已注销,10-正常

false

-

0

realName

string

真实姓名(法人姓名)

false

-

idCard

string

身份证号码(法人身份证号)

false

-

portrait

string

头像

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

invitationCode

string

邀请码

false

-

assistantId

int64

维护人userId

false

-

0

gradeCode

string

客户分级

false

-

royaltyRate

number

提成比例,0-1

false

-

0

gainChannel

string

获客渠道

false

-

royaltyEffectMonth

string

销售生效月份

false

-

customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

customerNature

string

客户业务类型

false

-

workspaceImgList

array

办公场所

false

-

""","""

certificationList

array

资质文件

false

-

""","""

appcodes

array

可用系统

true

-

└─relationId

int64

关联id

false

-

0

└─appcode

string

应用编码

true

-

└─bizAppcode

string

业务系统编码

false

-

└─appName

string

No comments found.

false

-

└─bizAppName

string

No comments found.

false

-

industry

string

所属行业

false

-

noticeAtOnce

boolean

是否立即通知用户

false

-

true

enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

false

-

isMonthlySettle

boolean

是否月结

false

-

true

overdraftQuota

number

可透支额度

false

-

0

opportunityId

int64

商机id

false

-

0

confirmRepeat

boolean

确认允许手机号重复,默认false

false

-

true

syncAppId

string

同步appId

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/syncRegister' --data '{
  "syncOtherEnv": true,
  "username": "",
  "organizationName": "",
  "aliasName": "",
  "enterpriseNo": "",
  "nickname": "",
  "mobile": "",
  "businessImg": "",
  "state": 0,
  "realName": "",
  "idCard": "",
  "portrait": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "invitationCode": "",
  "assistantId": 0,
  "gradeCode": "",
  "royaltyRate": 0,
  "gainChannel": "",
  "royaltyEffectMonth": "",
  "customerType": 0,
  "customerNature": "",
  "workspaceImgList": [
    ""
  ],
  "certificationList": [
    ""
  ],
  "appcodes": [
    {
      "relationId": 0,
      "appcode": "",
      "bizAppcode": "",
      "appName": "",
      "bizAppName": ""
    }
  ],
  "industry": "",
  "noticeAtOnce": true,
  "enterpriseDesc": "",
  "isMonthlySettle": true,
  "overdraftQuota": 0,
  "opportunityId": 0,
  "confirmRepeat": true,
  "syncAppId": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─organizationId

int64

组织id

-

0

└─merchantId

int64

商户id

-

0

└─mobile

string

手机号

-

└─organizationName

string

组织名称

-

└─aliasName

string

组织别名

-

└─state

int32

企业状态,0:待审核,10:正常

-

0

└─overdraftType

enum

超支类型

-

UNACTIVATED

└─logo

string

企业logo

-

└─assistantId

int64

维护人id

-

0

└─assistantName

string

维护人姓名

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─email

string

邮箱

-

└─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

└─industry

string

所属行业

-

└─enableDevelop

boolean

开发者权限是否开通

-

true

└─deptId

int64

开发账户id

-

0

└─appId

string

接口appId

-

└─appSecret

string

接口密钥,

-

└─authRecord

object

认证记录

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─userId

int64

用户id

-

0

     └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

     └─state

int32

状态

-

0

     └─enterpriseName

string

企业姓名

-

     └─enterpriseNo

string

统一社会信用编码

-

     └─realName

string

真实姓名/法人姓名

-

     └─idCard

string

身份证号/法人身份证

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─idCardFront

string

身份证/法人身份证正面

-

     └─idCardBack

string

法人身份证法人身份证反面

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─linkman

string

联系人

-

     └─linkMobile

string

联系电话

-

     └─linkEmail

string

联系人邮箱

-

     └─linkPosition

string

联系人职位

-

     └─businessDesc

string

业务介绍

-

     └─addressInfo

object

地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─industry

enum

行业编码

-

LEASE3C

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核意见

-

     └─sourceAppcode

string

注册系统编码

-

     └─tenantId

int64

租户id

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─certificationList

array

资质文件

-

""","""

└─whiteIpList

string

ip白名单

-

└─addressInfo

object

地址信息

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─sourceAppcode

string

注册系统编码

-

└─enabledApps

array

已开通应用编码

-

     └─appcode

string

应用编码

-

     └─appName

string

应用名称

-

     └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

     └─systemCode

string

所属系统编码

-

     └─domain

string

域名

-

     └─logo

string

应用logo

-

     └─tenantId

int64

默认所属租户id

-

0

     └─bizAppList

array

关联的业务系统

-

└─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

└─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

客户分级

-

└─royaltyRate

number

提成比例,0-1

-

0

└─gainChannel

string

获客渠道

-

└─enterpriseDesc

string

企业描述

-

└─customerNature

string

客户业务类型

-

└─opportunitySalesmanId

int64

商机业务员id

-

0

└─opportunityRoleType

string

商机业务员类型

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "organizationId": 0,
    "merchantId": 0,
    "mobile": "",
    "organizationName": "",
    "aliasName": "",
    "state": 0,
    "overdraftType": 0,
    "logo": "",
    "assistantId": 0,
    "assistantName": "",
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "customerType": 0,
    "industry": "",
    "enableDevelop": true,
    "deptId": 0,
    "appId": "",
    "appSecret": "",
    "authRecord": {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "userId": 0,
      "authType": 0,
      "state": 0,
      "enterpriseName": "",
      "enterpriseNo": "",
      "realName": "",
      "idCard": "",
      "mobile": "",
      "businessImg": "",
      "idCardFront": "",
      "idCardBack": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "linkman": "",
      "linkMobile": "",
      "linkEmail": "",
      "linkPosition": "",
      "businessDesc": "",
      "addressInfo": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "industry": "",
      "auditTime": "yyyy-MM-dd HH:mm:ss",
      "auditRemark": "",
      "sourceAppcode": "",
      "tenantId": 0
    },
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "certificationList": [
      ""
    ],
    "whiteIpList": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "sourceAppcode": "",
    "enabledApps": [
      {
        "appcode": "",
        "appName": "",
        "appType": "",
        "systemCode": "",
        "domain": "",
        "logo": "",
        "tenantId": 0,
        "bizAppList": [
          {
            "$ref": ".."
          }
        ]
      }
    ],
    "nearFollowDate": "yyyy-MM-dd",
    "assignTime": "yyyy-MM-dd HH:mm:ss",
    "gradeCode": "",
    "royaltyRate": 0,
    "gainChannel": "",
    "enterpriseDesc": "",
    "customerNature": "",
    "opportunitySalesmanId": 0,
    "opportunityRoleType": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.7.手动认证

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 手动认证

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

用户id

true

-

0

organizationName

string

企业名称

true

-

enterpriseNo

string

统一社会信用代码

true

-

businessImg

string

营业执照

false

-

realName

string

真实姓名(法人姓名)

false

-

idCard

string

身份证号码(法人身份证号)

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/manualAuth' --data '{
  "userId": 0,
  "organizationName": "",
  "enterpriseNo": "",
  "businessImg": "",
  "realName": "",
  "idCard": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  }
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.8.客户列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 客户列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

assistantId

int64

维护人id

false

-

0

nonAssistantId

boolean

是否无销售员

false

-

true

state

int32

企业状态,0:未认证,10:已认证

false

-

0

createTimeGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

customerNatureList

array

客户业务类型

false

-

""","""

deptIds

array

包括的组织id

false

-

"0,0"

excludeDeptIds

array

排除的组织id

false

-

"0,0"

merchantIdList

array

商户id

false

-

"0,0"

gainChannel

string

No comments found.

false

-

excludeCheckItem

string

移除已开通产品的客户

false

-

salesmanId

int64

销售员id

false

-

0

matchMonth

string

匹配月份

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "assistantId": 0,
  "nonAssistantId": true,
  "state": 0,
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss",
  "customerType": 0,
  "customerNatureList": [
    ""
  ],
  "deptIds": [
    0
  ],
  "excludeDeptIds": [
    0
  ],
  "merchantIdList": [
    0
  ],
  "gainChannel": "",
  "excludeCheckItem": "",
  "salesmanId": 0,
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─organizationId

int64

组织id

-

0

     └─merchantId

int64

商户id

-

0

     └─mobile

string

手机号

-

     └─organizationName

string

组织名称

-

     └─aliasName

string

组织别名

-

     └─state

int32

企业状态,0:待审核,10:正常

-

0

     └─overdraftType

enum

超支类型

-

UNACTIVATED

     └─logo

string

企业logo

-

     └─assistantId

int64

维护人id

-

0

     └─assistantName

string

维护人姓名

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─email

string

邮箱

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─industry

string

所属行业

-

     └─enableDevelop

boolean

开发者权限是否开通

-

true

     └─deptId

int64

开发账户id

-

0

     └─appId

string

接口appId

-

     └─appSecret

string

接口密钥,

-

     └─authRecord

object

认证记录

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─userId

int64

用户id

-

0

          └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

          └─state

int32

状态

-

0

          └─enterpriseName

string

企业姓名

-

          └─enterpriseNo

string

统一社会信用编码

-

          └─realName

string

真实姓名/法人姓名

-

          └─idCard

string

身份证号/法人身份证

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─idCardFront

string

身份证/法人身份证正面

-

          └─idCardBack

string

法人身份证法人身份证反面

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─linkman

string

联系人

-

          └─linkMobile

string

联系电话

-

          └─linkEmail

string

联系人邮箱

-

          └─linkPosition

string

联系人职位

-

          └─businessDesc

string

业务介绍

-

          └─addressInfo

object

地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─industry

enum

行业编码

-

LEASE3C

          └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

          └─auditRemark

string

审核意见

-

          └─sourceAppcode

string

注册系统编码

-

          └─tenantId

int64

租户id

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─certificationList

array

资质文件

-

""","""

     └─whiteIpList

string

ip白名单

-

     └─addressInfo

object

地址信息

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─sourceAppcode

string

注册系统编码

-

     └─enabledApps

array

已开通应用编码

-

          └─appcode

string

应用编码

-

          └─appName

string

应用名称

-

          └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

          └─systemCode

string

所属系统编码

-

          └─domain

string

域名

-

          └─logo

string

应用logo

-

          └─tenantId

int64

默认所属租户id

-

0

          └─bizAppList

array

关联的业务系统

-

     └─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─enterpriseDesc

string

企业描述

-

     └─customerNature

string

客户业务类型

-

     └─opportunitySalesmanId

int64

商机业务员id

-

0

     └─opportunityRoleType

string

商机业务员类型

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "organizationId": 0,
        "merchantId": 0,
        "mobile": "",
        "organizationName": "",
        "aliasName": "",
        "state": 0,
        "overdraftType": 0,
        "logo": "",
        "assistantId": 0,
        "assistantName": "",
        "linkman": "",
        "linkMobile": "",
        "email": "",
        "customerType": 0,
        "industry": "",
        "enableDevelop": true,
        "deptId": 0,
        "appId": "",
        "appSecret": "",
        "authRecord": {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "userId": 0,
          "authType": 0,
          "state": 0,
          "enterpriseName": "",
          "enterpriseNo": "",
          "realName": "",
          "idCard": "",
          "mobile": "",
          "businessImg": "",
          "idCardFront": "",
          "idCardBack": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "linkman": "",
          "linkMobile": "",
          "linkEmail": "",
          "linkPosition": "",
          "businessDesc": "",
          "addressInfo": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "industry": "",
          "auditTime": "yyyy-MM-dd HH:mm:ss",
          "auditRemark": "",
          "sourceAppcode": "",
          "tenantId": 0
        },
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "certificationList": [
          ""
        ],
        "whiteIpList": "",
        "addressInfo": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "sourceAppcode": "",
        "enabledApps": [
          {
            "appcode": "",
            "appName": "",
            "appType": "",
            "systemCode": "",
            "domain": "",
            "logo": "",
            "tenantId": 0,
            "bizAppList": [
              {
                "$ref": ".."
              }
            ]
          }
        ],
        "nearFollowDate": "yyyy-MM-dd",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "enterpriseDesc": "",
        "customerNature": "",
        "opportunitySalesmanId": 0,
        "opportunityRoleType": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.9.客户关系列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 客户关系列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

customerNameLike

string

客户名

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/maintainList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "customerNameLike": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

当前销售员id

-

0

     └─salesmanName

string

当前销售员名

-

     └─state

int32

是否有效

-

0

     └─effectMonth

string

生效月份

-

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─customerState

int32

客户状态,-1:已失效, 0:待审核,10:正常

-

0

     └─joinTime

string

入驻时间

-

yyyy-MM-dd HH:mm:ss

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─industry

string

所属行业

-

     └─deptId

int64

No comments found.

-

0

     └─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "customerId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "state": 0,
        "effectMonth": "",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "customerState": 0,
        "joinTime": "yyyy-MM-dd HH:mm:ss",
        "linkman": "",
        "linkMobile": "",
        "industry": "",
        "deptId": 0,
        "contractState": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.10.客户详情

Type: GET

Author: wangqidong created on 2024/11/15

Content-Type: application/x-www-form-urlencoded

Description: 客户详情

Path-parameters:

Parameter Type Description Required Since Example

organizationId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/customer/detail/{organizationId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─organizationId

int64

组织id

-

0

└─merchantId

int64

商户id

-

0

└─mobile

string

手机号

-

└─organizationName

string

组织名称

-

└─aliasName

string

组织别名

-

└─state

int32

企业状态,0:待审核,10:正常

-

0

└─overdraftType

enum

超支类型

-

UNACTIVATED

└─logo

string

企业logo

-

└─assistantId

int64

维护人id

-

0

└─assistantName

string

维护人姓名

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─email

string

邮箱

-

└─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

└─industry

string

所属行业

-

└─enableDevelop

boolean

开发者权限是否开通

-

true

└─deptId

int64

开发账户id

-

0

└─appId

string

接口appId

-

└─appSecret

string

接口密钥,

-

└─authRecord

object

认证记录

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─userId

int64

用户id

-

0

     └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

     └─state

int32

状态

-

0

     └─enterpriseName

string

企业姓名

-

     └─enterpriseNo

string

统一社会信用编码

-

     └─realName

string

真实姓名/法人姓名

-

     └─idCard

string

身份证号/法人身份证

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─idCardFront

string

身份证/法人身份证正面

-

     └─idCardBack

string

法人身份证法人身份证反面

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─linkman

string

联系人

-

     └─linkMobile

string

联系电话

-

     └─linkEmail

string

联系人邮箱

-

     └─linkPosition

string

联系人职位

-

     └─businessDesc

string

业务介绍

-

     └─addressInfo

object

地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─industry

enum

行业编码

-

LEASE3C

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核意见

-

     └─sourceAppcode

string

注册系统编码

-

     └─tenantId

int64

租户id

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─certificationList

array

资质文件

-

""","""

└─whiteIpList

string

ip白名单

-

└─addressInfo

object

地址信息

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─sourceAppcode

string

注册系统编码

-

└─enabledApps

array

已开通应用编码

-

     └─appcode

string

应用编码

-

     └─appName

string

应用名称

-

     └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

     └─systemCode

string

所属系统编码

-

     └─domain

string

域名

-

     └─logo

string

应用logo

-

     └─tenantId

int64

默认所属租户id

-

0

     └─bizAppList

array

关联的业务系统

-

└─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

└─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

客户分级

-

└─royaltyRate

number

提成比例,0-1

-

0

└─gainChannel

string

获客渠道

-

└─enterpriseDesc

string

企业描述

-

└─customerNature

string

客户业务类型

-

└─opportunitySalesmanId

int64

商机业务员id

-

0

└─opportunityRoleType

string

商机业务员类型

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "organizationId": 0,
    "merchantId": 0,
    "mobile": "",
    "organizationName": "",
    "aliasName": "",
    "state": 0,
    "overdraftType": 0,
    "logo": "",
    "assistantId": 0,
    "assistantName": "",
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "customerType": 0,
    "industry": "",
    "enableDevelop": true,
    "deptId": 0,
    "appId": "",
    "appSecret": "",
    "authRecord": {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "userId": 0,
      "authType": 0,
      "state": 0,
      "enterpriseName": "",
      "enterpriseNo": "",
      "realName": "",
      "idCard": "",
      "mobile": "",
      "businessImg": "",
      "idCardFront": "",
      "idCardBack": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "linkman": "",
      "linkMobile": "",
      "linkEmail": "",
      "linkPosition": "",
      "businessDesc": "",
      "addressInfo": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "industry": "",
      "auditTime": "yyyy-MM-dd HH:mm:ss",
      "auditRemark": "",
      "sourceAppcode": "",
      "tenantId": 0
    },
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "certificationList": [
      ""
    ],
    "whiteIpList": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "sourceAppcode": "",
    "enabledApps": [
      {
        "appcode": "",
        "appName": "",
        "appType": "",
        "systemCode": "",
        "domain": "",
        "logo": "",
        "tenantId": 0,
        "bizAppList": [
          {
            "$ref": ".."
          }
        ]
      }
    ],
    "nearFollowDate": "yyyy-MM-dd",
    "assignTime": "yyyy-MM-dd HH:mm:ss",
    "gradeCode": "",
    "royaltyRate": 0,
    "gainChannel": "",
    "enterpriseDesc": "",
    "customerNature": "",
    "opportunitySalesmanId": 0,
    "opportunityRoleType": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.11.指派记录

Type: GET

Author: wangqidong created on 2024/11/15

Content-Type: application/x-www-form-urlencoded

Description: 指派记录

Path-parameters:

Parameter Type Description Required Since Example

customerId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/customer/assignHistories/{customerId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

当前销售员id

-

0

└─salesmanName

string

当前销售员名

-

└─state

int32

是否有效

-

0

└─effectMonth

string

生效月份

-

└─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

客户分级

-

└─royaltyRate

number

提成比例,0-1

-

0

└─gainChannel

string

获客渠道

-

└─customerState

int32

客户状态,-1:已失效, 0:待审核,10:正常

-

0

└─joinTime

string

入驻时间

-

yyyy-MM-dd HH:mm:ss

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─industry

string

所属行业

-

└─deptId

int64

No comments found.

-

0

└─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "customerId": 0,
      "customerName": "",
      "salesmanId": 0,
      "salesmanName": "",
      "state": 0,
      "effectMonth": "",
      "assignTime": "yyyy-MM-dd HH:mm:ss",
      "gradeCode": "",
      "royaltyRate": 0,
      "gainChannel": "",
      "customerState": 0,
      "joinTime": "yyyy-MM-dd HH:mm:ss",
      "linkman": "",
      "linkMobile": "",
      "industry": "",
      "deptId": 0,
      "contractState": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.7.12.开通应用

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 开通应用

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

appcode

string

开通的应用编码

true

-

industry

string

所属行业

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/activeApp' --data '{
  "merchantId": 0,
  "appcode": "",
  "industry": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.13.编辑客户信息

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑客户信息

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

baseInfo

object

编辑基本信息

false

-

└─organizationName

string

组织名称

false

-

└─mobile

string

手机号

false

-

└─aliasName

string

组织别名

false

-

└─state

int32

企业状态,-1:禁用,0:待审核,10:正常

false

-

0

└─linkman

string

联系人

false

-

└─linkMobile

string

联系方式

false

-

└─email

string

邮箱

false

-

└─customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

└─customerNature

string

客户业务类型

false

-

└─enterpriseDesc

string

企业描述

false

-

authInfo

object

编辑认证信息

false

-

└─id

int64

id,不为空代表修改

false

-

0

└─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

false

-

0

└─mobile

string

手机号

false

-

└─enterpriseName

string

企业姓名

false

-

└─enterpriseNo

string

统一社会信用编码

false

-

└─realName

string

真实姓名/法人姓名

false

-

└─idCard

string

身份证号/法人身份证

false

-

└─businessImg

string

营业执照

false

-

└─idCardFront

string

身份证/法人身份证正面

false

-

└─idCardBack

string

法人身份证法人身份证反面

false

-

└─workspaceImgList

array

办公场所

false

-

""","""

└─linkman

string

联系人

false

-

└─linkMobile

string

联系电话

false

-

└─linkEmail

string

联系人邮箱

false

-

└─businessDesc

string

业务介绍

false

-

└─certificationList

array

资质文件

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/edit' --data '{
  "merchantId": 0,
  "baseInfo": {
    "organizationName": "",
    "mobile": "",
    "aliasName": "",
    "state": 0,
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "customerType": 0,
    "customerNature": "",
    "enterpriseDesc": ""
  },
  "authInfo": {
    "id": 0,
    "authType": 0,
    "mobile": "",
    "enterpriseName": "",
    "enterpriseNo": "",
    "realName": "",
    "idCard": "",
    "businessImg": "",
    "idCardFront": "",
    "idCardBack": "",
    "workspaceImgList": [
      ""
    ],
    "linkman": "",
    "linkMobile": "",
    "linkEmail": "",
    "businessDesc": "",
    "certificationList": [
      ""
    ]
  }
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.14.编辑维护人信息

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑维护人信息

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

assistantId

int64

维护人id

true

-

0

gradeCode

string

客户分级

false

-

royaltyRate

number

提成比例,0-1

false

-

0

royaltyEffectMonth

string

销售生效月份

false

-

gainChannel

string

获客渠道

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/editAssistant' --data '{
  "merchantId": 0,
  "assistantId": 0,
  "gradeCode": "",
  "royaltyRate": 0,
  "royaltyEffectMonth": "",
  "gainChannel": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.15.编辑获客渠道

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑获客渠道

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

gainChannel

string

获客渠道

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/editGainChannel' --data '{
  "merchantId": 0,
  "gainChannel": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.16.删除用户

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 删除用户

Body-parameters:

Parameter Type Description Required Since Example

organizationId

int64

企业id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/delete' --data '{
  "organizationId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.17.设置ip白名单

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 设置ip白名单

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

enable

boolean

是否开启白名单

true

-

true

ipList

string

白名单ip,多个逗号分割,enable为true时必填

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/saveWhiteIpList' --data '{
  "deptId": 0,
  "enable": true,
  "ipList": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.18.发送开发者信息

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 发送开发者信息

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发者账号id

true

-

0

method

enum

发送方式,sms-短信,email-邮箱
(See: 验证码渠道)

true

-

SMS

receiver

string

接收人

true

-

ccList

array

抄送人

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/sendDeveloperInfo' --data '{
  "deptId": 0,
  "method": "",
  "receiver": "",
  "ccList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.19.查询钱包账户

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 查询钱包账户

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/wallet/list' --data '{
  "merchantId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

钱包id

-

0

└─userId

int64

用户id

-

0

└─accountName

string

账户名

-

└─accountType

int32

账户类型,10-个人账户,20-企业账户

-

0

└─isDefault

boolean

是否默认钱包

-

true

└─state

int32

钱包状态,-1-已锁定,0-待开通,10-正常

-

0

└─balance

number

账户余额

-

0

└─overdraftState

int32

后付状态,0-预充值(不允许超支),10-预充值(允许超支),20-月结

-

0

└─overdraftQuota

number

可透支额度

-

0

└─forewarnThreshold

number

预警阈值

-

0

└─forewarnContactList

array

预警联系人id,多个逗号分割

-

     └─id

int64

联系人id

-

0

     └─linkman

string

联系人姓名

-

     └─mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

-

     └─email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

-

     └─webhook

string

webhook

-

     └─isDefault

boolean

是否默认联系人

-

true

└─payRouteList

array

支付路由列表

-

     └─appcode

string

专属应用编码

-

     └─appName

string

专属应用名称

-

     └─properSceneList

array

专属场景

-

""","""

└─tenantId

int64

租户id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "userId": 0,
      "accountName": "",
      "accountType": 0,
      "isDefault": true,
      "state": 0,
      "balance": 0,
      "overdraftState": 0,
      "overdraftQuota": 0,
      "forewarnThreshold": 0,
      "forewarnContactList": [
        {
          "id": 0,
          "linkman": "",
          "mobile": "",
          "email": "",
          "webhook": "",
          "isDefault": true
        }
      ],
      "payRouteList": [
        {
          "appcode": "",
          "appName": "",
          "properSceneList": [
            ""
          ]
        }
      ],
      "tenantId": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.7.20.钱包流水

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 钱包流水

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

assignWalletId

int64

钱包账户id

true

-

0

flowType

string

流水类型,in-收入,out-支出

false

-

bizTypeList

array

业务类型,bizPay-支付,recharge-账户充值,refund-退款

false

-

""","""

createTimeGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/wallet/flowList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "assignWalletId": 0,
  "flowType": "",
  "bizTypeList": [
    ""
  ],
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─walletId

int64

钱包id

-

0

     └─flowNo

string

流水号

-

     └─flowType

string

流水类型,in-收入,out-支出

-

     └─bizType

string

业务类型,pay-支付,recharge-账户充值,refund-退款

-

     └─payMethod

string

支付方式

-

     └─businessNo

string

业务单号

-

     └─feeName

string

费用项名称

-

     └─flowAmount

number

金额

-

0

     └─afterBalance

number

操作后余额

-

0

     └─tenantId

int64

租户id

-

0

     └─appcode

string

应用编码

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "walletId": 0,
        "flowNo": "",
        "flowType": "",
        "bizType": "",
        "payMethod": "",
        "businessNo": "",
        "feeName": "",
        "flowAmount": 0,
        "afterBalance": 0,
        "tenantId": 0,
        "appcode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.21.新增钱包

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 新增钱包

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

appcode

string

应用编码,为空代表不限制应用,除钱包账户外不可为空

true

-

properSceneList

array

专属场景

false

-

""","""

overdraftState

int32

后付状态,0-预充值(不允许超支),10-预充值(允许超支),20-月结

false

-

0

overdraftQuota

number

可透支额度

false

-

0

forewarnThreshold

number

预警阈值

false

-

0

forewarnContactList

array

预警联系人id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/wallet/add' --data '{
  "merchantId": 0,
  "appcode": "",
  "properSceneList": [
    ""
  ],
  "overdraftState": 0,
  "overdraftQuota": 0,
  "forewarnThreshold": 0,
  "forewarnContactList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.22.编辑钱包

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑钱包

Body-parameters:

Parameter Type Description Required Since Example

walletId

int64

钱包id

true

-

0

overdraftState

int32

后付状态,0-预充值(不允许超支),10-预充值(允许超支),20-月结

false

-

0

overdraftQuota

number

可透支额度

false

-

0

forewarnThreshold

number

预警阈值

false

-

0

forewarnContactList

array

预警联系人id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/wallet/edit' --data '{
  "walletId": 0,
  "overdraftState": 0,
  "overdraftQuota": 0,
  "forewarnThreshold": 0,
  "forewarnContactList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.23.合并钱包账户

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 合并钱包账户

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

fromWalletId

int64

需要合并的账户id

true

-

0

toWalletId

int64

目标账户id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/wallet/merge' --data '{
  "merchantId": 0,
  "fromWalletId": 0,
  "toWalletId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.24.手动充值

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 手动充值

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

walletId

int64

钱包id

true

-

0

rechargeAmount

number

充值金额

true

-

0

sendSms

boolean

是否发送短信(邮件)通知客户

false

-

true

confirmed

boolean

是否确认充值,默认false

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/wallet/recharge' --data '{
  "merchantId": 0,
  "walletId": 0,
  "rechargeAmount": 0,
  "sendSms": true,
  "confirmed": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.25.授权产品列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 授权产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

checkItemList

array

产品编码列表

false

-

""","""

stateList

array

状态列表

false

-

"0,0"

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

categoryCode

string

分类

false

-

taskType

int32

是否可在线测试,10-单笔测试,20-批量测试

false

-

0

merchantId

int64

商户id

false

-

0

deptIdList

array

组织id

false

-

"0,0"

fusionDeptItemId

int64

聚合产品授权记录id

false

-

0

idList

array

指定deptItemId

false

-

"0,0"

queryAdjusting

boolean

是否查询调整中记录

false

-

true

contractStateList

array

合同签署状态

false

-

"0,0"

isFusion

boolean

是否是聚合产品

false

-

true

crmQuery

boolean

No comments found.

false

-

true

querySpreader

boolean

查询推广员信息

false

-

true

matchSpreaderMonth

string

No comments found.

false

-

spreaderId

int64

推广方id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "checkItemList": [
    ""
  ],
  "stateList": [
    0
  ],
  "applicable": true,
  "categoryCode": "",
  "taskType": 0,
  "merchantId": 0,
  "deptIdList": [
    0
  ],
  "fusionDeptItemId": 0,
  "idList": [
    0
  ],
  "queryAdjusting": true,
  "contractStateList": [
    0
  ],
  "isFusion": true,
  "crmQuery": true,
  "querySpreader": true,
  "matchSpreaderMonth": "",
  "spreaderId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.26.查询调整记录

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 查询调整记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

组织id

true

-

0

deptItemIdList

array

授权记录id

false

-

"0,0"

stateList

array

状态,-10:已驳回,0:待发起,5:待审核,10:待生效,20:已生效

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/adjustList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "deptItemIdList": [
    0
  ],
  "stateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构id

-

     └─deptItemId

int64

机构单项费用id

-

0

     └─checkItem

string

检测项

-

     └─itemName

string

检测项

-

     └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

     └─beforeFee

number

变更前费用

-

0

     └─beforeFeeDetail

string

变更前费用明细

-

     └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

     └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

     └─afterFee

number

变更后费用

-

0

     └─afterFeeDetail

string

变更后费用明细

-

     └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

     └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

     └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

     └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "deptItemId": 0,
        "checkItem": "",
        "itemName": "",
        "state": 0,
        "beforeFee": 0,
        "beforeFeeDetail": "",
        "beforeChargeType": 0,
        "beforeFeeType": 0,
        "afterFee": 0,
        "afterFeeDetail": "",
        "afterChargeType": 0,
        "afterFeeType": 0,
        "planTime": "yyyy-MM-dd HH:mm:ss",
        "effectTime": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.27.导出授权产品列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 导出授权产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

checkItemList

array

产品编码列表

false

-

""","""

stateList

array

状态列表

false

-

"0,0"

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

categoryCode

string

分类

false

-

taskType

int32

是否可在线测试,10-单笔测试,20-批量测试

false

-

0

merchantId

int64

商户id

false

-

0

deptIdList

array

组织id

false

-

"0,0"

fusionDeptItemId

int64

聚合产品授权记录id

false

-

0

idList

array

指定deptItemId

false

-

"0,0"

queryAdjusting

boolean

是否查询调整中记录

false

-

true

contractStateList

array

合同签署状态

false

-

"0,0"

isFusion

boolean

是否是聚合产品

false

-

true

crmQuery

boolean

No comments found.

false

-

true

querySpreader

boolean

查询推广员信息

false

-

true

matchSpreaderMonth

string

No comments found.

false

-

spreaderId

int64

推广方id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/export' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "checkItemList": [
    ""
  ],
  "stateList": [
    0
  ],
  "applicable": true,
  "categoryCode": "",
  "taskType": 0,
  "merchantId": 0,
  "deptIdList": [
    0
  ],
  "fusionDeptItemId": 0,
  "idList": [
    0
  ],
  "queryAdjusting": true,
  "contractStateList": [
    0
  ],
  "isFusion": true,
  "crmQuery": true,
  "querySpreader": true,
  "matchSpreaderMonth": "",
  "spreaderId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.28.新增授权产品

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 新增授权产品

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

false

-

0

checkItemList

array

申请开通的产品

true

-

└─deptId

int64

开发账户id

false

-

0

└─itemCode

string

产品编码,不可修改

true

-

└─itemName

string

产品名称,不可修改

false

-

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─feeDetail

string

费用明细

false

-

└─fee

number

费用

false

-

0

└─freeCount

int32

免费次数

false

-

0

└─applyRemark

string

申请备注

false

-

└─orgCode

string

组织编码

false

-

└─riskThreshold

number

风险阈值

false

-

0

└─usedVersion

string

开通版本

false

-

└─isHidden

boolean

是否隐藏

false

-

true

└─spreaderRoyalties

array

外部销售提成配置

false

-

     └─spreaderId

int64

推广员id

true

-

0

     └─royaltyType

string

提成计算方式

true

-

     └─royaltyPrice

number

单笔提成金额

false

-

0

     └─royaltyRate

number

提成比例,0-1

false

-

0

     └─effectMonth

string

生效月份

false

-

applyRemark

string

申请备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/accredit' --data '{
  "deptId": 0,
  "checkItemList": [
    {
      "deptId": 0,
      "itemCode": "",
      "itemName": "",
      "chargeType": 0,
      "feeType": 0,
      "feeDetail": "",
      "fee": 0,
      "freeCount": 0,
      "applyRemark": "",
      "orgCode": "",
      "riskThreshold": 0,
      "usedVersion": "",
      "isHidden": true,
      "spreaderRoyalties": [
        {
          "spreaderId": 0,
          "royaltyType": "",
          "royaltyPrice": 0,
          "royaltyRate": 0,
          "effectMonth": ""
        }
      ]
    }
  ],
  "applyRemark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.29.授权聚合产品默认子项查询

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 授权聚合产品默认子项查询

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

聚合产品编码

true

-

deptId

int64

机构id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/queryItemsForAccreditFusion' --data '{
  "checkItem": "",
  "deptId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─checkItem

string

检测项

-

└─itemName

string

检测项名称

-

└─usedVersion

string

开通版本

-

└─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

└─isOpen

int32

是否启用

-

0

└─price

number

单价

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

└─fee

number

费用

-

0

└─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

└─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

└─isFusion

boolean

是否是聚合产品

-

true

└─feeDetail

string

费用明细

-

└─freeCount

int32

免费次数

-

0

└─applyRemark

string

申请备注

-

└─auditRemark

string

审核备注(驳回原因)

-

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─taskAble

boolean

是否可在线测试

-

true

└─categoryCode

string

分类编码

-

└─categoryName

string

分类编码

-

└─docUrl

string

文档下载地址

-

└─respTime

string

响应时间

-

└─backgroundImg

string

背景图

-

└─description

string

描述

-

└─isCollected

boolean

是否已收藏

-

true

└─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

└─applicable

boolean

是否可以在线申请

-

true

└─cacheFetchDays

int32

取缓存有效天数

-

0

└─isHidden

boolean

是否隐藏

-

true

└─adjusting

object

调整中记录

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构id

-

     └─deptItemId

int64

机构单项费用id

-

0

     └─checkItem

string

检测项

-

     └─itemName

string

检测项

-

     └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

     └─beforeFee

number

变更前费用

-

0

     └─beforeFeeDetail

string

变更前费用明细

-

     └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

     └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

     └─afterFee

number

变更后费用

-

0

     └─afterFeeDetail

string

变更后费用明细

-

     └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

     └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

     └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

     └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

└─orgCode

string

组织编码

-

└─riskThreshold

number

风险阈值

-

0

└─hasAssignSource

boolean

是否指定数据源

-

true

└─spreaderRoyalties

array

推广方提成配置

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─deptId

int64

客户组织id

-

0

     └─spreaderId

int64

当前销售员id

-

0

     └─spreaderName

string

当前销售员名

-

     └─deptItemId

int64

授权记录id

-

0

     └─checkItem

string

产品编码

-

     └─royaltyType

string

提成计算方式

-

     └─royaltyPrice

number

单笔提成金额

-

0

     └─royaltyRate

number

提成比例

-

0

     └─state

enum

是否绑定中

-

INVALID

     └─effectMonth

string

生效月份

-

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "updateDate": "yyyy-MM-dd HH:mm:ss",
      "checkItem": "",
      "itemName": "",
      "usedVersion": "",
      "checkType": 0,
      "isOpen": 0,
      "price": 0,
      "deptId": 0,
      "deptName": "",
      "state": 0,
      "fee": 0,
      "chargeType": 0,
      "feeType": 0,
      "isFusion": true,
      "feeDetail": "",
      "freeCount": 0,
      "applyRemark": "",
      "auditRemark": "",
      "auditTime": "yyyy-MM-dd HH:mm:ss",
      "taskAble": true,
      "categoryCode": "",
      "categoryName": "",
      "docUrl": "",
      "respTime": "",
      "backgroundImg": "",
      "description": "",
      "isCollected": true,
      "createDate": "yyyy-MM-dd HH:mm:ss",
      "applicable": true,
      "cacheFetchDays": 0,
      "isHidden": true,
      "adjusting": {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "deptItemId": 0,
        "checkItem": "",
        "itemName": "",
        "state": 0,
        "beforeFee": 0,
        "beforeFeeDetail": "",
        "beforeChargeType": 0,
        "beforeFeeType": 0,
        "afterFee": 0,
        "afterFeeDetail": "",
        "afterChargeType": 0,
        "afterFeeType": 0,
        "planTime": "yyyy-MM-dd HH:mm:ss",
        "effectTime": "yyyy-MM-dd HH:mm:ss"
      },
      "orgCode": "",
      "riskThreshold": 0,
      "hasAssignSource": true,
      "spreaderRoyalties": [
        {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "customerId": 0,
          "customerName": "",
          "deptId": 0,
          "spreaderId": 0,
          "spreaderName": "",
          "deptItemId": 0,
          "checkItem": "",
          "royaltyType": "",
          "royaltyPrice": 0,
          "royaltyRate": 0,
          "state": 0,
          "effectMonth": "",
          "assignTime": "yyyy-MM-dd HH:mm:ss"
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.7.30.新增授权聚合产品

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 新增授权聚合产品

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

true

-

0

checkItem

string

聚合产品编码

true

-

chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

feeDetail

string

费用明细

false

-

fee

number

费用

false

-

0

freeCount

int32

免费次数

false

-

0

applyRemark

string

申请备注

false

-

subItemList

array

子项产品列表

true

-

└─deptId

int64

开发账户id

false

-

0

└─itemCode

string

产品编码,不可修改

true

-

└─itemName

string

产品名称,不可修改

false

-

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─feeDetail

string

费用明细

false

-

└─fee

number

费用

false

-

0

└─freeCount

int32

免费次数

false

-

0

└─applyRemark

string

申请备注

false

-

└─orgCode

string

组织编码

false

-

└─riskThreshold

number

风险阈值

false

-

0

└─usedVersion

string

开通版本

false

-

└─isHidden

boolean

是否隐藏

false

-

true

└─spreaderRoyalties

array

外部销售提成配置

false

-

     └─spreaderId

int64

推广员id

true

-

0

     └─royaltyType

string

提成计算方式

true

-

     └─royaltyPrice

number

单笔提成金额

false

-

0

     └─royaltyRate

number

提成比例,0-1

false

-

0

     └─effectMonth

string

生效月份

false

-

└─isAdded

boolean

是否新增授权

true

-

true

spreaderRoyalties

array

外部销售提成配置

false

-

└─spreaderId

int64

推广员id

true

-

0

└─royaltyType

string

提成计算方式

true

-

└─royaltyPrice

number

单笔提成金额

false

-

0

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

生效月份

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/accreditFusion' --data '{
  "deptId": 0,
  "checkItem": "",
  "chargeType": 0,
  "feeType": 0,
  "feeDetail": "",
  "fee": 0,
  "freeCount": 0,
  "applyRemark": "",
  "subItemList": [
    {
      "deptId": 0,
      "itemCode": "",
      "itemName": "",
      "chargeType": 0,
      "feeType": 0,
      "feeDetail": "",
      "fee": 0,
      "freeCount": 0,
      "applyRemark": "",
      "orgCode": "",
      "riskThreshold": 0,
      "usedVersion": "",
      "isHidden": true,
      "spreaderRoyalties": [
        {
          "spreaderId": 0,
          "royaltyType": "",
          "royaltyPrice": 0,
          "royaltyRate": 0,
          "effectMonth": ""
        }
      ],
      "isAdded": true
    }
  ],
  "spreaderRoyalties": [
    {
      "spreaderId": 0,
      "royaltyType": "",
      "royaltyPrice": 0,
      "royaltyRate": 0,
      "effectMonth": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.31.编辑授权产品

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑授权产品

Body-parameters:

Parameter Type Description Required Since Example

itemCode

string

产品编码,不可修改

true

-

itemName

string

产品名称,不可修改

false

-

chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

feeDetail

string

费用明细

false

-

fee

number

费用

false

-

0

freeCount

int32

免费次数

false

-

0

applyRemark

string

申请备注

false

-

orgCode

string

组织编码

false

-

riskThreshold

number

风险阈值

false

-

0

usedVersion

string

开通版本

false

-

isHidden

boolean

是否隐藏

false

-

true

spreaderRoyalties

array

外部销售提成配置

false

-

└─spreaderId

int64

推广员id

true

-

0

└─royaltyType

string

提成计算方式

true

-

└─royaltyPrice

number

单笔提成金额

false

-

0

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

生效月份

false

-

deptId

int64

机构id

true

-

0

deptItemId

int64

授权产品记录id

true

-

0

isAuditPass

boolean

是否审核通过

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/edit' --data '{
  "itemCode": "",
  "itemName": "",
  "chargeType": 0,
  "feeType": 0,
  "feeDetail": "",
  "fee": 0,
  "freeCount": 0,
  "applyRemark": "",
  "orgCode": "",
  "riskThreshold": 0,
  "usedVersion": "",
  "isHidden": true,
  "spreaderRoyalties": [
    {
      "spreaderId": 0,
      "royaltyType": "",
      "royaltyPrice": 0,
      "royaltyRate": 0,
      "effectMonth": ""
    }
  ],
  "deptId": 0,
  "deptItemId": 0,
  "isAuditPass": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.32.编辑取缓存天数

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑取缓存天数

Body-parameters:

Parameter Type Description Required Since Example

deptItemId

int64

授权记录id

true

-

0

cacheFetchDays

int32

取缓存天数,为空代表清空

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/editCacheFetch' --data '{
  "deptItemId": 0,
  "cacheFetchDays": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.33.编辑推广方分成

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑推广方分成

Body-parameters:

Parameter Type Description Required Since Example

deptItemId

int64

授权记录id

true

-

0

spreaderRoyalties

array

外部销售提成配置

false

-

└─spreaderId

int64

推广员id

true

-

0

└─royaltyType

string

提成计算方式

true

-

└─royaltyPrice

number

单笔提成金额

false

-

0

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

生效月份

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/editSpreaderRoyalties' --data '{
  "deptItemId": 0,
  "spreaderRoyalties": [
    {
      "spreaderId": 0,
      "royaltyType": "",
      "royaltyPrice": 0,
      "royaltyRate": 0,
      "effectMonth": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.34.编辑免费次数

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑免费次数

Body-parameters:

Parameter Type Description Required Since Example

itemList

array

分配明细

true

-

└─deptItemId

int64

授权产品记录id

true

-

0

└─freeCount

int32

免费次数 Validation[Min(value=0, message=免费次数不能小于0)]

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/editFreeCount' --data '{
  "itemList": [
    {
      "deptItemId": 0,
      "freeCount": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.35.编辑扩展信息

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑扩展信息

Body-parameters:

Parameter Type Description Required Since Example

itemList

array

分配明细

false

-

└─deptItemId

int64

授权产品记录id

true

-

0

└─isHidden

boolean

是否隐藏(开放平台不可见)

false

-

true

└─usedVersion

string

开通版本

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/editExtra' --data '{
  "itemList": [
    {
      "deptItemId": 0,
      "isHidden": true,
      "usedVersion": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.36.编辑客户价格

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑客户价格

Body-parameters:

Parameter Type Description Required Since Example

effectTime

string

生效时间,为空代表立即生效

false

-

yyyy-MM-dd HH:mm:ss

itemList

array

价格明细

true

-

└─deptItemId

int64

授权产品记录id

true

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─fee

number

费用

false

-

0

└─feeDetail

string

费用明细

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/adjust' --data '{
  "effectTime": "yyyy-MM-dd HH:mm:ss",
  "itemList": [
    {
      "deptItemId": 0,
      "feeType": 0,
      "chargeType": 0,
      "fee": 0,
      "feeDetail": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.37.删除授权

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 删除授权

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

true

-

0

deptItemIds

array

申请开通的产品

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/delete' --data '{
  "deptId": 0,
  "deptItemIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.38.启用授权

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 启用授权

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

true

-

0

deptItemIds

array

申请开通的产品

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/enable' --data '{
  "deptId": 0,
  "deptItemIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.39.禁用授权

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 禁用授权

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

true

-

0

deptItemIds

array

申请开通的产品

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/disable' --data '{
  "deptId": 0,
  "deptItemIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.40.操作聚合产品子项

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 操作聚合产品子项

Body-parameters:

Parameter Type Description Required Since Example

deptItemId

int64

聚合产品授权产品记录id

true

-

0

checkItemList

array

子项产品编码

true

-

""","""

dealType

int32

操作类型,10-新增,20-删除

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/dealSub' --data '{
  "deptItemId": 0,
  "checkItemList": [
    ""
  ],
  "dealType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.41.指定数据源列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 指定数据源列表

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

机构id

true

-

0

checkItem

string

产品项

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/sourceConfigList' --data '{
  "deptId": 0,
  "checkItem": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─checkItem

string

产品项

-

└─checkItemName

string

产品项名称

-

└─sourceId

int64

数据源配置ID(对应enol_check_config的id)

-

0

└─dataSourceId

int32

数据源ID

-

0

└─dataSourceName

string

数据源名称

-

└─dataSourceCode

string

数据源编号,不可修改

-

└─priority

int32

优先级

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createDate": "yyyy-MM-dd HH:mm:ss",
      "updateDate": "yyyy-MM-dd HH:mm:ss",
      "deptId": 0,
      "deptName": "",
      "checkItem": "",
      "checkItemName": "",
      "sourceId": 0,
      "dataSourceId": 0,
      "dataSourceName": "",
      "dataSourceCode": "",
      "priority": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.7.42.保存指定数据源

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 保存指定数据源

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

机构id(不可修改)

true

-

0

checkItem

string

产品项(不可修改)

true

-

sourceList

array

数据源列表

true

-

└─id

int64

id,不为空代表修改

false

-

0

└─sourceId

int64

数据源配置ID(不可修改)

true

-

0

└─priority

int32

优先级(大于等于0)

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/saveSourceConfig' --data '{
  "deptId": 0,
  "checkItem": "",
  "sourceList": [
    {
      "id": 0,
      "sourceId": 0,
      "priority": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.43.删除指定数据源

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 删除指定数据源

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/deptItem/deleteSourceConfig' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.44.认证记录列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 认证记录列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

stateList

array

状态

false

-

"0,0"

authType

int32

认证类型,10-个人认证,20-企业认证

false

-

0

userId

int64

用户id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/auth/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "stateList": [
    0
  ],
  "authType": 0,
  "userId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─userId

int64

用户id

-

0

     └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

     └─state

int32

状态

-

0

     └─enterpriseName

string

企业姓名

-

     └─enterpriseNo

string

统一社会信用编码

-

     └─realName

string

真实姓名/法人姓名

-

     └─idCard

string

身份证号/法人身份证

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─idCardFront

string

身份证/法人身份证正面

-

     └─idCardBack

string

法人身份证法人身份证反面

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─linkman

string

联系人

-

     └─linkMobile

string

联系电话

-

     └─linkEmail

string

联系人邮箱

-

     └─linkPosition

string

联系人职位

-

     └─businessDesc

string

业务介绍

-

     └─addressInfo

object

地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─industry

enum

行业编码

-

LEASE3C

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核意见

-

     └─sourceAppcode

string

注册系统编码

-

     └─tenantId

int64

租户id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "userId": 0,
        "authType": 0,
        "state": 0,
        "enterpriseName": "",
        "enterpriseNo": "",
        "realName": "",
        "idCard": "",
        "mobile": "",
        "businessImg": "",
        "idCardFront": "",
        "idCardBack": "",
        "workspaceImgList": [
          ""
        ],
        "certificationList": [
          ""
        ],
        "linkman": "",
        "linkMobile": "",
        "linkEmail": "",
        "linkPosition": "",
        "businessDesc": "",
        "addressInfo": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "industry": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "auditRemark": "",
        "sourceAppcode": "",
        "tenantId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.45.认证记录详情

Type: GET

Author: wangqidong created on 2024/11/15

Content-Type: application/x-www-form-urlencoded

Description: 认证记录详情

Path-parameters:

Parameter Type Description Required Since Example

id

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/crm/customer/auth/detail/{id}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─userId

int64

用户id

-

0

└─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

└─state

int32

状态

-

0

└─enterpriseName

string

企业姓名

-

└─enterpriseNo

string

统一社会信用编码

-

└─realName

string

真实姓名/法人姓名

-

└─idCard

string

身份证号/法人身份证

-

└─mobile

string

手机号

-

└─businessImg

string

营业执照

-

└─idCardFront

string

身份证/法人身份证正面

-

└─idCardBack

string

法人身份证法人身份证反面

-

└─workspaceImgList

array

办公场所

-

""","""

└─certificationList

array

资质文件

-

""","""

└─linkman

string

联系人

-

└─linkMobile

string

联系电话

-

└─linkEmail

string

联系人邮箱

-

└─linkPosition

string

联系人职位

-

└─businessDesc

string

业务介绍

-

└─addressInfo

object

地址

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─industry

enum

行业编码

-

LEASE3C

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─auditRemark

string

审核意见

-

└─sourceAppcode

string

注册系统编码

-

└─tenantId

int64

租户id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "userId": 0,
    "authType": 0,
    "state": 0,
    "enterpriseName": "",
    "enterpriseNo": "",
    "realName": "",
    "idCard": "",
    "mobile": "",
    "businessImg": "",
    "idCardFront": "",
    "idCardBack": "",
    "workspaceImgList": [
      ""
    ],
    "certificationList": [
      ""
    ],
    "linkman": "",
    "linkMobile": "",
    "linkEmail": "",
    "linkPosition": "",
    "businessDesc": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "industry": "",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "auditRemark": "",
    "sourceAppcode": "",
    "tenantId": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.46.编辑认证记录

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 编辑认证记录

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

false

-

0

enterpriseName

string

企业姓名

false

-

enterpriseNo

string

统一社会信用编码

false

-

realName

string

真实姓名/法人姓名

false

-

idCard

string

身份证号/法人身份证

false

-

mobile

string

手机号

false

-

businessImg

string

营业执照

false

-

idCardFront

string

身份证/法人身份证正面

false

-

idCardBack

string

法人身份证法人身份证反面

false

-

workspaceImgList

array

办公场所

false

-

""","""

certificationList

array

资质文件

false

-

""","""

linkman

string

联系人

false

-

linkMobile

string

联系电话

false

-

linkEmail

string

联系人邮箱

false

-

linkPosition

string

联系人职位

false

-

businessDesc

string

业务介绍

false

-

auditRemark

string

审核意见

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/auth/edit' --data '{
  "id": 0,
  "authType": 0,
  "enterpriseName": "",
  "enterpriseNo": "",
  "realName": "",
  "idCard": "",
  "mobile": "",
  "businessImg": "",
  "idCardFront": "",
  "idCardBack": "",
  "workspaceImgList": [
    ""
  ],
  "certificationList": [
    ""
  ],
  "linkman": "",
  "linkMobile": "",
  "linkEmail": "",
  "linkPosition": "",
  "businessDesc": "",
  "auditRemark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.47.认证审核

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 认证审核

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

auditType

string

审核类型,pass-通过,reject-拒绝

true

-

rejectReason

string

拒绝原因

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/auth/audit' --data '{
  "id": 0,
  "auditType": "",
  "rejectReason": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.48.开通开发者账号

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 开通开发者账号

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

用户id

true

-

0

env

string

账户类型,prod:正式,test:测试

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/applyDeveloper' --data '{
  "userId": 0,
  "env": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.49.查询客户发票抬头

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 查询客户发票抬头

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

客户id

true

-

0

invoiceType

string

开票类型,normal-普票,special-专票

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/invoiceHeader/list' --data '{
  "userId": 0,
  "invoiceType": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─userId

int64

用户id

-

0

└─username

string

用户名f

-

└─invoiceType

string

开票类型,normal-普票,special-专票

-

└─name

string

发票抬头

-

└─tin

string

税号

-

└─email

string

邮箱

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "userId": 0,
      "username": "",
      "invoiceType": "",
      "name": "",
      "tin": "",
      "email": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.7.50.添加直客

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 添加直客

Body-parameters:

Parameter Type Description Required Since Example

orgCode

string

机构编码

true

-

orgName

string

机构名称

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/organization/add' --data '{
  "orgCode": "",
  "orgName": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.7.51.直客列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 直客列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/organization/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

机构编码

-

     └─orgName

string

机构名称

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "orgCode": "",
        "orgName": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.52.拜访记录

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 拜访记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

No comments found.

false

-

salesmanId

int64

销售员id

false

-

0

customerIds

array

客户id

false

-

"0,0"

opportunityIds

array

商机id

false

-

"0,0"

followDateGte

string

跟进日期大于等于

false

-

yyyy-MM-dd

followDateLte

string

跟进日期小于等于

false

-

yyyy-MM-dd

followType

string

跟进类型,visit:拜访

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/follow/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "salesmanId": 0,
  "customerIds": [
    0
  ],
  "opportunityIds": [
    0
  ],
  "followDateGte": "yyyy-MM-dd",
  "followDateLte": "yyyy-MM-dd",
  "followType": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerId

int64

客户id

-

0

     └─opportunityId

int64

商机id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

当前销售员id

-

0

     └─salesmanName

string

当前销售员名

-

     └─followType

string

跟进类型,visit:拜访

-

     └─followDate

string

跟进日期

-

yyyy-MM-dd

     └─contactName

string

对接人

-

     └─contactPosition

string

对接人职务

-

     └─contactMobile

string

对接人联系方式

-

     └─flowContent

string

跟进内容

-

     └─enterpriseDesc

string

企业描述

-

     └─feedback

string

客户反馈

-

     └─imgList

array

跟进照片

-

""","""

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "customerId": 0,
        "opportunityId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "followType": "",
        "followDate": "yyyy-MM-dd",
        "contactName": "",
        "contactPosition": "",
        "contactMobile": "",
        "flowContent": "",
        "enterpriseDesc": "",
        "feedback": "",
        "imgList": [
          ""
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.53.商机列表

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 商机列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

salesmanId

int64

销售员id

false

-

0

keyword

string

关键字

false

-

createTimeGte

string

创建时间大于等于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于等于

false

-

yyyy-MM-dd HH:mm:ss

hiddenConverted

boolean

已转客户是否隐藏

false

-

true

customerIds

array

客户id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/opportunity/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "salesmanId": 0,
  "keyword": "",
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss",
  "hiddenConverted": true,
  "customerIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerName

string

客户名

-

     └─contactName

string

联系人

-

     └─contactMobile

string

联系方式

-

     └─customerNature

string

客户业务类型

-

     └─salesmanId

int64

当前销售员id

-

0

     └─salesmanName

string

当前销售员名

-

     └─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

     └─customerId

int64

转客户id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "customerName": "",
        "contactName": "",
        "contactMobile": "",
        "customerNature": "",
        "salesmanId": 0,
        "salesmanName": "",
        "roleType": "",
        "customerId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.7.54.删除商机

Type: POST

Author: wangqidong created on 2024/11/15

Content-Type: application/json

Description: 删除商机

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/customer/opportunity/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.8.系统管理

3.8.1.获取日志库列表

Type: GET

Author: wangqidong created on 2025/1/2

Content-Type: application/x-www-form-urlencoded

Description: 获取日志库列表

Request-example:

curl -X GET -i '/mt/crm/sys/queryLogStoreList'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─name

string

日志库名称

-

└─pageUrl

string

页面地址

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "name": "",
      "pageUrl": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.8.2.短信模板列表

Type: POST

Author: wangqidong created on 2025/1/2

Content-Type: application/json

Description: 短信模板列表

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sys/smsTemplateList' --data '{}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─code

string

模板编码

-

└─subject

string

名称

-

└─content

string

模板内容

-

└─url

string

模板链接

-

└─providerCode

string

数据源模板编码

-

└─scenes

string

场景,多个逗号分割

-

└─fillConfigs

object

填充参数配置

-

     └─text

array

文本类型填充

-

          └─key

string

字段key

-

          └─name

string

字段名

-

          └─subList

array

子项字段,array类型专属

-

          └─hasPaging

boolean

是否含骑缝章

-

true

          └─silentSignerId

int64

静默签署人id

-

0

          └─must

boolean

是否必填,默认false

-

true

          └─fixed

boolean

是否固定不可修改,默认false

-

true

     └─array

array

数组类型填充

-

          └─key

string

字段key

-

          └─name

string

字段名

-

          └─subList

array

子项字段,array类型专属

-

          └─hasPaging

boolean

是否含骑缝章

-

true

          └─silentSignerId

int64

静默签署人id

-

0

          └─must

boolean

是否必填,默认false

-

true

          └─fixed

boolean

是否固定不可修改,默认false

-

true

     └─signer

array

签章类型填充

-

          └─key

string

字段key

-

          └─name

string

字段名

-

          └─subList

array

子项字段,array类型专属

-

          └─hasPaging

boolean

是否含骑缝章

-

true

          └─silentSignerId

int64

静默签署人id

-

0

          └─must

boolean

是否必填,默认false

-

true

          └─fixed

boolean

是否固定不可修改,默认false

-

true

└─enable

boolean

是否启用

-

true

└─isHtml

boolean

内容是否html(仅对邮件生效)

-

true

└─signName

string

签名

-

└─validDays

int32

有效天数

-

0

└─dataSourceId

int64

数据源id

-

0

└─mailSourceId

int64

邮件数据源id

-

0

└─price

number

单价

-

0

└─version

int32

版本号

-

0

└─versionName

string

版本名称

-

└─extra

string

额外配置

-

└─appcode

string

应用编码

-

└─tenantId

int64

租户id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "code": "",
      "subject": "",
      "content": "",
      "url": "",
      "providerCode": "",
      "scenes": "",
      "fillConfigs": {
        "text": [
          {
            "key": "",
            "name": "",
            "subList": [
              {
                "$ref": ".."
              }
            ],
            "hasPaging": true,
            "silentSignerId": 0,
            "must": true,
            "fixed": true
          }
        ],
        "array": [
          {
            "key": "",
            "name": "",
            "subList": [
              {
                "$ref": ".."
              }
            ],
            "hasPaging": true,
            "silentSignerId": 0,
            "must": true,
            "fixed": true
          }
        ],
        "signer": [
          {
            "key": "",
            "name": "",
            "subList": [
              {
                "$ref": ".."
              }
            ],
            "hasPaging": true,
            "silentSignerId": 0,
            "must": true,
            "fixed": true
          }
        ]
      },
      "enable": true,
      "isHtml": true,
      "signName": "",
      "validDays": 0,
      "dataSourceId": 0,
      "mailSourceId": 0,
      "price": 0,
      "version": 0,
      "versionName": "",
      "extra": "",
      "appcode": "",
      "tenantId": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.8.3.短信记录

Type: POST

Author: wangqidong created on 2025/1/2

Content-Type: application/json

Description: 短信记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

userIdList

array

用户id

false

-

"0,0"

smsMethod

string

类型,sms-短信,email-邮件

false

-

templateCode

string

模板编码

false

-

appcodes

array

应用编码

false

-

""","""

createTimeGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sys/smsRecordList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "userIdList": [
    0
  ],
  "smsMethod": "",
  "templateCode": "",
  "appcodes": [
    ""
  ],
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─orderNo

string

订单号

-

     └─userId

int64

用户id

-

0

     └─smsMethod

string

类型,sms-手机短信,email-邮件

-

     └─receiver

string

收件人,多个逗号分割

-

     └─templateCode

string

模板编码

-

     └─title

string

标题

-

     └─content

string

内容

-

     └─isHtml

boolean

内容是否是html

-

true

     └─datasourceId

int64

数据源

-

0

     └─datasourceName

string

数据源名

-

     └─thirdId

string

第三方id

-

     └─appcode

string

应用编码

-

     └─appName

string

应用名

-

     └─customName

string

客户名

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "orderNo": "",
        "userId": 0,
        "smsMethod": "",
        "receiver": "",
        "templateCode": "",
        "title": "",
        "content": "",
        "isHtml": true,
        "datasourceId": 0,
        "datasourceName": "",
        "thirdId": "",
        "appcode": "",
        "appName": "",
        "customName": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.8.4.添加临时白名单ip

Type: GET

Author: wangqidong created on 2025/1/2

Content-Type: application/x-www-form-urlencoded

Description: 添加临时白名单ip

Request-example:

curl -X GET -i '/mt/crm/sys/addTempWhiteIps'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.8.5.生成临时密码

Type: POST

Author: wangqidong created on 2025/1/2

Content-Type: application/json

Description: 生成临时密码

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/sys/genTempPasswd' --data '{}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

3.9.基础类接口

3.9.1.枚举列表

Type: POST

Author: wangqidong created on 2025/3/18

Content-Type: application/json

Description: 枚举列表

Body-parameters:

Parameter Type Description Required Since Example

className

string

枚举类名

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/base/enumList' --data '{
  "className": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─code

string

No comments found.

-

└─desc

string

No comments found.

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "code": "",
      "desc": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.10.产品管理

3.10.1.产品列表

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

checkItemList

array

产品编码列表

false

-

""","""

excludeCheckItemList

array

排除的产品编码列表

false

-

""","""

excludeDeptId

int64

排除用户拥有的产品

false

-

0

compareDeptId

int64

用于判断该用户有没有授权产品

false

-

0

isFusion

boolean

是否聚合产品

false

-

true

state

int32

状态,-1:已下架,10:已上架,5:异常

false

-

0

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "applicable": true,
  "checkItemList": [
    ""
  ],
  "excludeCheckItemList": [
    ""
  ],
  "excludeDeptId": 0,
  "compareDeptId": 0,
  "isFusion": true,
  "state": 0,
  "checkType": 0,
  "cacheFlag": 0,
  "feeType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─cacheFlag

int32

是否启用缓存

-

0

     └─cacheTime

int32

缓存天数

-

0

     └─state

int32

状态,-1:已下架,10:已上架,5:异常

-

0

     └─checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

-

0

     └─isOpen

int32

是否启用

-

0

     └─riskThreshold

number

风险阈值

-

0

     └─price

number

单价

-

0

     └─floorPrice

number

销售底价

-

0

     └─applicable

boolean

是否可以在线申请

-

true

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─feeType

int32

计费方式,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─subItems

string

聚合产品默认子项

-

     └─subItemList

array

聚合产品默认子项,详情才会返回

-

     └─isAccredit

boolean

当前用户是否已授权

-

true

     └─maxFreeCount

int32

销售默认分配免费次数上限

-

0

     └─encryptable

string

No comments found.

-

     └─encryptableList

array

支持的加密方式

-

"0,0"

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "checkItem": "",
        "itemName": "",
        "cacheFlag": 0,
        "cacheTime": 0,
        "state": 0,
        "checkType": 0,
        "isOpen": 0,
        "riskThreshold": 0,
        "price": 0,
        "floorPrice": 0,
        "applicable": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "feeType": 0,
        "isFusion": true,
        "subItems": "",
        "subItemList": [
          {
            "$ref": ".."
          }
        ],
        "isAccredit": true,
        "maxFreeCount": 0,
        "encryptable": "",
        "encryptableList": [
          0
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.10.2.新增产品

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 新增产品

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

checkItem

string

检测项

true

-

itemName

string

检测项名称

true

-

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

cacheTime

int32

缓存天数

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

riskThreshold

number

风险阈值

false

-

0

price

number

单价

false

-

0

floorPrice

number

默认销售底价

false

-

0

isFusion

boolean

是否是聚合产品

false

-

true

applicable

boolean

是否可以在线申请

false

-

true

encryptableList

array

支持的加密方式

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/add' --data '{
  "syncOtherEnv": true,
  "checkItem": "",
  "itemName": "",
  "checkType": 0,
  "cacheFlag": 0,
  "cacheTime": 0,
  "feeType": 0,
  "riskThreshold": 0,
  "price": 0,
  "floorPrice": 0,
  "isFusion": true,
  "applicable": true,
  "encryptableList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.3.删除产品

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 删除产品

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.4.新增产品(其他环境同步)

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 新增产品(其他环境同步)

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

checkItem

string

检测项

true

-

itemName

string

检测项名称

true

-

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

cacheTime

int32

缓存天数

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

riskThreshold

number

风险阈值

false

-

0

price

number

单价

false

-

0

floorPrice

number

默认销售底价

false

-

0

isFusion

boolean

是否是聚合产品

false

-

true

applicable

boolean

是否可以在线申请

false

-

true

encryptableList

array

支持的加密方式

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/syncAdd' --data '{
  "syncOtherEnv": true,
  "checkItem": "",
  "itemName": "",
  "checkType": 0,
  "cacheFlag": 0,
  "cacheTime": 0,
  "feeType": 0,
  "riskThreshold": 0,
  "price": 0,
  "floorPrice": 0,
  "isFusion": true,
  "applicable": true,
  "encryptableList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.5.编辑产品

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 编辑产品

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

id

int64

主键,id、itemCode二选一

false

-

0

itemCode

string

产品编码,id、itemCode二选一

false

-

itemName

string

检测项名称

false

-

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

cacheTime

int32

缓存天数

false

-

0

isOpen

int32

是否启用

false

-

0

riskThreshold

number

风险阈值

false

-

0

price

number

单价

false

-

0

floorPrice

number

默认销售底价

false

-

0

applicable

boolean

是否可以在线申请

false

-

true

isFusion

boolean

是否聚合产品

false

-

true

encryptableList

array

支持的加密方式

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/edit' --data '{
  "syncOtherEnv": true,
  "id": 0,
  "itemCode": "",
  "itemName": "",
  "checkType": 0,
  "feeType": 0,
  "cacheFlag": 0,
  "cacheTime": 0,
  "isOpen": 0,
  "riskThreshold": 0,
  "price": 0,
  "floorPrice": 0,
  "applicable": true,
  "isFusion": true,
  "encryptableList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.6.同步编辑产品

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 同步编辑产品

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

id

int64

主键,id、itemCode二选一

false

-

0

itemCode

string

产品编码,id、itemCode二选一

false

-

itemName

string

检测项名称

false

-

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

cacheTime

int32

缓存天数

false

-

0

isOpen

int32

是否启用

false

-

0

riskThreshold

number

风险阈值

false

-

0

price

number

单价

false

-

0

floorPrice

number

默认销售底价

false

-

0

applicable

boolean

是否可以在线申请

false

-

true

isFusion

boolean

是否聚合产品

false

-

true

encryptableList

array

支持的加密方式

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/syncEdit' --data '{
  "syncOtherEnv": true,
  "id": 0,
  "itemCode": "",
  "itemName": "",
  "checkType": 0,
  "feeType": 0,
  "cacheFlag": 0,
  "cacheTime": 0,
  "isOpen": 0,
  "riskThreshold": 0,
  "price": 0,
  "floorPrice": 0,
  "applicable": true,
  "isFusion": true,
  "encryptableList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.7.保存默认子项

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 保存默认子项

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

checkItem

string

聚合产品编码

true

-

subItems

array

子项

true

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/saveDefaultSubItems' --data '{
  "syncOtherEnv": true,
  "checkItem": "",
  "subItems": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.8.同步保存默认子项

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 同步保存默认子项

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

checkItem

string

聚合产品编码

true

-

subItems

array

子项

true

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/syncSaveDefaultSubItems' --data '{
  "syncOtherEnv": true,
  "checkItem": "",
  "subItems": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.9.查询已开通产品的用户

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 查询已开通产品的用户

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

产品编码

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/queryOpenedDeptList' --data '{
  "checkItem": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

No comments found.

-

0

└─deptName

string

机构名称

-

└─userName

string

用户名

-

└─mobile

string

联系号码

-

└─password

string

密码

-

└─proxyerId

int32

代理员ID

-

0

└─proxyer

string

代理人

-

└─appId

string

接口appId

-

└─checkFee

number

单项报告费用(单位:元)

-

0

└─trialEndDate

string

试用结束日期

-

yyyy-MM-dd HH:mm:ss

└─status

int32

状态 0:试用。1正式客户

-

0

└─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

└─proxyerMobile

string

代理商电话

-

└─userId

int64

用户id

-

0

└─createDate

string

No comments found.

-

yyyy-MM-dd HH:mm:ss

└─emails

string

通知邮箱

-

└─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

└─whiteIpList

string

ip白名单,多个逗号分割

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "deptName": "",
      "userName": "",
      "mobile": "",
      "password": "",
      "proxyerId": 0,
      "proxyer": "",
      "appId": "",
      "checkFee": 0,
      "trialEndDate": "yyyy-MM-dd HH:mm:ss",
      "status": 0,
      "overdraftType": 0,
      "proxyerMobile": "",
      "userId": 0,
      "createDate": "yyyy-MM-dd HH:mm:ss",
      "emails": "",
      "contractState": 0,
      "whiteIpList": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.10.10.修改状态

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 修改状态

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

产品编码

true

-

state

int32

变更类型,-1:下架,10:上架(恢复正常),5:异常

true

-

0

noticeScope

int32

0:不发送,10:自定义,20:所有

true

-

0

noticeMethods

array

通知方式

false

-

""","""

effectTime

string

生效时间,为空立即生效

false

-

yyyy-MM-dd HH:mm:ss

note

string

说明

false

-

noticeCustomers

array

指定通知客户列表

false

-

└─deptId

int64

组织id

true

-

0

└─userId

int64

No comments found.

false

-

0

└─deptName

string

No comments found.

false

-

└─mobile

string

通知手机号

false

-

└─email

string

通知邮箱

false

-

confirmed

boolean

是否确认充值,默认false

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/changeState' --data '{
  "checkItem": "",
  "state": 0,
  "noticeScope": 0,
  "noticeMethods": [
    ""
  ],
  "effectTime": "yyyy-MM-dd HH:mm:ss",
  "note": "",
  "noticeCustomers": [
    {
      "deptId": 0,
      "userId": 0,
      "deptName": "",
      "mobile": "",
      "email": ""
    }
  ],
  "confirmed": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.11.客户产品列表

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 客户产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptIdList

array

组织id

false

-

"0,0"

stateList

array

状态

false

-

"0,0"

checkItemList

array

产品编码列表

false

-

""","""

querySpreader

boolean

查询推广员信息

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/deptItem/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "checkItemList": [
    ""
  ],
  "querySpreader": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.10.12.客户产品审核

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 客户产品审核

Body-parameters:

Parameter Type Description Required Since Example

itemCode

string

产品编码,不可修改

true

-

itemName

string

产品名称,不可修改

false

-

chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

feeDetail

string

费用明细

false

-

fee

number

费用

false

-

0

freeCount

int32

免费次数

false

-

0

applyRemark

string

申请备注

false

-

orgCode

string

组织编码

false

-

riskThreshold

number

风险阈值

false

-

0

usedVersion

string

开通版本

false

-

isHidden

boolean

是否隐藏

false

-

true

spreaderRoyalties

array

外部销售提成配置

false

-

└─spreaderId

int64

推广员id

true

-

0

└─royaltyType

string

提成计算方式

true

-

└─royaltyPrice

number

单笔提成金额

false

-

0

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

生效月份

false

-

deptId

int64

机构id

true

-

0

deptItemId

int64

授权产品记录id

true

-

0

isAuditPass

boolean

是否审核通过

false

-

true

auditType

string

审核类型,pass-通过,reject-拒绝

true

-

rejectReason

string

拒绝原因

false

-

sourceList

array

数据源列表

false

-

└─id

int64

id,不为空代表修改

false

-

0

└─sourceId

int64

数据源配置ID(不可修改)

true

-

0

└─priority

int32

优先级(大于等于0)

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/deptItem/audit' --data '{
  "itemCode": "",
  "itemName": "",
  "chargeType": 0,
  "feeType": 0,
  "feeDetail": "",
  "fee": 0,
  "freeCount": 0,
  "applyRemark": "",
  "orgCode": "",
  "riskThreshold": 0,
  "usedVersion": "",
  "isHidden": true,
  "spreaderRoyalties": [
    {
      "spreaderId": 0,
      "royaltyType": "",
      "royaltyPrice": 0,
      "royaltyRate": 0,
      "effectMonth": ""
    }
  ],
  "deptId": 0,
  "deptItemId": 0,
  "isAuditPass": true,
  "auditType": "",
  "rejectReason": "",
  "sourceList": [
    {
      "id": 0,
      "sourceId": 0,
      "priority": 0
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.13.客户产品批量审核

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 客户产品批量审核

Body-parameters:

Parameter Type Description Required Since Example

auditType

string

审核类型,pass-通过,reject-拒绝

true

-

rejectReason

string

拒绝原因

false

-

itemList

array

审核产品列表

true

-

└─deptId

int64

机构id

true

-

0

└─deptItemId

int64

授权产品记录id

true

-

0

└─itemCode

string

产品编码,不可修改

true

-

└─itemName

string

产品名称,不可修改

false

-

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─feeDetail

string

费用明细

false

-

└─fee

number

费用

false

-

0

└─freeCount

int32

免费次数

false

-

0

└─sourceList

array

指定数据源列表

false

-

     └─id

int64

id,不为空代表修改

false

-

0

     └─sourceId

int64

数据源配置ID(不可修改)

true

-

0

     └─priority

int32

优先级(大于等于0)

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/deptItem/batchAudit' --data '{
  "auditType": "",
  "rejectReason": "",
  "itemList": [
    {
      "deptId": 0,
      "deptItemId": 0,
      "itemCode": "",
      "itemName": "",
      "chargeType": 0,
      "feeType": 0,
      "feeDetail": "",
      "fee": 0,
      "freeCount": 0,
      "sourceList": [
        {
          "id": 0,
          "sourceId": 0,
          "priority": 0
        }
      ]
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.14.数据源列表

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 数据源列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

dataSourceIdList

array

数据源id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/datasource/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "dataSourceIdList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

     └─id

int64

主键

-

0

     └─dataSourceName

string

数据源名称

-

     └─dataSourceCode

string

数据源编号,不可修改

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "syncOtherEnv": true,
        "id": 0,
        "dataSourceName": "",
        "dataSourceCode": "",
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.10.15.保存数据源

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 保存数据源

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

id

int64

主键

false

-

0

dataSourceName

string

数据源名称

false

-

dataSourceCode

string

数据源编号,不可修改

false

-

createDate

string

创建时间

false

-

yyyy-MM-dd HH:mm:ss

updateDate

string

修改时间

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/datasource/save' --data '{
  "syncOtherEnv": true,
  "id": 0,
  "dataSourceName": "",
  "dataSourceCode": "",
  "createDate": "yyyy-MM-dd HH:mm:ss",
  "updateDate": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.16.同步保存数据源

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 同步保存数据源

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

id

int64

主键

false

-

0

dataSourceName

string

数据源名称

false

-

dataSourceCode

string

数据源编号,不可修改

false

-

createDate

string

创建时间

false

-

yyyy-MM-dd HH:mm:ss

updateDate

string

修改时间

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/datasource/syncSave' --data '{
  "syncOtherEnv": true,
  "id": 0,
  "dataSourceName": "",
  "dataSourceCode": "",
  "createDate": "yyyy-MM-dd HH:mm:ss",
  "updateDate": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.17.删除数据源

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 删除数据源

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/datasource/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.18.上游配置列表

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 上游配置列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

checkItem

string

产品编码,产品编码和数据源编码不能都为空

false

-

dataSourceId

int64

数据源id,产品编码和数据源编码不能都为空

false

-

0

excludeSourceIdList

array

排除的数据源id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/upstream/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "checkItem": "",
  "dataSourceId": 0,
  "excludeSourceIdList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─priority

int32

优先级

-

0

     └─dataSourceId

int32

数据源id

-

0

     └─dataSourceCode

string

数据源编码

-

     └─dataSourceName

string

数据源名称

-

     └─service

string

数据源

-

     └─checkItem

string

服务项

-

     └─checkItemName

string

服务项名称

-

     └─reqKey

string

请求key,用户名,appId等...

-

     └─reqSecret

string

请求秘钥,密码,appSecret等...

-

     └─reqUrl

string

请求地址

-

     └─cost

number

成本 单位:元

-

0

     └─costDetail

string

成本明细

-

     └─extra

string

附加信息

-

     └─scene

string

场景

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "priority": 0,
        "dataSourceId": 0,
        "dataSourceCode": "",
        "dataSourceName": "",
        "service": "",
        "checkItem": "",
        "checkItemName": "",
        "reqKey": "",
        "reqSecret": "",
        "reqUrl": "",
        "cost": 0,
        "costDetail": "",
        "extra": "",
        "scene": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.10.19.保存上游配置

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 保存上游配置

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

id

int64

主键,不为空为编辑

false

-

0

priority

int32

优先级

false

-

0

dataSourceId

int32

数据源id,不可修改,dataSourceId、datasourceCode必传其一

false

-

0

datasourceCode

string

数据源编码,不可修改,dataSourceId、datasourceCode必传其一

false

-

service

string

数据源类名

true

-

checkItem

string

服务项,不可修改

true

-

reqKey

string

请求key,用户名,appId等...

false

-

reqSecret

string

请求秘钥,密码,appSecret等...

false

-

reqUrl

string

请求地址

false

-

cost

number

成本 单位:元

false

-

0

costDetail

string

成本明细

false

-

extra

string

附加信息

false

-

scene

string

场景

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/upstream/save' --data '{
  "syncOtherEnv": true,
  "id": 0,
  "priority": 0,
  "dataSourceId": 0,
  "datasourceCode": "",
  "service": "",
  "checkItem": "",
  "reqKey": "",
  "reqSecret": "",
  "reqUrl": "",
  "cost": 0,
  "costDetail": "",
  "extra": "",
  "scene": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.20.保存上游配置

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 保存上游配置

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

id

int64

主键,不为空为编辑

false

-

0

priority

int32

优先级

false

-

0

dataSourceId

int32

数据源id,不可修改,dataSourceId、datasourceCode必传其一

false

-

0

datasourceCode

string

数据源编码,不可修改,dataSourceId、datasourceCode必传其一

false

-

service

string

数据源类名

true

-

checkItem

string

服务项,不可修改

true

-

reqKey

string

请求key,用户名,appId等...

false

-

reqSecret

string

请求秘钥,密码,appSecret等...

false

-

reqUrl

string

请求地址

false

-

cost

number

成本 单位:元

false

-

0

costDetail

string

成本明细

false

-

extra

string

附加信息

false

-

scene

string

场景

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/upstream/syncSave' --data '{
  "syncOtherEnv": true,
  "id": 0,
  "priority": 0,
  "dataSourceId": 0,
  "datasourceCode": "",
  "service": "",
  "checkItem": "",
  "reqKey": "",
  "reqSecret": "",
  "reqUrl": "",
  "cost": 0,
  "costDetail": "",
  "extra": "",
  "scene": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.10.21.删除上游配置

Type: POST

Author: wangqidong created on 2024/11/18

Content-Type: application/json

Description: 删除上游配置

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/checkItem/upstream/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.11.客户合同管理

3.11.1.需签署合同客户列表

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 需签署合同客户列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/needSignContractList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

No comments found.

-

0

     └─deptName

string

机构名称

-

     └─userName

string

用户名

-

     └─mobile

string

联系号码

-

     └─password

string

密码

-

     └─proxyerId

int32

代理员ID

-

0

     └─proxyer

string

代理人

-

     └─appId

string

接口appId

-

     └─checkFee

number

单项报告费用(单位:元)

-

0

     └─trialEndDate

string

试用结束日期

-

yyyy-MM-dd HH:mm:ss

     └─status

int32

状态 0:试用。1正式客户

-

0

     └─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

     └─proxyerMobile

string

代理商电话

-

     └─userId

int64

用户id

-

0

     └─createDate

string

No comments found.

-

yyyy-MM-dd HH:mm:ss

     └─emails

string

通知邮箱

-

     └─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

     └─whiteIpList

string

ip白名单,多个逗号分割

-

     └─deptItemCount

int32

产品数量

-

0

     └─lastAuditTime

string

最近审核时间

-

yyyy-MM-dd HH:mm:ss

     └─templateCode

string

合同模板编码

-

     └─templateName

string

合同模板名称

-

     └─seq

int32

次序

-

0

     └─authState

int32

认证状态

-

0

     └─authRecordId

int64

最新认证记录id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptName": "",
        "userName": "",
        "mobile": "",
        "password": "",
        "proxyerId": 0,
        "proxyer": "",
        "appId": "",
        "checkFee": 0,
        "trialEndDate": "yyyy-MM-dd HH:mm:ss",
        "status": 0,
        "overdraftType": 0,
        "proxyerMobile": "",
        "userId": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "emails": "",
        "contractState": 0,
        "whiteIpList": "",
        "deptItemCount": 0,
        "lastAuditTime": "yyyy-MM-dd HH:mm:ss",
        "templateCode": "",
        "templateName": "",
        "seq": 0,
        "authState": 0,
        "authRecordId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.11.2.查询提交合同准备数据

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 查询提交合同准备数据

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

forManualUpload

boolean

手动上传合同场景

false

-

true

dealName

string

操作人姓名

false

-

dealMobile

string

操作人手机号

false

-

dealEmail

string

操作人邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/preData' --data '{
  "deptId": 0,
  "forManualUpload": true,
  "dealName": "",
  "dealMobile": "",
  "dealEmail": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─contractName

string

合同名称

-

└─templateCode

string

合同模板编码

-

└─templateName

string

合同模板名称

-

└─fillData

array

填充数据

-

     └─key

string

关键字

-

     └─name

string

名称

-

     └─value

string

内容

-

     └─must

boolean

是否必填,默认false

-

true

     └─fixed

boolean

是否固定不可修改,默认false

-

true

└─deptItemList

array

产品列表

-

     └─deptItemId

int64

授权记录id

-

0

     └─checkItem

string

产品编码

-

     └─itemName

string

产品名称

-

     └─showFee

string

展示单价

-

     └─feeType

string

计费方式,查得计费、查询计费

-

     └─remark

string

备注

-

└─seq

int32

次序

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "contractName": "",
    "templateCode": "",
    "templateName": "",
    "fillData": [
      {
        "key": "",
        "name": "",
        "value": "",
        "must": true,
        "fixed": true
      }
    ],
    "deptItemList": [
      {
        "deptItemId": 0,
        "checkItem": "",
        "itemName": "",
        "showFee": "",
        "feeType": "",
        "remark": ""
      }
    ],
    "seq": 0
  },
  "timestamp": 0,
  "traceId": ""
}

3.11.3.待签署产品列表

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 待签署产品列表

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

forManualUpload

boolean

手动上传合同场景

false

-

true

dealName

string

操作人姓名

false

-

dealMobile

string

操作人手机号

false

-

dealEmail

string

操作人邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/unsignedDeptItemList' --data '{
  "deptId": 0,
  "forManualUpload": true,
  "dealName": "",
  "dealMobile": "",
  "dealEmail": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─deptItemId

int64

授权记录id

-

0

└─checkItem

string

产品编码

-

└─itemName

string

产品名称

-

└─showFee

string

展示单价

-

└─feeType

string

计费方式,查得计费、查询计费

-

└─remark

string

备注

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deptItemId": 0,
      "checkItem": "",
      "itemName": "",
      "showFee": "",
      "feeType": "",
      "remark": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.11.4.预提交合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 预提交合同

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

组织id

true

-

0

contractName

string

合同名称

true

-

fillDataList

array

数据填充内容

true

-

└─key

object

No comments found.

false

-

└─value

object

No comments found.

false

-

deptItemList

array

产品列表

false

-

└─deptItemId

int64

授权记录id

true

-

0

└─checkItem

string

产品编码

true

-

└─itemName

string

产品名称

true

-

└─showFee

string

展示单价

true

-

└─feeType

string

计费方式,查得计费、查询计费

true

-

└─remark

string

备注

false

-

seq

int32

签署版次

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/preSubmit' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "contractName": "",
  "fillDataList": [
    {
      "key": {
        "key": {},
        "value": {}
      },
      "value": {
        "key": {},
        "value": {}
      }
    }
  ],
  "deptItemList": [
    {
      "deptItemId": 0,
      "checkItem": "",
      "itemName": "",
      "showFee": "",
      "feeType": "",
      "remark": ""
    }
  ],
  "seq": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─contractNo

string

合同编号

-

└─contractName

string

合同名称

-

└─previewUrl

string

预览地址

-

└─mobile

string

签署手机号,页面可修改

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "contractNo": "",
    "contractName": "",
    "previewUrl": "",
    "mobile": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.11.5.提交合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 提交合同

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

组织id

true

-

0

contractNo

string

合同编号

true

-

signerName

string

签署人姓名,signerType=10必传

false

-

signerIdCard

string

签署人身份证号,signerType=10必传

false

-

mobile

string

签署人手机号,必传

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/submit' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "contractNo": "",
  "signerName": "",
  "signerIdCard": "",
  "mobile": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─contractNo

string

合同编号

-

└─contractName

string

合同名称

-

└─signUrl

string

签署地址

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "contractNo": "",
    "contractName": "",
    "signUrl": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.11.6.合同列表

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 合同列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

templateCode

string

合同模板编码

false

-

deptIdList

array

客户id

false

-

"0,0"

stateList

array

状态

false

-

"0,0"

excludeStateList

array

排除的状态

false

-

"0,0"

contractNoList

array

合同编号

false

-

""","""

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "templateCode": "",
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "excludeStateList": [
    0
  ],
  "contractNoList": [
    ""
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

组织id

-

0

     └─deptName

string

组织名称

-

     └─userId

int64

用户id

-

0

     └─contractNo

string

合同编号

-

     └─templateCode

string

合同模板编码

-

     └─contractName

string

合同名称

-

     └─state

int32

状态

-

0

     └─deptItemCount

int32

授权产品数量

-

0

     └─signerMobile

string

签署人手机号

-

     └─contractUrl

string

合同地址

-

     └─version

int32

合同版本

-

0

     └─versionName

string

版本名称

-

     └─submitTime

string

发起时间

-

yyyy-MM-dd HH:mm:ss

     └─signEndTime

string

签署截止时间

-

yyyy-MM-dd HH:mm:ss

     └─finishTime

string

签署完成时间

-

yyyy-MM-dd HH:mm:ss

     └─expireTime

string

合同过期时间

-

yyyy-MM-dd HH:mm:ss

     └─rejectReason

string

拒签原因

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "userId": 0,
        "contractNo": "",
        "templateCode": "",
        "contractName": "",
        "state": 0,
        "deptItemCount": 0,
        "signerMobile": "",
        "contractUrl": "",
        "version": 0,
        "versionName": "",
        "submitTime": "yyyy-MM-dd HH:mm:ss",
        "signEndTime": "yyyy-MM-dd HH:mm:ss",
        "finishTime": "yyyy-MM-dd HH:mm:ss",
        "expireTime": "yyyy-MM-dd HH:mm:ss",
        "rejectReason": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.11.7.重新发送签署短信

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 重新发送签署短信

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/resendSms' --data '{
  "contractNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.11.8.撤销合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 撤销合同

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/withdraw' --data '{
  "contractNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.11.9.删除合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 删除合同

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/delete' --data '{
  "contractNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.11.10.查询手动上传次序

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 查询手动上传次序

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

forManualUpload

boolean

手动上传合同场景

false

-

true

dealName

string

操作人姓名

false

-

dealMobile

string

操作人手机号

false

-

dealEmail

string

操作人邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/queryManualSeq' --data '{
  "deptId": 0,
  "forManualUpload": true,
  "dealName": "",
  "dealMobile": "",
  "dealEmail": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

int32

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": 0,
  "timestamp": 0,
  "traceId": ""
}

3.11.11.手动上传合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 手动上传合同

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

templateCode

string

合同编码

true

-

contractUrl

string

合同链接

false

-

deptItemList

array

产品列表

false

-

└─deptItemId

int64

授权记录id

true

-

0

└─checkItem

string

产品编码

true

-

└─itemName

string

产品名称

true

-

└─showFee

string

展示单价

true

-

└─feeType

string

计费方式,查得计费、查询计费

true

-

└─remark

string

备注

false

-

seq

int32

签署版次,合作协议传0

true

-

0

finishTime

string

签署时间

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/manualUpload' --data '{
  "deptId": 0,
  "templateCode": "",
  "contractUrl": "",
  "deptItemList": [
    {
      "deptItemId": 0,
      "checkItem": "",
      "itemName": "",
      "showFee": "",
      "feeType": "",
      "remark": ""
    }
  ],
  "seq": 0,
  "finishTime": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.11.12.自动续签

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 自动续签

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/renewal' --data '{
  "contractNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.11.13.修改有效期截止日期

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 修改有效期截止日期

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

expireDate

string

过期日期

true

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/deptContract/editExpireTime' --data '{
  "contractNo": "",
  "expireDate": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.12.模型管理

3.12.1.解析匹配样本文件

Type: POST

Author: wangqidong created on 2025/3/14

Content-Type: multipart/form-data

Description: 解析匹配样本文件

Body-parameters:

Parameter Type Description Required Since Example

file

file

No comments found.

true

-

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/mt/crm/model/parseMatchFile'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─fileName

string

样本名称

-

└─fileUrl

string

文件链接

-

└─matchColumns

object

匹配列结果

-

     └─mapKey

string

A map key.

-

└─headers

array

标题

-

""","""

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{"code":0,"msg":"","data":{"fileName":"","fileUrl":"","matchColumns":{"mapKey1":"","mapKey2":""}"headers":[""]},"timestamp":0,"traceId":""}

3.12.2.执行匹配

Type: POST

Author: wangqidong created on 2025/3/14

Content-Type: application/json

Description: 执行匹配

Body-parameters:

Parameter Type Description Required Since Example

fileName

string

文件名

true

-

fileUrl

string

文件链接

true

-

matchColumns

object

匹配列结果(只传递参与匹配的列即可)

false

-

└─mapKey

string

A map key.

false

-

modelCode

string

匹配模型编码

true

-

note

string

版本

false

-

deptIdList

array

匹配客户

false

-

"0,0"

appcode

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/model/executeMatch' --data '{"fileName":"","fileUrl":"","matchColumns":{"mapKey1":"","mapKey2":""}"modelCode":"","note":"","deptIdList":[0],"appcode":""}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─isAsync

boolean

是否异步

-

true

└─resultUrl

string

同步结果

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "isAsync": true,
    "resultUrl": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.12.3.匹配记录

Type: POST

Author: wangqidong created on 2025/3/14

Content-Type: application/json

Description: 匹配记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

modelCode

string

匹配模型编码

false

-

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/model/matchRecords' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "modelCode": "",
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─modelCode

string

匹配模型编码

-

     └─modelName

string

匹配模型编码

-

     └─note

string

备注(版本)

-

     └─deptNameList

array

匹配客户名

-

""","""

     └─fileName

string

文件名

-

     └─fileUrl

string

文件地址

-

     └─state

int32

状态,10-进行中,20-已完成

-

0

     └─resultUrl

string

匹配结果地址

-

     └─matchCount

int32

命中数量

-

0

     └─finishTime

string

完成时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "modelCode": "",
        "modelName": "",
        "note": "",
        "deptNameList": [
          ""
        ],
        "fileName": "",
        "fileUrl": "",
        "state": 0,
        "resultUrl": "",
        "matchCount": 0,
        "finishTime": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.12.4.解析回溯样本文件

Type: POST

Author: wangqidong created on 2025/3/14

Content-Type: multipart/form-data

Description: 解析回溯样本文件

Body-parameters:

Parameter Type Description Required Since Example

file

file

No comments found.

true

-

Request-example:

curl -X POST -H "Content-Type: multipart/form-data" -F 'file=' -i '/mt/crm/model/parseBackFile'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─backName

string

样本名称

-

└─fileUrl

string

文件链接

-

└─fixColumns

object

固定列

-

     └─mapKey

string

A map key.

-

└─resultColumns

array

结果列名

-

""","""

└─allColumns

array

所有列

-

""","""

└─count

int32

样本数量

-

0

└─isRepeat

boolean

是否重复上传

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{"code":0,"msg":"","data":{"backName":"","fileUrl":"","fixColumns":{"mapKey1":"","mapKey2":""}"resultColumns":[""],"allColumns":[""],"count":0,"isRepeat":true},"timestamp":0,"traceId":""}

3.12.5.上传回溯样本结果

Type: POST

Author: wangqidong created on 2025/3/14

Content-Type: application/json

Description: 上传回溯样本结果

Body-parameters:

Parameter Type Description Required Since Example

backName

string

样本名称

false

-

fileUrl

string

文件链接

false

-

fixColumns

object

固定列

false

-

└─mapKey

string

A map key.

false

-

resultColumns

array

结果列

false

-

└─columnName

string

列名

false

-

└─modelCode

string

模型编码

false

-

└─note

string

备注

false

-

isCover

boolean

是否覆盖

false

-

true

appcode

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/model/uploadBackResult' --data '{"backName":"","fileUrl":"","fixColumns":{"mapKey1":"","mapKey2":""}"resultColumns":[{"columnName":"","modelCode":"","note":""}],"isCover":true,"appcode":""}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

int32

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": 0,
  "timestamp": 0,
  "traceId": ""
}

3.12.6.回溯批次列表

Type: POST

Author: wangqidong created on 2025/3/14

Content-Type: application/json

Description: 回溯批次列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

backNameLike

string

样本名称(模糊匹配)

false

-

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/model/batchList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "backNameLike": "",
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─backName

string

回溯样本名称

-

     └─models

string

模型,多个逗号分割

-

     └─batchCount

int32

批次数量

-

0

     └─fileUrl

string

样本文件地址

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "backName": "",
        "models": "",
        "batchCount": 0,
        "fileUrl": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.13.调用管理

3.13.1.health

Type: GET

Author: wangqidong created on 2024/11/22

Content-Type: application/x-www-form-urlencoded

Description: 

Request-example:

curl -X GET -i '/mt/crm/api/health'

Response-example:

string

3.13.2.补偿

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 补偿

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

用户id

false

-

0

seqNos

array

No comments found.

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/retryDexMock' --data '{
  "userId": 0,
  "seqNos": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.13.3.同步历史大数据报告模板

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 同步历史大数据报告模板

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

No comments found.

false

-

0

templateIds

array

No comments found.

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/historyRsTemplateSync' --data '{
  "userId": 0,
  "templateIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.13.4.调用记录

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 调用记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

查询关键字

false

-

idCard

string

身份证号

false

-

deptIdList

array

客户id

false

-

"0,0"

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

itemCodeList

array

产品编码

false

-

""","""

isFee

int32

是否计费

false

-

0

success

int32

是否成功

false

-

0

cacheFlag

int32

是否为缓存数据 0否 1是

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/recordList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "idCard": "",
  "deptIdList": [
    0
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss",
  "itemCodeList": [
    ""
  ],
  "isFee": 0,
  "success": 0,
  "cacheFlag": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─deptName

string

客户名称

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标识

-

     └─tradeNo

string

交易单号

-

     └─seqNo

string

流水号

-

     └─appId

string

机构appId

-

     └─deptId

int64

机构id

-

0

     └─result

string

检测结果

-

     └─isFee

int32

是否计费

-

0

     └─isFeeDesc

string

是否计费

-

     └─fee

number

产生费用

-

0

     └─success

int32

是否成功

-

0

     └─resultMsg

string

数据源返回信息

-

     └─resultCode

int32

数据源返回code

-

0

     └─cacheFlag

int32

是否为缓存数据 0实时数据 1缓存数据

-

0

     └─name

string

客户名称

-

     └─idCard

string

身份证

-

     └─mobile

string

手机号码

-

     └─sign

string

签名

-

     └─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

     └─phoneRegion

string

号码归属地

-

     └─finalSource

string

请求数据源

-

     └─time

string

耗时 单位:ms

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─requestIp

string

请求ip

-

     └─upstreamRecordList

array

上游调用明细

-

          └─id

int64

主键

-

0

          └─seqNo

string

调用链流水号

-

          └─dataSourceCode

string

数据源编码

-

          └─dataSourceName

string

数据源编码

-

          └─thirdSeqNo

string

第三方流水号

-

          └─reqParam

string

调用参数

-

          └─response

string

返回结果

-

          └─url

string

调用地址

-

          └─time

int32

耗时 :s

-

0

          └─stack

string

异常栈

-

          └─item

string

产品编码

-

          └─extra

string

附加信息

-

          └─outerName

string

外部源名称

-

          └─isFee

int32

是否计费 0不计费 1计费

-

0

          └─outerType

int32

外部源代号

-

0

          └─deptName

string

机构名称

-

          └─appId

string

机构名称

-

          └─tag

string

标记

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─extend

string

附加信息

-

     └─orgCode

string

组织编码

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptName": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "tradeNo": "",
        "seqNo": "",
        "appId": "",
        "deptId": 0,
        "result": "",
        "isFee": 0,
        "isFeeDesc": "",
        "fee": 0,
        "success": 0,
        "resultMsg": "",
        "resultCode": 0,
        "cacheFlag": 0,
        "name": "",
        "idCard": "",
        "mobile": "",
        "sign": "",
        "encryptionType": "",
        "phoneRegion": "",
        "finalSource": "",
        "time": "",
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "requestIp": "",
        "upstreamRecordList": [
          {
            "id": 0,
            "seqNo": "",
            "dataSourceCode": "",
            "dataSourceName": "",
            "thirdSeqNo": "",
            "reqParam": "",
            "response": "",
            "url": "",
            "time": 0,
            "stack": "",
            "item": "",
            "extra": "",
            "outerName": "",
            "isFee": 0,
            "outerType": 0,
            "deptName": "",
            "appId": "",
            "tag": "",
            "createDate": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "extend": "",
        "orgCode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.13.5.导出调用记录

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 导出调用记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

查询关键字

false

-

idCard

string

身份证号

false

-

deptIdList

array

客户id

false

-

"0,0"

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

itemCodeList

array

产品编码

false

-

""","""

isFee

int32

是否计费

false

-

0

success

int32

是否成功

false

-

0

cacheFlag

int32

是否为缓存数据 0否 1是

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/recordExport' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "idCard": "",
  "deptIdList": [
    0
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss",
  "itemCodeList": [
    ""
  ],
  "isFee": 0,
  "success": 0,
  "cacheFlag": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.13.6.调用明细

Type: GET

Author: wangqidong created on 2024/11/22

Content-Type: application/x-www-form-urlencoded

Description: 调用明细

Path-parameters:

Parameter Type Description Required Since Example

seqNo

string

流水号

true

-

Request-example:

curl -X GET -i '/mt/crm/api/recordDetail/{seqNo}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─deptName

string

客户名称

-

└─checkItem

string

检测项

-

└─checkItemName

string

检测项名称

-

└─tag

string

标识

-

└─tradeNo

string

交易单号

-

└─seqNo

string

流水号

-

└─appId

string

机构appId

-

└─deptId

int64

机构id

-

0

└─result

string

检测结果

-

└─isFee

int32

是否计费

-

0

└─isFeeDesc

string

是否计费

-

└─fee

number

产生费用

-

0

└─success

int32

是否成功

-

0

└─resultMsg

string

数据源返回信息

-

└─resultCode

int32

数据源返回code

-

0

└─cacheFlag

int32

是否为缓存数据 0实时数据 1缓存数据

-

0

└─name

string

客户名称

-

└─idCard

string

身份证

-

└─mobile

string

手机号码

-

└─sign

string

签名

-

└─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

└─phoneRegion

string

号码归属地

-

└─finalSource

string

请求数据源

-

└─time

string

耗时 单位:ms

-

└─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─requestIp

string

请求ip

-

└─upstreamRecordList

array

上游调用明细

-

     └─id

int64

主键

-

0

     └─seqNo

string

调用链流水号

-

     └─dataSourceCode

string

数据源编码

-

     └─dataSourceName

string

数据源编码

-

     └─thirdSeqNo

string

第三方流水号

-

     └─reqParam

string

调用参数

-

     └─response

string

返回结果

-

     └─url

string

调用地址

-

     └─time

int32

耗时 :s

-

0

     └─stack

string

异常栈

-

     └─item

string

产品编码

-

     └─extra

string

附加信息

-

     └─outerName

string

外部源名称

-

     └─isFee

int32

是否计费 0不计费 1计费

-

0

     └─outerType

int32

外部源代号

-

0

     └─deptName

string

机构名称

-

     └─appId

string

机构名称

-

     └─tag

string

标记

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─extend

string

附加信息

-

└─orgCode

string

组织编码

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "deptName": "",
    "checkItem": "",
    "checkItemName": "",
    "tag": "",
    "tradeNo": "",
    "seqNo": "",
    "appId": "",
    "deptId": 0,
    "result": "",
    "isFee": 0,
    "isFeeDesc": "",
    "fee": 0,
    "success": 0,
    "resultMsg": "",
    "resultCode": 0,
    "cacheFlag": 0,
    "name": "",
    "idCard": "",
    "mobile": "",
    "sign": "",
    "encryptionType": "",
    "phoneRegion": "",
    "finalSource": "",
    "time": "",
    "createDate": "yyyy-MM-dd HH:mm:ss",
    "requestIp": "",
    "upstreamRecordList": [
      {
        "id": 0,
        "seqNo": "",
        "dataSourceCode": "",
        "dataSourceName": "",
        "thirdSeqNo": "",
        "reqParam": "",
        "response": "",
        "url": "",
        "time": 0,
        "stack": "",
        "item": "",
        "extra": "",
        "outerName": "",
        "isFee": 0,
        "outerType": 0,
        "deptName": "",
        "appId": "",
        "tag": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "extend": "",
    "orgCode": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.13.7.缓存列表

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 缓存列表

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

产品编码

false

-

name

string

姓名

false

-

idCard

string

身份证

false

-

mobile

string

手机号

false

-

encryptionType

int32

加密类型,2:md5,3:sha256,默认md5

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/cacheList' --data '{
  "checkItem": "",
  "name": "",
  "idCard": "",
  "mobile": "",
  "encryptionType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─checkItem

string

产品编码

-

└─itemName

string

产品名

-

└─cacheKey

string

缓存key

-

└─cacheValue

string

缓存值(详情接口返回)

-

└─cacheApiRecord

object

apiRecord

-

     └─id

int64

主键

-

0

     └─deptName

string

客户名称

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标识

-

     └─tradeNo

string

交易单号

-

     └─seqNo

string

流水号

-

     └─appId

string

机构appId

-

     └─deptId

int64

机构id

-

0

     └─result

string

检测结果

-

     └─isFee

int32

是否计费

-

0

     └─isFeeDesc

string

是否计费

-

     └─fee

number

产生费用

-

0

     └─success

int32

是否成功

-

0

     └─resultMsg

string

数据源返回信息

-

     └─resultCode

int32

数据源返回code

-

0

     └─cacheFlag

int32

是否为缓存数据 0实时数据 1缓存数据

-

0

     └─name

string

客户名称

-

     └─idCard

string

身份证

-

     └─mobile

string

手机号码

-

     └─sign

string

签名

-

     └─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

     └─phoneRegion

string

号码归属地

-

     └─finalSource

string

请求数据源

-

     └─time

string

耗时 单位:ms

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─requestIp

string

请求ip

-

     └─upstreamRecordList

array

上游调用明细

-

          └─id

int64

主键

-

0

          └─seqNo

string

调用链流水号

-

          └─dataSourceCode

string

数据源编码

-

          └─dataSourceName

string

数据源编码

-

          └─thirdSeqNo

string

第三方流水号

-

          └─reqParam

string

调用参数

-

          └─response

string

返回结果

-

          └─url

string

调用地址

-

          └─time

int32

耗时 :s

-

0

          └─stack

string

异常栈

-

          └─item

string

产品编码

-

          └─extra

string

附加信息

-

          └─outerName

string

外部源名称

-

          └─isFee

int32

是否计费 0不计费 1计费

-

0

          └─outerType

int32

外部源代号

-

0

          └─deptName

string

机构名称

-

          └─appId

string

机构名称

-

          └─tag

string

标记

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─extend

string

附加信息

-

     └─orgCode

string

组织编码

-

└─expireSeconds

int64

剩余时间(秒)

-

0

└─expireSecondsDesc

string

剩余时间(秒)

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "checkItem": "",
      "itemName": "",
      "cacheKey": "",
      "cacheValue": "",
      "cacheApiRecord": {
        "id": 0,
        "deptName": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "tradeNo": "",
        "seqNo": "",
        "appId": "",
        "deptId": 0,
        "result": "",
        "isFee": 0,
        "isFeeDesc": "",
        "fee": 0,
        "success": 0,
        "resultMsg": "",
        "resultCode": 0,
        "cacheFlag": 0,
        "name": "",
        "idCard": "",
        "mobile": "",
        "sign": "",
        "encryptionType": "",
        "phoneRegion": "",
        "finalSource": "",
        "time": "",
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "requestIp": "",
        "upstreamRecordList": [
          {
            "id": 0,
            "seqNo": "",
            "dataSourceCode": "",
            "dataSourceName": "",
            "thirdSeqNo": "",
            "reqParam": "",
            "response": "",
            "url": "",
            "time": 0,
            "stack": "",
            "item": "",
            "extra": "",
            "outerName": "",
            "isFee": 0,
            "outerType": 0,
            "deptName": "",
            "appId": "",
            "tag": "",
            "createDate": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "extend": "",
        "orgCode": ""
      },
      "expireSeconds": 0,
      "expireSecondsDesc": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

3.13.8.缓存详情

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 缓存详情

Body-parameters:

Parameter Type Description Required Since Example

cacheKey

string

缓存key

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/cacheDetail' --data '{
  "cacheKey": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─checkItem

string

产品编码

-

└─itemName

string

产品名

-

└─cacheKey

string

缓存key

-

└─cacheValue

string

缓存值(详情接口返回)

-

└─cacheApiRecord

object

apiRecord

-

     └─id

int64

主键

-

0

     └─deptName

string

客户名称

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标识

-

     └─tradeNo

string

交易单号

-

     └─seqNo

string

流水号

-

     └─appId

string

机构appId

-

     └─deptId

int64

机构id

-

0

     └─result

string

检测结果

-

     └─isFee

int32

是否计费

-

0

     └─isFeeDesc

string

是否计费

-

     └─fee

number

产生费用

-

0

     └─success

int32

是否成功

-

0

     └─resultMsg

string

数据源返回信息

-

     └─resultCode

int32

数据源返回code

-

0

     └─cacheFlag

int32

是否为缓存数据 0实时数据 1缓存数据

-

0

     └─name

string

客户名称

-

     └─idCard

string

身份证

-

     └─mobile

string

手机号码

-

     └─sign

string

签名

-

     └─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

     └─phoneRegion

string

号码归属地

-

     └─finalSource

string

请求数据源

-

     └─time

string

耗时 单位:ms

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─requestIp

string

请求ip

-

     └─upstreamRecordList

array

上游调用明细

-

          └─id

int64

主键

-

0

          └─seqNo

string

调用链流水号

-

          └─dataSourceCode

string

数据源编码

-

          └─dataSourceName

string

数据源编码

-

          └─thirdSeqNo

string

第三方流水号

-

          └─reqParam

string

调用参数

-

          └─response

string

返回结果

-

          └─url

string

调用地址

-

          └─time

int32

耗时 :s

-

0

          └─stack

string

异常栈

-

          └─item

string

产品编码

-

          └─extra

string

附加信息

-

          └─outerName

string

外部源名称

-

          └─isFee

int32

是否计费 0不计费 1计费

-

0

          └─outerType

int32

外部源代号

-

0

          └─deptName

string

机构名称

-

          └─appId

string

机构名称

-

          └─tag

string

标记

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─extend

string

附加信息

-

     └─orgCode

string

组织编码

-

└─expireSeconds

int64

剩余时间(秒)

-

0

└─expireSecondsDesc

string

剩余时间(秒)

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "checkItem": "",
    "itemName": "",
    "cacheKey": "",
    "cacheValue": "",
    "cacheApiRecord": {
      "id": 0,
      "deptName": "",
      "checkItem": "",
      "checkItemName": "",
      "tag": "",
      "tradeNo": "",
      "seqNo": "",
      "appId": "",
      "deptId": 0,
      "result": "",
      "isFee": 0,
      "isFeeDesc": "",
      "fee": 0,
      "success": 0,
      "resultMsg": "",
      "resultCode": 0,
      "cacheFlag": 0,
      "name": "",
      "idCard": "",
      "mobile": "",
      "sign": "",
      "encryptionType": "",
      "phoneRegion": "",
      "finalSource": "",
      "time": "",
      "createDate": "yyyy-MM-dd HH:mm:ss",
      "requestIp": "",
      "upstreamRecordList": [
        {
          "id": 0,
          "seqNo": "",
          "dataSourceCode": "",
          "dataSourceName": "",
          "thirdSeqNo": "",
          "reqParam": "",
          "response": "",
          "url": "",
          "time": 0,
          "stack": "",
          "item": "",
          "extra": "",
          "outerName": "",
          "isFee": 0,
          "outerType": 0,
          "deptName": "",
          "appId": "",
          "tag": "",
          "createDate": "yyyy-MM-dd HH:mm:ss"
        }
      ],
      "extend": "",
      "orgCode": ""
    },
    "expireSeconds": 0,
    "expireSecondsDesc": ""
  },
  "timestamp": 0,
  "traceId": ""
}

3.13.9.编辑apiRecord

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 编辑apiRecord

Body-parameters:

Parameter Type Description Required Since Example

seqNo

string

流水号

true

-

result

string

检测结果

false

-

isFee

int32

是否计费

false

-

0

fee

number

产生费用

false

-

0

success

int32

是否成功

false

-

0

resultMsg

string

数据源返回信息

false

-

resultCode

int32

数据源返回code

false

-

0

tag

string

标识

false

-

extend

string

拓展字段

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/editApiRecord' --data '{
  "seqNo": "",
  "result": "",
  "isFee": 0,
  "fee": 0,
  "success": 0,
  "resultMsg": "",
  "resultCode": 0,
  "tag": "",
  "extend": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.13.10.删除缓存

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 删除缓存

Body-parameters:

Parameter Type Description Required Since Example

cacheKey

string

缓存key

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/deleteCache' --data '{
  "cacheKey": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.13.11.新增缓存

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 新增缓存

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

产品编码

true

-

name

string

姓名

false

-

idCard

string

身份证

false

-

mobile

string

手机号

false

-

scene

string

场景编码

false

-

expireSeconds

int64

过期时间(秒)

true

-

0

encryptionType

int32

加密类型,2:md5,3:sha256,默认md5

true

-

0

cacheValue

string

缓存值

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/addCache' --data '{
  "checkItem": "",
  "name": "",
  "idCard": "",
  "mobile": "",
  "scene": "",
  "expireSeconds": 0,
  "encryptionType": 0,
  "cacheValue": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.13.12.编辑缓存

Type: POST

Author: wangqidong created on 2024/11/22

Content-Type: application/json

Description: 编辑缓存

Body-parameters:

Parameter Type Description Required Since Example

cacheKey

string

缓存key

true

-

expireSeconds

int64

过期时间(秒)

false

-

0

cacheValue

string

缓存值,为空代表编辑过期时间

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/api/editCache' --data '{
  "cacheKey": "",
  "expireSeconds": 0,
  "cacheValue": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.14.计划任务

3.14.1.调价任务列表

Type: POST

Author: wangqidong created on 2025/3/26

Content-Type: application/json

Description: 调价任务列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

taskKey

string

任务标识

false

-

deptIdList

array

客户id

false

-

"0,0"

stateList

array

状态,-1:已取消,0:未执行,10:执行中,20:已执行

false

-

"0,0"

checkItem

string

产品编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/schedule/adjustTaskList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "taskKey": "",
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "checkItem": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─taskKey

string

任务标识

-

     └─bizKey

string

业务关键属性

-

     └─state

int32

状态,-1:已取消,0:未执行,10:执行中,20:已执行

-

0

     └─scheduleTime

string

计划执行时间

-

yyyy-MM-dd HH:mm:ss

     └─taskDetail

array

任务明细

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─finishTime

string

完成时间

-

yyyy-MM-dd HH:mm:ss

     └─errorMsg

string

错误描述

-

     └─costMills

int64

执行耗时,单位:毫秒

-

0

     └─executeCount

int32

执行次数

-

0

     └─deptName

string

No comments found.

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "taskKey": "",
        "bizKey": "",
        "state": 0,
        "scheduleTime": "yyyy-MM-dd HH:mm:ss",
        "taskDetail": [
          {
            "id": 0,
            "createDate": "yyyy-MM-dd HH:mm:ss",
            "updateDate": "yyyy-MM-dd HH:mm:ss",
            "deptId": 0,
            "deptName": "",
            "deptItemId": 0,
            "checkItem": "",
            "itemName": "",
            "state": 0,
            "beforeFee": 0,
            "beforeFeeDetail": "",
            "beforeChargeType": 0,
            "beforeFeeType": 0,
            "afterFee": 0,
            "afterFeeDetail": "",
            "afterChargeType": 0,
            "afterFeeType": 0,
            "planTime": "yyyy-MM-dd HH:mm:ss",
            "effectTime": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "finishTime": "yyyy-MM-dd HH:mm:ss",
        "errorMsg": "",
        "costMills": 0,
        "executeCount": 0,
        "deptName": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.14.2.产品变更记录列表

Type: POST

Author: wangqidong created on 2025/3/26

Content-Type: application/json

Description: 产品变更记录列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

taskKey

string

任务标识

false

-

deptIdList

array

客户id

false

-

"0,0"

stateList

array

状态,-1:已取消,0:未执行,10:执行中,20:已执行

false

-

"0,0"

checkItem

string

产品编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/schedule/changeCheckItemTaskList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "taskKey": "",
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "checkItem": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─taskKey

string

任务标识

-

     └─bizKey

string

业务关键属性

-

     └─state

int32

状态,-1:已取消,0:未执行,10:执行中,20:已执行

-

0

     └─scheduleTime

string

计划执行时间

-

yyyy-MM-dd HH:mm:ss

     └─taskDetail

object

任务明细

-

          └─id

int64

产品id

-

0

          └─checkItem

string

检测项编码

-

          └─itemName

string

检测项名称

-

          └─toState

enum

变更类型,-1:下架,10:上架(恢复正常),5:异常

-

DOWN

          └─noticeScope

int32

通知范围,0:不发送,10:自定义,20:所有

-

0

          └─noticeMethods

array

通知方式

-

""","""

          └─noticeCustomers

array

指定通知客户列表

-

               └─deptId

int64

组织id

-

0

               └─userId

int64

No comments found.

-

0

               └─deptName

string

No comments found.

-

               └─mobile

string

通知手机号

-

               └─email

string

通知邮箱

-

     └─finishTime

string

完成时间

-

yyyy-MM-dd HH:mm:ss

     └─errorMsg

string

错误描述

-

     └─costMills

int64

执行耗时,单位:毫秒

-

0

     └─executeCount

int32

执行次数

-

0

     └─deptName

string

No comments found.

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "taskKey": "",
        "bizKey": "",
        "state": 0,
        "scheduleTime": "yyyy-MM-dd HH:mm:ss",
        "taskDetail": {
          "id": 0,
          "checkItem": "",
          "itemName": "",
          "toState": 0,
          "noticeScope": 0,
          "noticeMethods": [
            ""
          ],
          "noticeCustomers": [
            {
              "deptId": 0,
              "userId": 0,
              "deptName": "",
              "mobile": "",
              "email": ""
            }
          ]
        },
        "finishTime": "yyyy-MM-dd HH:mm:ss",
        "errorMsg": "",
        "costMills": 0,
        "executeCount": 0,
        "deptName": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

3.14.3.取消执行

Type: POST

Author: wangqidong created on 2025/3/26

Content-Type: application/json

Description: 取消执行

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/schedule/cancel' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

3.14.4.重试

Type: POST

Author: wangqidong created on 2025/3/26

Content-Type: application/json

Description: 重试

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/crm/schedule/retry' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.业务平台

4.1.数据调用相关

4.1.1.产品列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

checkItemList

array

产品编码列表

false

-

""","""

excludeCheckItemList

array

排除的产品编码列表

false

-

""","""

excludeDeptId

int64

排除用户拥有的产品

false

-

0

compareDeptId

int64

用于判断该用户有没有授权产品

false

-

0

isFusion

boolean

是否聚合产品

false

-

true

state

int32

状态,-1:已下架,10:已上架,5:异常

false

-

0

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/checkItem/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "applicable": true,
  "checkItemList": [
    ""
  ],
  "excludeCheckItemList": [
    ""
  ],
  "excludeDeptId": 0,
  "compareDeptId": 0,
  "isFusion": true,
  "state": 0,
  "checkType": 0,
  "cacheFlag": 0,
  "feeType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─cacheFlag

int32

是否启用缓存

-

0

     └─cacheTime

int32

缓存天数

-

0

     └─state

int32

状态,-1:已下架,10:已上架,5:异常

-

0

     └─checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

-

0

     └─isOpen

int32

是否启用

-

0

     └─riskThreshold

number

风险阈值

-

0

     └─price

number

单价

-

0

     └─floorPrice

number

销售底价

-

0

     └─applicable

boolean

是否可以在线申请

-

true

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─feeType

int32

计费方式,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─subItems

string

聚合产品默认子项

-

     └─subItemList

array

聚合产品默认子项,详情才会返回

-

     └─isAccredit

boolean

当前用户是否已授权

-

true

     └─maxFreeCount

int32

销售默认分配免费次数上限

-

0

     └─encryptable

string

No comments found.

-

     └─encryptableList

array

支持的加密方式

-

"0,0"

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "checkItem": "",
        "itemName": "",
        "cacheFlag": 0,
        "cacheTime": 0,
        "state": 0,
        "checkType": 0,
        "isOpen": 0,
        "riskThreshold": 0,
        "price": 0,
        "floorPrice": 0,
        "applicable": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "feeType": 0,
        "isFusion": true,
        "subItems": "",
        "subItemList": [
          {
            "$ref": ".."
          }
        ],
        "isAccredit": true,
        "maxFreeCount": 0,
        "encryptable": "",
        "encryptableList": [
          0
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.1.2.产品导出

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 产品导出

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

checkItemList

array

产品编码列表

false

-

""","""

excludeCheckItemList

array

排除的产品编码列表

false

-

""","""

excludeDeptId

int64

排除用户拥有的产品

false

-

0

compareDeptId

int64

用于判断该用户有没有授权产品

false

-

0

isFusion

boolean

是否聚合产品

false

-

true

state

int32

状态,-1:已下架,10:已上架,5:异常

false

-

0

checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

false

-

0

cacheFlag

int32

是否启用缓存

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/checkItem/export' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "applicable": true,
  "checkItemList": [
    ""
  ],
  "excludeCheckItemList": [
    ""
  ],
  "excludeDeptId": 0,
  "compareDeptId": 0,
  "isFusion": true,
  "state": 0,
  "checkType": 0,
  "cacheFlag": 0,
  "feeType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.3.授权产品列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 授权产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptIdList

array

组织id

true

-

"0,0"

keyword

string

关键字

false

-

checkItemList

array

产品编码列表

false

-

""","""

stateList

array

状态列表

false

-

"0,0"

fusionDeptItemId

int64

聚合产品授权记录id

false

-

0

idList

array

指定deptItemId

false

-

"0,0"

queryAdjusting

boolean

是否查询调整中记录

false

-

true

isFusion

boolean

是否是聚合产品

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptIdList": [
    0
  ],
  "keyword": "",
  "checkItemList": [
    ""
  ],
  "stateList": [
    0
  ],
  "fusionDeptItemId": 0,
  "idList": [
    0
  ],
  "queryAdjusting": true,
  "isFusion": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.1.4.导出授权产品列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 导出授权产品列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

checkItemList

array

产品编码列表

false

-

""","""

stateList

array

状态列表

false

-

"0,0"

applicable

boolean

是否仅查询可在线申请的产品

false

-

true

categoryCode

string

分类

false

-

taskType

int32

是否可在线测试,10-单笔测试,20-批量测试

false

-

0

merchantId

int64

商户id

false

-

0

deptIdList

array

组织id

false

-

"0,0"

fusionDeptItemId

int64

聚合产品授权记录id

false

-

0

idList

array

指定deptItemId

false

-

"0,0"

queryAdjusting

boolean

是否查询调整中记录

false

-

true

contractStateList

array

合同签署状态

false

-

"0,0"

isFusion

boolean

是否是聚合产品

false

-

true

crmQuery

boolean

No comments found.

false

-

true

querySpreader

boolean

查询推广员信息

false

-

true

matchSpreaderMonth

string

No comments found.

false

-

spreaderId

int64

推广方id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/export' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "checkItemList": [
    ""
  ],
  "stateList": [
    0
  ],
  "applicable": true,
  "categoryCode": "",
  "taskType": 0,
  "merchantId": 0,
  "deptIdList": [
    0
  ],
  "fusionDeptItemId": 0,
  "idList": [
    0
  ],
  "queryAdjusting": true,
  "contractStateList": [
    0
  ],
  "isFusion": true,
  "crmQuery": true,
  "querySpreader": true,
  "matchSpreaderMonth": "",
  "spreaderId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.5.新增授权产品

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 新增授权产品

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

true

-

0

checkItemList

array

申请开通的产品

true

-

└─deptId

int64

开发账户id

false

-

0

└─itemCode

string

产品编码,不可修改

true

-

└─itemName

string

产品名称,不可修改

false

-

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─feeDetail

string

费用明细

false

-

└─fee

number

费用

false

-

0

└─freeCount

int32

免费次数

false

-

0

└─applyRemark

string

申请备注

false

-

└─orgCode

string

组织编码

false

-

└─riskThreshold

number

风险阈值

false

-

0

└─usedVersion

string

开通版本

false

-

└─isHidden

boolean

是否隐藏

false

-

true

└─spreaderRoyalties

array

外部销售提成配置

false

-

     └─spreaderId

int64

推广员id

true

-

0

     └─royaltyType

string

提成计算方式

true

-

     └─royaltyPrice

number

单笔提成金额

false

-

0

     └─royaltyRate

number

提成比例,0-1

false

-

0

     └─effectMonth

string

生效月份

false

-

applyRemark

string

申请备注

false

-

fusionDeptItemId

int64

聚合产品授权记录id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/accredit' --data '{
  "deptId": 0,
  "checkItemList": [
    {
      "deptId": 0,
      "itemCode": "",
      "itemName": "",
      "chargeType": 0,
      "feeType": 0,
      "feeDetail": "",
      "fee": 0,
      "freeCount": 0,
      "applyRemark": "",
      "orgCode": "",
      "riskThreshold": 0,
      "usedVersion": "",
      "isHidden": true,
      "spreaderRoyalties": [
        {
          "spreaderId": 0,
          "royaltyType": "",
          "royaltyPrice": 0,
          "royaltyRate": 0,
          "effectMonth": ""
        }
      ]
    }
  ],
  "applyRemark": "",
  "fusionDeptItemId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.6.授权聚合产品默认子项查询

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 授权聚合产品默认子项查询

Body-parameters:

Parameter Type Description Required Since Example

checkItem

string

聚合产品编码

true

-

deptId

int64

机构id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/queryItemsForAccreditFusion' --data '{
  "checkItem": "",
  "deptId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─checkItem

string

检测项

-

└─itemName

string

检测项名称

-

└─usedVersion

string

开通版本

-

└─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

└─isOpen

int32

是否启用

-

0

└─price

number

单价

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

└─fee

number

费用

-

0

└─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

└─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

└─isFusion

boolean

是否是聚合产品

-

true

└─feeDetail

string

费用明细

-

└─freeCount

int32

免费次数

-

0

└─applyRemark

string

申请备注

-

└─auditRemark

string

审核备注(驳回原因)

-

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─taskAble

boolean

是否可在线测试

-

true

└─categoryCode

string

分类编码

-

└─categoryName

string

分类编码

-

└─docUrl

string

文档下载地址

-

└─respTime

string

响应时间

-

└─backgroundImg

string

背景图

-

└─description

string

描述

-

└─isCollected

boolean

是否已收藏

-

true

└─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

└─applicable

boolean

是否可以在线申请

-

true

└─cacheFetchDays

int32

取缓存有效天数

-

0

└─isHidden

boolean

是否隐藏

-

true

└─adjusting

object

调整中记录

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构id

-

     └─deptItemId

int64

机构单项费用id

-

0

     └─checkItem

string

检测项

-

     └─itemName

string

检测项

-

     └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

     └─beforeFee

number

变更前费用

-

0

     └─beforeFeeDetail

string

变更前费用明细

-

     └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

     └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

     └─afterFee

number

变更后费用

-

0

     └─afterFeeDetail

string

变更后费用明细

-

     └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

     └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

     └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

     └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

└─orgCode

string

组织编码

-

└─riskThreshold

number

风险阈值

-

0

└─hasAssignSource

boolean

是否指定数据源

-

true

└─spreaderRoyalties

array

推广方提成配置

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─deptId

int64

客户组织id

-

0

     └─spreaderId

int64

当前销售员id

-

0

     └─spreaderName

string

当前销售员名

-

     └─deptItemId

int64

授权记录id

-

0

     └─checkItem

string

产品编码

-

     └─royaltyType

string

提成计算方式

-

     └─royaltyPrice

number

单笔提成金额

-

0

     └─royaltyRate

number

提成比例

-

0

     └─state

enum

是否绑定中

-

INVALID

     └─effectMonth

string

生效月份

-

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "updateDate": "yyyy-MM-dd HH:mm:ss",
      "checkItem": "",
      "itemName": "",
      "usedVersion": "",
      "checkType": 0,
      "isOpen": 0,
      "price": 0,
      "deptId": 0,
      "deptName": "",
      "state": 0,
      "fee": 0,
      "chargeType": 0,
      "feeType": 0,
      "isFusion": true,
      "feeDetail": "",
      "freeCount": 0,
      "applyRemark": "",
      "auditRemark": "",
      "auditTime": "yyyy-MM-dd HH:mm:ss",
      "taskAble": true,
      "categoryCode": "",
      "categoryName": "",
      "docUrl": "",
      "respTime": "",
      "backgroundImg": "",
      "description": "",
      "isCollected": true,
      "createDate": "yyyy-MM-dd HH:mm:ss",
      "applicable": true,
      "cacheFetchDays": 0,
      "isHidden": true,
      "adjusting": {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "deptItemId": 0,
        "checkItem": "",
        "itemName": "",
        "state": 0,
        "beforeFee": 0,
        "beforeFeeDetail": "",
        "beforeChargeType": 0,
        "beforeFeeType": 0,
        "afterFee": 0,
        "afterFeeDetail": "",
        "afterChargeType": 0,
        "afterFeeType": 0,
        "planTime": "yyyy-MM-dd HH:mm:ss",
        "effectTime": "yyyy-MM-dd HH:mm:ss"
      },
      "orgCode": "",
      "riskThreshold": 0,
      "hasAssignSource": true,
      "spreaderRoyalties": [
        {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "customerId": 0,
          "customerName": "",
          "deptId": 0,
          "spreaderId": 0,
          "spreaderName": "",
          "deptItemId": 0,
          "checkItem": "",
          "royaltyType": "",
          "royaltyPrice": 0,
          "royaltyRate": 0,
          "state": 0,
          "effectMonth": "",
          "assignTime": "yyyy-MM-dd HH:mm:ss"
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.1.7.新增授权聚合产品

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 新增授权聚合产品

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发账户id

true

-

0

checkItem

string

聚合产品编码

true

-

chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

feeDetail

string

费用明细

false

-

fee

number

费用

false

-

0

freeCount

int32

免费次数

false

-

0

applyRemark

string

申请备注

false

-

subItemList

array

子项产品列表

true

-

└─deptId

int64

开发账户id

false

-

0

└─itemCode

string

产品编码,不可修改

true

-

└─itemName

string

产品名称,不可修改

false

-

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─feeDetail

string

费用明细

false

-

└─fee

number

费用

false

-

0

└─freeCount

int32

免费次数

false

-

0

└─applyRemark

string

申请备注

false

-

└─orgCode

string

组织编码

false

-

└─riskThreshold

number

风险阈值

false

-

0

└─usedVersion

string

开通版本

false

-

└─isHidden

boolean

是否隐藏

false

-

true

└─spreaderRoyalties

array

外部销售提成配置

false

-

     └─spreaderId

int64

推广员id

true

-

0

     └─royaltyType

string

提成计算方式

true

-

     └─royaltyPrice

number

单笔提成金额

false

-

0

     └─royaltyRate

number

提成比例,0-1

false

-

0

     └─effectMonth

string

生效月份

false

-

└─isAdded

boolean

是否新增授权

true

-

true

spreaderRoyalty

object

外部销售提成配置

false

-

└─spreaderId

int64

推广员id

true

-

0

└─royaltyType

string

提成计算方式

true

-

└─royaltyPrice

number

单笔提成金额

false

-

0

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

生效月份

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/accreditFusion' --data '{
  "deptId": 0,
  "checkItem": "",
  "chargeType": 0,
  "feeType": 0,
  "feeDetail": "",
  "fee": 0,
  "freeCount": 0,
  "applyRemark": "",
  "subItemList": [
    {
      "deptId": 0,
      "itemCode": "",
      "itemName": "",
      "chargeType": 0,
      "feeType": 0,
      "feeDetail": "",
      "fee": 0,
      "freeCount": 0,
      "applyRemark": "",
      "orgCode": "",
      "riskThreshold": 0,
      "usedVersion": "",
      "isHidden": true,
      "spreaderRoyalties": [
        {
          "spreaderId": 0,
          "royaltyType": "",
          "royaltyPrice": 0,
          "royaltyRate": 0,
          "effectMonth": ""
        }
      ],
      "isAdded": true
    }
  ],
  "spreaderRoyalty": {
    "spreaderId": 0,
    "royaltyType": "",
    "royaltyPrice": 0,
    "royaltyRate": 0,
    "effectMonth": ""
  }
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.8.编辑授权产品

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 编辑授权产品

Body-parameters:

Parameter Type Description Required Since Example

itemCode

string

产品编码,不可修改

true

-

itemName

string

产品名称,不可修改

false

-

chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

feeDetail

string

费用明细

false

-

fee

number

费用

false

-

0

freeCount

int32

免费次数

false

-

0

applyRemark

string

申请备注

false

-

orgCode

string

组织编码

false

-

riskThreshold

number

风险阈值

false

-

0

usedVersion

string

开通版本

false

-

isHidden

boolean

是否隐藏

false

-

true

spreaderRoyalties

array

外部销售提成配置

false

-

└─spreaderId

int64

推广员id

true

-

0

└─royaltyType

string

提成计算方式

true

-

└─royaltyPrice

number

单笔提成金额

false

-

0

└─royaltyRate

number

提成比例,0-1

false

-

0

└─effectMonth

string

生效月份

false

-

deptId

int64

机构id

true

-

0

deptItemId

int64

授权产品记录id

true

-

0

isAuditPass

boolean

是否审核通过

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/edit' --data '{
  "itemCode": "",
  "itemName": "",
  "chargeType": 0,
  "feeType": 0,
  "feeDetail": "",
  "fee": 0,
  "freeCount": 0,
  "applyRemark": "",
  "orgCode": "",
  "riskThreshold": 0,
  "usedVersion": "",
  "isHidden": true,
  "spreaderRoyalties": [
    {
      "spreaderId": 0,
      "royaltyType": "",
      "royaltyPrice": 0,
      "royaltyRate": 0,
      "effectMonth": ""
    }
  ],
  "deptId": 0,
  "deptItemId": 0,
  "isAuditPass": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.9.编辑扩展信息

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 编辑扩展信息

Body-parameters:

Parameter Type Description Required Since Example

itemList

array

分配明细

false

-

└─deptItemId

int64

授权产品记录id

true

-

0

└─isHidden

boolean

是否隐藏(开放平台不可见)

false

-

true

└─usedVersion

string

开通版本

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/editExtra' --data '{
  "itemList": [
    {
      "deptItemId": 0,
      "isHidden": true,
      "usedVersion": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.10.编辑客户价格

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 编辑客户价格

Body-parameters:

Parameter Type Description Required Since Example

effectTime

string

生效时间,为空代表立即生效

false

-

yyyy-MM-dd HH:mm:ss

itemList

array

价格明细

true

-

└─deptItemId

int64

授权产品记录id

true

-

0

└─feeType

int32

计费方式,10-查询计费,20-查得计费

false

-

0

└─chargeType

int32

计费类型 10 按实际子项计费 20一口价

false

-

0

└─fee

number

费用

false

-

0

└─feeDetail

string

费用明细

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/adjust' --data '{
  "effectTime": "yyyy-MM-dd HH:mm:ss",
  "itemList": [
    {
      "deptItemId": 0,
      "feeType": 0,
      "chargeType": 0,
      "fee": 0,
      "feeDetail": ""
    }
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.1.11.查询调整记录

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 查询调整记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

组织id

true

-

0

deptItemIdList

array

授权记录id

false

-

"0,0"

stateList

array

状态,-10:已驳回,0:待发起,5:待审核,10:待生效,20:已生效

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/adjustList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "deptItemIdList": [
    0
  ],
  "stateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构id

-

     └─deptItemId

int64

机构单项费用id

-

0

     └─checkItem

string

检测项

-

     └─itemName

string

检测项

-

     └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

     └─beforeFee

number

变更前费用

-

0

     └─beforeFeeDetail

string

变更前费用明细

-

     └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

     └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

     └─afterFee

number

变更后费用

-

0

     └─afterFeeDetail

string

变更后费用明细

-

     └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

     └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

     └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

     └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "deptItemId": 0,
        "checkItem": "",
        "itemName": "",
        "state": 0,
        "beforeFee": 0,
        "beforeFeeDetail": "",
        "beforeChargeType": 0,
        "beforeFeeType": 0,
        "afterFee": 0,
        "afterFeeDetail": "",
        "afterChargeType": 0,
        "afterFeeType": 0,
        "planTime": "yyyy-MM-dd HH:mm:ss",
        "effectTime": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.1.12.上游配置列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 上游配置列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

checkItem

string

产品编码,产品编码和数据源编码不能都为空

false

-

dataSourceId

int64

数据源id,产品编码和数据源编码不能都为空

false

-

0

excludeSourceIdList

array

排除的数据源id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/upstream/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "checkItem": "",
  "dataSourceId": 0,
  "excludeSourceIdList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─priority

int32

优先级

-

0

     └─dataSourceId

int32

数据源id

-

0

     └─dataSourceCode

string

数据源编码

-

     └─dataSourceName

string

数据源名称

-

     └─service

string

数据源

-

     └─checkItem

string

服务项

-

     └─checkItemName

string

服务项名称

-

     └─reqKey

string

请求key,用户名,appId等...

-

     └─reqSecret

string

请求秘钥,密码,appSecret等...

-

     └─reqUrl

string

请求地址

-

     └─cost

number

成本 单位:元

-

0

     └─costDetail

string

成本明细

-

     └─extra

string

附加信息

-

     └─scene

string

场景

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "priority": 0,
        "dataSourceId": 0,
        "dataSourceCode": "",
        "dataSourceName": "",
        "service": "",
        "checkItem": "",
        "checkItemName": "",
        "reqKey": "",
        "reqSecret": "",
        "reqUrl": "",
        "cost": 0,
        "costDetail": "",
        "extra": "",
        "scene": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.1.13.调用记录

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 调用记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

查询关键字

false

-

idCard

string

身份证号

false

-

deptIdList

array

客户id

false

-

"0,0"

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

itemCodeList

array

产品编码

false

-

""","""

isFee

int32

是否计费

false

-

0

success

int32

是否成功

false

-

0

cacheFlag

int32

是否为缓存数据 0否 1是

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/recordList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "idCard": "",
  "deptIdList": [
    0
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss",
  "itemCodeList": [
    ""
  ],
  "isFee": 0,
  "success": 0,
  "cacheFlag": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─deptName

string

客户名称

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标识

-

     └─tradeNo

string

交易单号

-

     └─seqNo

string

流水号

-

     └─appId

string

机构appId

-

     └─deptId

int64

机构id

-

0

     └─result

string

检测结果

-

     └─isFee

int32

是否计费

-

0

     └─isFeeDesc

string

是否计费

-

     └─fee

number

产生费用

-

0

     └─success

int32

是否成功

-

0

     └─resultMsg

string

数据源返回信息

-

     └─resultCode

int32

数据源返回code

-

0

     └─cacheFlag

int32

是否为缓存数据 0实时数据 1缓存数据

-

0

     └─name

string

客户名称

-

     └─idCard

string

身份证

-

     └─mobile

string

手机号码

-

     └─sign

string

签名

-

     └─encryptionType

string

加密类型1:明文(默认),2:MD5,3:SHA256,4:SM3加密

-

     └─phoneRegion

string

号码归属地

-

     └─finalSource

string

请求数据源

-

     └─time

string

耗时 单位:ms

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─requestIp

string

请求ip

-

     └─upstreamRecordList

array

上游调用明细

-

          └─id

int64

主键

-

0

          └─seqNo

string

调用链流水号

-

          └─dataSourceCode

string

数据源编码

-

          └─dataSourceName

string

数据源编码

-

          └─thirdSeqNo

string

第三方流水号

-

          └─reqParam

string

调用参数

-

          └─response

string

返回结果

-

          └─url

string

调用地址

-

          └─time

int32

耗时 :s

-

0

          └─stack

string

异常栈

-

          └─item

string

产品编码

-

          └─extra

string

附加信息

-

          └─outerName

string

外部源名称

-

          └─isFee

int32

是否计费 0不计费 1计费

-

0

          └─outerType

int32

外部源代号

-

0

          └─deptName

string

机构名称

-

          └─appId

string

机构名称

-

          └─tag

string

标记

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─extend

string

附加信息

-

     └─orgCode

string

组织编码

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptName": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "tradeNo": "",
        "seqNo": "",
        "appId": "",
        "deptId": 0,
        "result": "",
        "isFee": 0,
        "isFeeDesc": "",
        "fee": 0,
        "success": 0,
        "resultMsg": "",
        "resultCode": 0,
        "cacheFlag": 0,
        "name": "",
        "idCard": "",
        "mobile": "",
        "sign": "",
        "encryptionType": "",
        "phoneRegion": "",
        "finalSource": "",
        "time": "",
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "requestIp": "",
        "upstreamRecordList": [
          {
            "id": 0,
            "seqNo": "",
            "dataSourceCode": "",
            "dataSourceName": "",
            "thirdSeqNo": "",
            "reqParam": "",
            "response": "",
            "url": "",
            "time": 0,
            "stack": "",
            "item": "",
            "extra": "",
            "outerName": "",
            "isFee": 0,
            "outerType": 0,
            "deptName": "",
            "appId": "",
            "tag": "",
            "createDate": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "extend": "",
        "orgCode": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.1.14.操作聚合产品子项

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 操作聚合产品子项

Body-parameters:

Parameter Type Description Required Since Example

deptItemId

int64

聚合产品授权产品记录id

true

-

0

checkItemList

array

子项产品编码

true

-

""","""

dealType

int32

操作类型,10-新增,20-删除

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/bee/deptItem/dealSub' --data '{
  "deptItemId": 0,
  "checkItemList": [
    ""
  ],
  "dealType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.2.客户合同管理

4.2.1.需签署合同客户列表

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 需签署合同客户列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/needSignContractList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

No comments found.

-

0

     └─deptName

string

机构名称

-

     └─userName

string

用户名

-

     └─mobile

string

联系号码

-

     └─password

string

密码

-

     └─proxyerId

int32

代理员ID

-

0

     └─proxyer

string

代理人

-

     └─appId

string

接口appId

-

     └─checkFee

number

单项报告费用(单位:元)

-

0

     └─trialEndDate

string

试用结束日期

-

yyyy-MM-dd HH:mm:ss

     └─status

int32

状态 0:试用。1正式客户

-

0

     └─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

     └─proxyerMobile

string

代理商电话

-

     └─userId

int64

用户id

-

0

     └─createDate

string

No comments found.

-

yyyy-MM-dd HH:mm:ss

     └─emails

string

通知邮箱

-

     └─contractState

int32

合作协议签署状态,-10:已拒签,-1:已取消,0-未发起,50-待签署,80-已线下签署,100-已签署

-

0

     └─whiteIpList

string

ip白名单,多个逗号分割

-

     └─deptItemCount

int32

产品数量

-

0

     └─lastAuditTime

string

最近审核时间

-

yyyy-MM-dd HH:mm:ss

     └─templateCode

string

合同模板编码

-

     └─templateName

string

合同模板名称

-

     └─seq

int32

次序

-

0

     └─authState

int32

认证状态

-

0

     └─authRecordId

int64

最新认证记录id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptName": "",
        "userName": "",
        "mobile": "",
        "password": "",
        "proxyerId": 0,
        "proxyer": "",
        "appId": "",
        "checkFee": 0,
        "trialEndDate": "yyyy-MM-dd HH:mm:ss",
        "status": 0,
        "overdraftType": 0,
        "proxyerMobile": "",
        "userId": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "emails": "",
        "contractState": 0,
        "whiteIpList": "",
        "deptItemCount": 0,
        "lastAuditTime": "yyyy-MM-dd HH:mm:ss",
        "templateCode": "",
        "templateName": "",
        "seq": 0,
        "authState": 0,
        "authRecordId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.2.查询提交合同准备数据

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 查询提交合同准备数据

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

forManualUpload

boolean

手动上传合同场景

false

-

true

dealName

string

操作人姓名

false

-

dealMobile

string

操作人手机号

false

-

dealEmail

string

操作人邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/preData' --data '{
  "deptId": 0,
  "forManualUpload": true,
  "dealName": "",
  "dealMobile": "",
  "dealEmail": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─contractName

string

合同名称

-

└─templateCode

string

合同模板编码

-

└─templateName

string

合同模板名称

-

└─fillData

array

填充数据

-

     └─key

string

关键字

-

     └─name

string

名称

-

     └─value

string

内容

-

     └─must

boolean

是否必填,默认false

-

true

     └─fixed

boolean

是否固定不可修改,默认false

-

true

└─deptItemList

array

产品列表

-

     └─deptItemId

int64

授权记录id

-

0

     └─checkItem

string

产品编码

-

     └─itemName

string

产品名称

-

     └─showFee

string

展示单价

-

     └─feeType

string

计费方式,查得计费、查询计费

-

     └─remark

string

备注

-

└─seq

int32

次序

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "contractName": "",
    "templateCode": "",
    "templateName": "",
    "fillData": [
      {
        "key": "",
        "name": "",
        "value": "",
        "must": true,
        "fixed": true
      }
    ],
    "deptItemList": [
      {
        "deptItemId": 0,
        "checkItem": "",
        "itemName": "",
        "showFee": "",
        "feeType": "",
        "remark": ""
      }
    ],
    "seq": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.3.待签署产品列表

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 待签署产品列表

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

forManualUpload

boolean

手动上传合同场景

false

-

true

dealName

string

操作人姓名

false

-

dealMobile

string

操作人手机号

false

-

dealEmail

string

操作人邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/unsignedDeptItemList' --data '{
  "deptId": 0,
  "forManualUpload": true,
  "dealName": "",
  "dealMobile": "",
  "dealEmail": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─deptItemId

int64

授权记录id

-

0

└─checkItem

string

产品编码

-

└─itemName

string

产品名称

-

└─showFee

string

展示单价

-

└─feeType

string

计费方式,查得计费、查询计费

-

└─remark

string

备注

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deptItemId": 0,
      "checkItem": "",
      "itemName": "",
      "showFee": "",
      "feeType": "",
      "remark": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.2.4.预提交合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 预提交合同

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

组织id

true

-

0

contractName

string

合同名称

true

-

fillDataList

array

数据填充内容

true

-

└─key

object

No comments found.

false

-

└─value

object

No comments found.

false

-

deptItemList

array

产品列表

false

-

└─deptItemId

int64

授权记录id

true

-

0

└─checkItem

string

产品编码

true

-

└─itemName

string

产品名称

true

-

└─showFee

string

展示单价

true

-

└─feeType

string

计费方式,查得计费、查询计费

true

-

└─remark

string

备注

false

-

seq

int32

签署版次

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/preSubmit' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "contractName": "",
  "fillDataList": [
    {
      "key": {
        "key": {},
        "value": {}
      },
      "value": {
        "key": {},
        "value": {}
      }
    }
  ],
  "deptItemList": [
    {
      "deptItemId": 0,
      "checkItem": "",
      "itemName": "",
      "showFee": "",
      "feeType": "",
      "remark": ""
    }
  ],
  "seq": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─contractNo

string

合同编号

-

└─contractName

string

合同名称

-

└─previewUrl

string

预览地址

-

└─mobile

string

签署手机号,页面可修改

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "contractNo": "",
    "contractName": "",
    "previewUrl": "",
    "mobile": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.5.提交合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 提交合同

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

组织id

true

-

0

contractNo

string

合同编号

true

-

signerName

string

签署人姓名,signerType=10必传

false

-

signerIdCard

string

签署人身份证号,signerType=10必传

false

-

mobile

string

签署人手机号,必传

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/submit' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "contractNo": "",
  "signerName": "",
  "signerIdCard": "",
  "mobile": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─contractNo

string

合同编号

-

└─contractName

string

合同名称

-

└─signUrl

string

签署地址

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "contractNo": "",
    "contractName": "",
    "signUrl": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.6.合同列表

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 合同列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

templateCode

string

合同模板编码

false

-

deptIdList

array

客户id

false

-

"0,0"

stateList

array

状态

false

-

"0,0"

excludeStateList

array

排除的状态

false

-

"0,0"

contractNoList

array

合同编号

false

-

""","""

createDateGte

string

创建时间大于

false

-

yyyy-MM-dd HH:mm:ss

createDateLte

string

创建时间小于

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "templateCode": "",
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "excludeStateList": [
    0
  ],
  "contractNoList": [
    ""
  ],
  "createDateGte": "yyyy-MM-dd HH:mm:ss",
  "createDateLte": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─deptId

int64

组织id

-

0

     └─deptName

string

组织名称

-

     └─userId

int64

用户id

-

0

     └─contractNo

string

合同编号

-

     └─templateCode

string

合同模板编码

-

     └─contractName

string

合同名称

-

     └─state

int32

状态

-

0

     └─deptItemCount

int32

授权产品数量

-

0

     └─signerMobile

string

签署人手机号

-

     └─contractUrl

string

合同地址

-

     └─version

int32

合同版本

-

0

     └─versionName

string

版本名称

-

     └─submitTime

string

发起时间

-

yyyy-MM-dd HH:mm:ss

     └─signEndTime

string

签署截止时间

-

yyyy-MM-dd HH:mm:ss

     └─finishTime

string

签署完成时间

-

yyyy-MM-dd HH:mm:ss

     └─expireTime

string

合同过期时间

-

yyyy-MM-dd HH:mm:ss

     └─rejectReason

string

拒签原因

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "deptId": 0,
        "deptName": "",
        "userId": 0,
        "contractNo": "",
        "templateCode": "",
        "contractName": "",
        "state": 0,
        "deptItemCount": 0,
        "signerMobile": "",
        "contractUrl": "",
        "version": 0,
        "versionName": "",
        "submitTime": "yyyy-MM-dd HH:mm:ss",
        "signEndTime": "yyyy-MM-dd HH:mm:ss",
        "finishTime": "yyyy-MM-dd HH:mm:ss",
        "expireTime": "yyyy-MM-dd HH:mm:ss",
        "rejectReason": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.2.7.重新发送签署短信

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 重新发送签署短信

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/resendSms' --data '{
  "contractNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.2.8.撤销合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 撤销合同

Body-parameters:

Parameter Type Description Required Since Example

contractNo

string

合同编号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/withdraw' --data '{
  "contractNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.2.9.查询手动上传次序

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 查询手动上传次序

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

forManualUpload

boolean

手动上传合同场景

false

-

true

dealName

string

操作人姓名

false

-

dealMobile

string

操作人手机号

false

-

dealEmail

string

操作人邮箱

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/queryManualSeq' --data '{
  "deptId": 0,
  "forManualUpload": true,
  "dealName": "",
  "dealMobile": "",
  "dealEmail": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

int32

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": 0,
  "timestamp": 0,
  "traceId": ""
}

4.2.10.手动上传合同

Type: POST

Author: wangqidong created on 2025/3/27

Content-Type: application/json

Description: 手动上传合同

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

templateCode

string

合同编码

true

-

contractUrl

string

合同链接

false

-

deptItemList

array

产品列表

false

-

└─deptItemId

int64

授权记录id

true

-

0

└─checkItem

string

产品编码

true

-

└─itemName

string

产品名称

true

-

└─showFee

string

展示单价

true

-

└─feeType

string

计费方式,查得计费、查询计费

true

-

└─remark

string

备注

false

-

seq

int32

签署版次,合作协议传0

true

-

0

finishTime

string

签署时间

false

-

yyyy-MM-dd HH:mm:ss

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/contract/manualUpload' --data '{
  "deptId": 0,
  "templateCode": "",
  "contractUrl": "",
  "deptItemList": [
    {
      "deptItemId": 0,
      "checkItem": "",
      "itemName": "",
      "showFee": "",
      "feeType": "",
      "remark": ""
    }
  ],
  "seq": 0,
  "finishTime": "yyyy-MM-dd HH:mm:ss"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.3.系统配置

4.3.1.查询菜单

Type: GET

Author: wangqidong created on 2025/8/25

Content-Type: application/x-www-form-urlencoded

Description: 查询菜单

Request-example:

curl -X GET -i '/mt/sales/config/pageMenus'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─code

string

菜单编码

-

└─title

string

菜单名称

-

└─pid

int64

上级菜单id

-

0

└─pTitle

string

上级菜单名称

-

└─level

int32

部门等级,最多3级

-

0

└─component

string

组件

-

└─icon

string

图标

-

└─isDir

boolean

是否是目录

-

true

└─path

string

路径

-

└─highlightMenu

string

高亮菜单

-

└─redirectUrl

string

重定向地址

-

└─enable

boolean

是否启用

-

true

└─hidden

boolean

是否隐藏

-

true

└─hiddenSidebar

boolean

是否隐藏侧边栏

-

true

└─cacheable

boolean

是否缓存

-

true

└─buttons

array

按钮

-

     └─label

string

按钮名称

-

     └─value

string

按钮编码

-

└─extra

object

扩展属性

-

└─sort

int32

排序

-

0

└─appcode

string

应用编码

-

└─subList

array

下级菜单列表

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "code": "",
      "title": "",
      "pid": 0,
      "pTitle": "",
      "level": 0,
      "component": "",
      "icon": "",
      "isDir": true,
      "path": "",
      "highlightMenu": "",
      "redirectUrl": "",
      "enable": true,
      "hidden": true,
      "hiddenSidebar": true,
      "cacheable": true,
      "buttons": [
        {
          "label": "",
          "value": ""
        }
      ],
      "extra": {},
      "sort": 0,
      "appcode": "",
      "subList": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.4.首页数据

4.4.1.指标统计

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 指标统计

Body-parameters:

Parameter Type Description Required Since Example

refresh

boolean

是否强制刷新

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/index/coreStatistics' --data '{
  "refresh": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─currMonthAmount

number

本月销售总额

-

0

└─currMonthRoyaltyAmount

number

本月预计提成金额

-

0

└─prevMonthAmount

number

上月销售总额

-

0

└─prevMonthRoyaltyAmount

number

上月预计提成金额

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "currMonthAmount": 0,
    "currMonthRoyaltyAmount": 0,
    "prevMonthAmount": 0,
    "prevMonthRoyaltyAmount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.4.2.销售概况

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售概况

Body-parameters:

Parameter Type Description Required Since Example

dateType

string

统计日期类型,daily-按天统计,monthly-按月统计,yearly-按年

true

-

statisticsDate

string

统计日期,daily:2025-08-01,monthly:2025-08,yearly:2025

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/index/summary' --data '{
  "dateType": "",
  "statisticsDate": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─statisticsDate

string

统计日期,daily:2025-08-01,monthly:2025-08,yearly:2025

-

└─salesAmount

number

销售金额

-

0

└─chargeCalls

int32

计费笔数

-

0

└─paymentAmount

number

回款金额

-

0

└─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

└─dateType

string

统计日期类型,daily-按天统计,monthly-按月统计,yearly-按年

-

└─salesTarget

number

销售目标

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "statisticsDate": "",
    "salesAmount": 0,
    "chargeCalls": 0,
    "paymentAmount": 0,
    "royaltyAmount": 0,
    "dateType": "",
    "salesTarget": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.4.3.待办

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 待办

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/index/backlog' --data '{}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─unsignCount

int64

待发起合同数量

-

0

└─receivableCustomerCount

int64

待回款客户

-

0

└─waitInvoiceCount

int64

待开票

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "unsignCount": 0,
    "receivableCustomerCount": 0,
    "waitInvoiceCount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.4.4.客户调用排行

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 客户调用排行

Body-parameters:

Parameter Type Description Required Since Example

deptIdList

array

客户组织id

false

-

"0,0"

dateType

int32

日期类型,10-今天,20-昨天,30-本月,40-上月

true

-

0

salesmanId

int64

销售员id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/index/customerRanking' --data '{
  "deptIdList": [
    0
  ],
  "dateType": 0,
  "salesmanId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─deptId

int64

No comments found.

-

0

└─organizationId

int64

No comments found.

-

0

└─deptName

string

客户名称

-

└─count

int64

调用数量

-

0

└─amount

number

金额

-

0

└─royaltyAmount

number

提成

-

0

└─compareCount

int64

同比调用数量

-

0

└─compareAmount

number

同比金额

-

0

└─countIncreaseRate

number

调用数量增长百分比,负数代表下跌

-

0

└─amountIncreaseRate

number

金额增长百分比,负数代表下跌

-

0

└─royaltyAmountIncreaseRate

number

提成增长百分比,负数代表下跌

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "deptId": 0,
      "organizationId": 0,
      "deptName": "",
      "count": 0,
      "amount": 0,
      "royaltyAmount": 0,
      "compareCount": 0,
      "compareAmount": 0,
      "countIncreaseRate": 0,
      "amountIncreaseRate": 0,
      "royaltyAmountIncreaseRate": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.4.5.销售业绩统计

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售业绩统计

Body-parameters:

Parameter Type Description Required Since Example

salesmanId

int64

销售员id

false

-

0

dateType

string

统计日期类型,daily-按天统计,monthly-按月统计,yearly-按年

false

-

statisticsDateGte

string

统计日期大于等于,daily:2025-08-01,monthly:2025-08,yearly:2025

false

-

statisticsDateLte

string

统计日期小于等于,daily:2025-08-01,monthly:2025-08,yearly:2025

false

-

displayType

int32

展示类型,1-按客户数展示,2-按日期展示

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/index/salesPerfStatistics' --data '{
  "salesmanId": 0,
  "dateType": "",
  "statisticsDateGte": "",
  "statisticsDateLte": "",
  "displayType": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

销售员id

-

0

└─dateType

string

统计日期类型,daily-按天统计,monthly-按月统计

-

└─statisticsDate

string

统计日期

-

└─salesAmount

number

总金额

-

0

└─chargeCalls

int32

计费笔数

-

0

└─paymentAmount

number

回款笔数

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "customerId": 0,
      "customerName": "",
      "salesmanId": 0,
      "dateType": "",
      "statisticsDate": "",
      "salesAmount": 0,
      "chargeCalls": 0,
      "paymentAmount": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.4.6.客户调用统计

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 客户调用统计

Body-parameters:

Parameter Type Description Required Since Example

deptIdList

array

客户组织id

false

-

"0,0"

dateType

int32

日期类型,10-今天,20-昨天,30-本月,40-上月

true

-

0

salesmanId

int64

销售员id

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/index/customerCallStatistics' --data '{
  "deptIdList": [
    0
  ],
  "dateType": 0,
  "salesmanId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─checkItem

string

检测项

-

└─checkItemName

string

检测项名称,包括tag

-

└─tag

string

标签

-

└─count

int32

调用笔数

-

0

└─fee

number

总费用

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "checkItem": "",
      "checkItemName": "",
      "tag": "",
      "count": 0,
      "fee": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.5.客户管理

4.5.1.客户注册

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 客户注册

Body-parameters:

Parameter Type Description Required Since Example

syncOtherEnv

boolean

是否同步注册其他环境,默认false

false

-

true

username

string

用户名

false

-

organizationName

string

企业名称

true

-

aliasName

string

企业别名

false

-

enterpriseNo

string

统一社会信用代码

true

-

nickname

string

昵称

false

-

mobile

string

手机号

true

-

businessImg

string

营业执照

false

-

state

int32

用户状态,0:未激活,-1:已注销,10-正常

false

-

0

realName

string

真实姓名(法人姓名)

false

-

idCard

string

身份证号码(法人身份证号)

false

-

portrait

string

头像

false

-

email

string

邮箱

false

-

linkman

string

联系人

false

-

linkMobile

string

联系方式

false

-

linkAddress

object

联系地址

false

-

└─id

int64

id

false

-

0

└─provinceCode

string

省编码

false

-

└─provinceName

string

省名称

false

-

└─cityCode

string

市编码

false

-

└─cityName

string

市名称

false

-

└─districtCode

string

区县编码

false

-

└─districtName

string

区县名称

false

-

└─streetCode

string

街道编码

false

-

└─streetName

string

街道编名称

false

-

└─addressDetail

string

详细地址

false

-

└─fullAddress

string

完整地址

false

-

invitationCode

string

邀请码

false

-

gradeCode

string

客户分级

false

-

royaltyRate

number

提成比例,0-1

false

-

0

gainChannel

string

获客渠道

false

-

royaltyEffectMonth

string

销售生效月份

false

-

customerType

int32

客户类型,10-试用客户,20-正式客户

false

-

0

customerNature

string

客户业务类型

false

-

workspaceImgList

array

办公场所

false

-

""","""

certificationList

array

资质文件

false

-

""","""

appcodes

array

可用系统

true

-

└─relationId

int64

关联id

false

-

0

└─appcode

string

应用编码

true

-

└─bizAppcode

string

业务系统编码

false

-

└─appName

string

No comments found.

false

-

└─bizAppName

string

No comments found.

false

-

industry

string

所属行业

false

-

noticeAtOnce

boolean

是否立即通知用户

false

-

true

syncAppId

string

同步appId

false

-

enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

false

-

isMonthlySettle

boolean

是否月结

false

-

true

overdraftQuota

number

可透支额度

false

-

0

opportunityId

int64

商机id

false

-

0

assistantId

int64

维护人userId,如果非主账号登录,默认取当前登录用户id,assistantId和assistantStaffId都传了优先取assistantStaffId

false

-

0

applyId

int64

申请id,不为空代表修改

false

-

0

applyRemark

string

申请备注 Validation[Length(max=250, min=0, message= 申请备注最多250字)]

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/register' --data '{
  "syncOtherEnv": true,
  "username": "",
  "organizationName": "",
  "aliasName": "",
  "enterpriseNo": "",
  "nickname": "",
  "mobile": "",
  "businessImg": "",
  "state": 0,
  "realName": "",
  "idCard": "",
  "portrait": "",
  "email": "",
  "linkman": "",
  "linkMobile": "",
  "linkAddress": {
    "id": 0,
    "provinceCode": "",
    "provinceName": "",
    "cityCode": "",
    "cityName": "",
    "districtCode": "",
    "districtName": "",
    "streetCode": "",
    "streetName": "",
    "addressDetail": "",
    "fullAddress": ""
  },
  "invitationCode": "",
  "gradeCode": "",
  "royaltyRate": 0,
  "gainChannel": "",
  "royaltyEffectMonth": "",
  "customerType": 0,
  "customerNature": "",
  "workspaceImgList": [
    ""
  ],
  "certificationList": [
    ""
  ],
  "appcodes": [
    {
      "relationId": 0,
      "appcode": "",
      "bizAppcode": "",
      "appName": "",
      "bizAppName": ""
    }
  ],
  "industry": "",
  "noticeAtOnce": true,
  "syncAppId": "",
  "enterpriseDesc": "",
  "isMonthlySettle": true,
  "overdraftQuota": 0,
  "opportunityId": 0,
  "assistantId": 0,
  "applyId": 0,
  "applyRemark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─applyNo

string

申请单号,重新提交不变

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名

-

└─auditState

int32

状态,-10:已驳回,0:待审核,10:已通过

-

0

└─isOut

boolean

是否已过时(非最新申请记录)

-

true

└─submitInfo

object

提交明细

-

     └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

     └─username

string

用户名

-

     └─organizationName

string

企业名称

-

     └─aliasName

string

企业别名

-

     └─enterpriseNo

string

统一社会信用代码

-

     └─nickname

string

昵称

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─state

int32

用户状态,0:未激活,-1:已注销,10-正常

-

0

     └─realName

string

真实姓名(法人姓名)

-

     └─idCard

string

身份证号码(法人身份证号)

-

     └─portrait

string

头像

-

     └─email

string

邮箱

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─linkAddress

object

联系地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─invitationCode

string

邀请码

-

     └─assistantId

int64

维护人userId

-

0

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─royaltyEffectMonth

string

销售生效月份

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─customerNature

string

客户业务类型

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─appcodes

array

可用系统

-

          └─relationId

int64

关联id

-

0

          └─appcode

string

应用编码

-

          └─bizAppcode

string

业务系统编码

-

          └─appName

string

No comments found.

-

          └─bizAppName

string

No comments found.

-

     └─industry

string

所属行业

-

     └─noticeAtOnce

boolean

是否立即通知用户

-

true

     └─syncAppId

string

同步appId

-

     └─enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

-

     └─isMonthlySettle

boolean

是否月结

-

true

     └─overdraftQuota

number

可透支额度

-

0

     └─opportunityId

int64

商机id

-

0

└─submitRemark

string

提交备注

-

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─auditRemark

string

审核备注

-

└─auditImgList

array

审核图片

-

""","""

└─opportunityId

int64

商机id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "applyNo": "",
    "customerId": 0,
    "customerName": "",
    "salesmanId": 0,
    "salesmanName": "",
    "auditState": 0,
    "isOut": true,
    "submitInfo": {
      "syncOtherEnv": true,
      "username": "",
      "organizationName": "",
      "aliasName": "",
      "enterpriseNo": "",
      "nickname": "",
      "mobile": "",
      "businessImg": "",
      "state": 0,
      "realName": "",
      "idCard": "",
      "portrait": "",
      "email": "",
      "linkman": "",
      "linkMobile": "",
      "linkAddress": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "invitationCode": "",
      "assistantId": 0,
      "gradeCode": "",
      "royaltyRate": 0,
      "gainChannel": "",
      "royaltyEffectMonth": "",
      "customerType": 0,
      "customerNature": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "appcodes": [
        {
          "relationId": 0,
          "appcode": "",
          "bizAppcode": "",
          "appName": "",
          "bizAppName": ""
        }
      ],
      "industry": "",
      "noticeAtOnce": true,
      "syncAppId": "",
      "enterpriseDesc": "",
      "isMonthlySettle": true,
      "overdraftQuota": 0,
      "opportunityId": 0
    },
    "submitRemark": "",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "auditRemark": "",
    "auditImgList": [
      ""
    ],
    "opportunityId": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.2.客户注册申请列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 客户注册申请列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

applyNo

string

申请单号

false

-

keyword

string

关键字

false

-

auditStateList

array

审核状态

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/applyList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "applyNo": "",
  "keyword": "",
  "auditStateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─applyNo

string

申请单号,重新提交不变

-

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

销售员id

-

0

     └─salesmanName

string

销售员名

-

     └─auditState

int32

状态,-10:已驳回,0:待审核,10:已通过

-

0

     └─isOut

boolean

是否已过时(非最新申请记录)

-

true

     └─submitInfo

object

提交明细

-

          └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

          └─username

string

用户名

-

          └─organizationName

string

企业名称

-

          └─aliasName

string

企业别名

-

          └─enterpriseNo

string

统一社会信用代码

-

          └─nickname

string

昵称

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─state

int32

用户状态,0:未激活,-1:已注销,10-正常

-

0

          └─realName

string

真实姓名(法人姓名)

-

          └─idCard

string

身份证号码(法人身份证号)

-

          └─portrait

string

头像

-

          └─email

string

邮箱

-

          └─linkman

string

联系人

-

          └─linkMobile

string

联系方式

-

          └─linkAddress

object

联系地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─invitationCode

string

邀请码

-

          └─assistantId

int64

维护人userId

-

0

          └─gradeCode

string

客户分级

-

          └─royaltyRate

number

提成比例,0-1

-

0

          └─gainChannel

string

获客渠道

-

          └─royaltyEffectMonth

string

销售生效月份

-

          └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

          └─customerNature

string

客户业务类型

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─appcodes

array

可用系统

-

               └─relationId

int64

关联id

-

0

               └─appcode

string

应用编码

-

               └─bizAppcode

string

业务系统编码

-

               └─appName

string

No comments found.

-

               └─bizAppName

string

No comments found.

-

          └─industry

string

所属行业

-

          └─noticeAtOnce

boolean

是否立即通知用户

-

true

          └─syncAppId

string

同步appId

-

          └─enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

-

          └─isMonthlySettle

boolean

是否月结

-

true

          └─overdraftQuota

number

可透支额度

-

0

          └─opportunityId

int64

商机id

-

0

     └─submitRemark

string

提交备注

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核备注

-

     └─auditImgList

array

审核图片

-

""","""

     └─opportunityId

int64

商机id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "applyNo": "",
        "customerId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "auditState": 0,
        "isOut": true,
        "submitInfo": {
          "syncOtherEnv": true,
          "username": "",
          "organizationName": "",
          "aliasName": "",
          "enterpriseNo": "",
          "nickname": "",
          "mobile": "",
          "businessImg": "",
          "state": 0,
          "realName": "",
          "idCard": "",
          "portrait": "",
          "email": "",
          "linkman": "",
          "linkMobile": "",
          "linkAddress": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "invitationCode": "",
          "assistantId": 0,
          "gradeCode": "",
          "royaltyRate": 0,
          "gainChannel": "",
          "royaltyEffectMonth": "",
          "customerType": 0,
          "customerNature": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "appcodes": [
            {
              "relationId": 0,
              "appcode": "",
              "bizAppcode": "",
              "appName": "",
              "bizAppName": ""
            }
          ],
          "industry": "",
          "noticeAtOnce": true,
          "syncAppId": "",
          "enterpriseDesc": "",
          "isMonthlySettle": true,
          "overdraftQuota": 0,
          "opportunityId": 0
        },
        "submitRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "auditRemark": "",
        "auditImgList": [
          ""
        ],
        "opportunityId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.3.客户注册申请详情

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 客户注册申请详情

Body-parameters:

Parameter Type Description Required Since Example

applyNo

string

申请单号,applyNo和applyId二选一

false

-

applyId

int64

申请id,applyNo和applyId二选一

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/applyDetail' --data '{
  "applyNo": "",
  "applyId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─applyNo

string

申请单号,重新提交不变

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

销售员id

-

0

└─salesmanName

string

销售员名

-

└─auditState

int32

状态,-10:已驳回,0:待审核,10:已通过

-

0

└─isOut

boolean

是否已过时(非最新申请记录)

-

true

└─submitInfo

object

提交明细

-

     └─syncOtherEnv

boolean

是否同步注册其他环境,默认false

-

true

     └─username

string

用户名

-

     └─organizationName

string

企业名称

-

     └─aliasName

string

企业别名

-

     └─enterpriseNo

string

统一社会信用代码

-

     └─nickname

string

昵称

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─state

int32

用户状态,0:未激活,-1:已注销,10-正常

-

0

     └─realName

string

真实姓名(法人姓名)

-

     └─idCard

string

身份证号码(法人身份证号)

-

     └─portrait

string

头像

-

     └─email

string

邮箱

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─linkAddress

object

联系地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─invitationCode

string

邀请码

-

     └─assistantId

int64

维护人userId

-

0

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─royaltyEffectMonth

string

销售生效月份

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─customerNature

string

客户业务类型

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─appcodes

array

可用系统

-

          └─relationId

int64

关联id

-

0

          └─appcode

string

应用编码

-

          └─bizAppcode

string

业务系统编码

-

          └─appName

string

No comments found.

-

          └─bizAppName

string

No comments found.

-

     └─industry

string

所属行业

-

     └─noticeAtOnce

boolean

是否立即通知用户

-

true

     └─syncAppId

string

同步appId

-

     └─enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多500字)]

-

     └─isMonthlySettle

boolean

是否月结

-

true

     └─overdraftQuota

number

可透支额度

-

0

     └─opportunityId

int64

商机id

-

0

└─submitRemark

string

提交备注

-

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─auditRemark

string

审核备注

-

└─auditImgList

array

审核图片

-

""","""

└─opportunityId

int64

商机id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "applyNo": "",
    "customerId": 0,
    "customerName": "",
    "salesmanId": 0,
    "salesmanName": "",
    "auditState": 0,
    "isOut": true,
    "submitInfo": {
      "syncOtherEnv": true,
      "username": "",
      "organizationName": "",
      "aliasName": "",
      "enterpriseNo": "",
      "nickname": "",
      "mobile": "",
      "businessImg": "",
      "state": 0,
      "realName": "",
      "idCard": "",
      "portrait": "",
      "email": "",
      "linkman": "",
      "linkMobile": "",
      "linkAddress": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "invitationCode": "",
      "assistantId": 0,
      "gradeCode": "",
      "royaltyRate": 0,
      "gainChannel": "",
      "royaltyEffectMonth": "",
      "customerType": 0,
      "customerNature": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "appcodes": [
        {
          "relationId": 0,
          "appcode": "",
          "bizAppcode": "",
          "appName": "",
          "bizAppName": ""
        }
      ],
      "industry": "",
      "noticeAtOnce": true,
      "syncAppId": "",
      "enterpriseDesc": "",
      "isMonthlySettle": true,
      "overdraftQuota": 0,
      "opportunityId": 0
    },
    "submitRemark": "",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "auditRemark": "",
    "auditImgList": [
      ""
    ],
    "opportunityId": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.4.客户列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 客户列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

customerNameLike

string

客户名

false

-

keyword

string

搜索关键字

false

-

nearFollowDateGte

string

最近拜访时间大于等于,nearFollowDateGte和nearFollowDateLt仅支持传递一个

false

-

yyyy-MM-dd

nearFollowDateLt

string

最近拜访时间小于,nearFollowDateGte和nearFollowDateLt仅支持传递一个

false

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "customerNameLike": "",
  "keyword": "",
  "nearFollowDateGte": "yyyy-MM-dd",
  "nearFollowDateLt": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─organizationId

int64

组织id

-

0

     └─merchantId

int64

商户id

-

0

     └─mobile

string

手机号

-

     └─organizationName

string

组织名称

-

     └─aliasName

string

组织别名

-

     └─state

int32

企业状态,0:待审核,10:正常

-

0

     └─overdraftType

enum

超支类型

-

UNACTIVATED

     └─logo

string

企业logo

-

     └─assistantId

int64

维护人id

-

0

     └─assistantName

string

维护人姓名

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─email

string

邮箱

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─industry

string

所属行业

-

     └─enableDevelop

boolean

开发者权限是否开通

-

true

     └─deptId

int64

开发账户id

-

0

     └─appId

string

接口appId

-

     └─appSecret

string

接口密钥,

-

     └─authRecord

object

认证记录

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─userId

int64

用户id

-

0

          └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

          └─state

int32

状态

-

0

          └─enterpriseName

string

企业姓名

-

          └─enterpriseNo

string

统一社会信用编码

-

          └─realName

string

真实姓名/法人姓名

-

          └─idCard

string

身份证号/法人身份证

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─idCardFront

string

身份证/法人身份证正面

-

          └─idCardBack

string

法人身份证法人身份证反面

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─linkman

string

联系人

-

          └─linkMobile

string

联系电话

-

          └─linkEmail

string

联系人邮箱

-

          └─linkPosition

string

联系人职位

-

          └─businessDesc

string

业务介绍

-

          └─addressInfo

object

地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─industry

enum

行业编码

-

LEASE3C

          └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

          └─auditRemark

string

审核意见

-

          └─sourceAppcode

string

注册系统编码

-

          └─tenantId

int64

租户id

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─certificationList

array

资质文件

-

""","""

     └─whiteIpList

string

ip白名单

-

     └─addressInfo

object

地址信息

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─sourceAppcode

string

注册系统编码

-

     └─enabledApps

array

已开通应用编码

-

          └─appcode

string

应用编码

-

          └─appName

string

应用名称

-

          └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

          └─systemCode

string

所属系统编码

-

          └─domain

string

域名

-

          └─logo

string

应用logo

-

          └─tenantId

int64

默认所属租户id

-

0

          └─bizAppList

array

关联的业务系统

-

     └─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─enterpriseDesc

string

企业描述

-

     └─customerNature

string

客户业务类型

-

     └─opportunitySalesmanId

int64

商机业务员id

-

0

     └─opportunityRoleType

string

商机业务员类型

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "organizationId": 0,
        "merchantId": 0,
        "mobile": "",
        "organizationName": "",
        "aliasName": "",
        "state": 0,
        "overdraftType": 0,
        "logo": "",
        "assistantId": 0,
        "assistantName": "",
        "linkman": "",
        "linkMobile": "",
        "email": "",
        "customerType": 0,
        "industry": "",
        "enableDevelop": true,
        "deptId": 0,
        "appId": "",
        "appSecret": "",
        "authRecord": {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "userId": 0,
          "authType": 0,
          "state": 0,
          "enterpriseName": "",
          "enterpriseNo": "",
          "realName": "",
          "idCard": "",
          "mobile": "",
          "businessImg": "",
          "idCardFront": "",
          "idCardBack": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "linkman": "",
          "linkMobile": "",
          "linkEmail": "",
          "linkPosition": "",
          "businessDesc": "",
          "addressInfo": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "industry": "",
          "auditTime": "yyyy-MM-dd HH:mm:ss",
          "auditRemark": "",
          "sourceAppcode": "",
          "tenantId": 0
        },
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "certificationList": [
          ""
        ],
        "whiteIpList": "",
        "addressInfo": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "sourceAppcode": "",
        "enabledApps": [
          {
            "appcode": "",
            "appName": "",
            "appType": "",
            "systemCode": "",
            "domain": "",
            "logo": "",
            "tenantId": 0,
            "bizAppList": [
              {
                "$ref": ".."
              }
            ]
          }
        ],
        "nearFollowDate": "yyyy-MM-dd",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "enterpriseDesc": "",
        "customerNature": "",
        "opportunitySalesmanId": 0,
        "opportunityRoleType": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.5.客户详情

Type: GET

Author: wangqidong created on 2025/8/18

Content-Type: application/x-www-form-urlencoded

Description: 客户详情

Path-parameters:

Parameter Type Description Required Since Example

organizationId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/sales/customer/detail/{organizationId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─organizationId

int64

组织id

-

0

└─merchantId

int64

商户id

-

0

└─mobile

string

手机号

-

└─organizationName

string

组织名称

-

└─aliasName

string

组织别名

-

└─state

int32

企业状态,0:待审核,10:正常

-

0

└─overdraftType

enum

超支类型

-

UNACTIVATED

└─logo

string

企业logo

-

└─assistantId

int64

维护人id

-

0

└─assistantName

string

维护人姓名

-

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─email

string

邮箱

-

└─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

└─industry

string

所属行业

-

└─enableDevelop

boolean

开发者权限是否开通

-

true

└─deptId

int64

开发账户id

-

0

└─appId

string

接口appId

-

└─appSecret

string

接口密钥,

-

└─authRecord

object

认证记录

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─userId

int64

用户id

-

0

     └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

     └─state

int32

状态

-

0

     └─enterpriseName

string

企业姓名

-

     └─enterpriseNo

string

统一社会信用编码

-

     └─realName

string

真实姓名/法人姓名

-

     └─idCard

string

身份证号/法人身份证

-

     └─mobile

string

手机号

-

     └─businessImg

string

营业执照

-

     └─idCardFront

string

身份证/法人身份证正面

-

     └─idCardBack

string

法人身份证法人身份证反面

-

     └─workspaceImgList

array

办公场所

-

""","""

     └─certificationList

array

资质文件

-

""","""

     └─linkman

string

联系人

-

     └─linkMobile

string

联系电话

-

     └─linkEmail

string

联系人邮箱

-

     └─linkPosition

string

联系人职位

-

     └─businessDesc

string

业务介绍

-

     └─addressInfo

object

地址

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─industry

enum

行业编码

-

LEASE3C

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─auditRemark

string

审核意见

-

     └─sourceAppcode

string

注册系统编码

-

     └─tenantId

int64

租户id

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─certificationList

array

资质文件

-

""","""

└─whiteIpList

string

ip白名单

-

└─addressInfo

object

地址信息

-

     └─id

int64

id

-

0

     └─provinceCode

string

省编码

-

     └─provinceName

string

省名称

-

     └─cityCode

string

市编码

-

     └─cityName

string

市名称

-

     └─districtCode

string

区县编码

-

     └─districtName

string

区县名称

-

     └─streetCode

string

街道编码

-

     └─streetName

string

街道编名称

-

     └─addressDetail

string

详细地址

-

     └─fullAddress

string

完整地址

-

└─sourceAppcode

string

注册系统编码

-

└─enabledApps

array

已开通应用编码

-

     └─appcode

string

应用编码

-

     └─appName

string

应用名称

-

     └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

     └─systemCode

string

所属系统编码

-

     └─domain

string

域名

-

     └─logo

string

应用logo

-

     └─tenantId

int64

默认所属租户id

-

0

     └─bizAppList

array

关联的业务系统

-

└─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

└─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

客户分级

-

└─royaltyRate

number

提成比例,0-1

-

0

└─gainChannel

string

获客渠道

-

└─enterpriseDesc

string

企业描述

-

└─customerNature

string

客户业务类型

-

└─opportunitySalesmanId

int64

商机业务员id

-

0

└─opportunityRoleType

string

商机业务员类型

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "organizationId": 0,
    "merchantId": 0,
    "mobile": "",
    "organizationName": "",
    "aliasName": "",
    "state": 0,
    "overdraftType": 0,
    "logo": "",
    "assistantId": 0,
    "assistantName": "",
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "customerType": 0,
    "industry": "",
    "enableDevelop": true,
    "deptId": 0,
    "appId": "",
    "appSecret": "",
    "authRecord": {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "userId": 0,
      "authType": 0,
      "state": 0,
      "enterpriseName": "",
      "enterpriseNo": "",
      "realName": "",
      "idCard": "",
      "mobile": "",
      "businessImg": "",
      "idCardFront": "",
      "idCardBack": "",
      "workspaceImgList": [
        ""
      ],
      "certificationList": [
        ""
      ],
      "linkman": "",
      "linkMobile": "",
      "linkEmail": "",
      "linkPosition": "",
      "businessDesc": "",
      "addressInfo": {
        "id": 0,
        "provinceCode": "",
        "provinceName": "",
        "cityCode": "",
        "cityName": "",
        "districtCode": "",
        "districtName": "",
        "streetCode": "",
        "streetName": "",
        "addressDetail": "",
        "fullAddress": ""
      },
      "industry": "",
      "auditTime": "yyyy-MM-dd HH:mm:ss",
      "auditRemark": "",
      "sourceAppcode": "",
      "tenantId": 0
    },
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "certificationList": [
      ""
    ],
    "whiteIpList": "",
    "addressInfo": {
      "id": 0,
      "provinceCode": "",
      "provinceName": "",
      "cityCode": "",
      "cityName": "",
      "districtCode": "",
      "districtName": "",
      "streetCode": "",
      "streetName": "",
      "addressDetail": "",
      "fullAddress": ""
    },
    "sourceAppcode": "",
    "enabledApps": [
      {
        "appcode": "",
        "appName": "",
        "appType": "",
        "systemCode": "",
        "domain": "",
        "logo": "",
        "tenantId": 0,
        "bizAppList": [
          {
            "$ref": ".."
          }
        ]
      }
    ],
    "nearFollowDate": "yyyy-MM-dd",
    "assignTime": "yyyy-MM-dd HH:mm:ss",
    "gradeCode": "",
    "royaltyRate": 0,
    "gainChannel": "",
    "enterpriseDesc": "",
    "customerNature": "",
    "opportunitySalesmanId": 0,
    "opportunityRoleType": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.6.查询钱包账户

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 查询钱包账户

Body-parameters:

Parameter Type Description Required Since Example

merchantId

int64

商户id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/wallet/list' --data '{
  "merchantId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

钱包id

-

0

└─userId

int64

用户id

-

0

└─accountName

string

账户名

-

└─accountType

int32

账户类型,10-个人账户,20-企业账户

-

0

└─isDefault

boolean

是否默认钱包

-

true

└─state

int32

钱包状态,-1-已锁定,0-待开通,10-正常

-

0

└─balance

number

账户余额

-

0

└─overdraftState

int32

后付状态,0-预充值(不允许超支),10-预充值(允许超支),20-月结

-

0

└─overdraftQuota

number

可透支额度

-

0

└─forewarnThreshold

number

预警阈值

-

0

└─forewarnContactList

array

预警联系人id,多个逗号分割

-

     └─id

int64

联系人id

-

0

     └─linkman

string

联系人姓名

-

     └─mobile

string

联系电话 Validation[Pattern(regexp=1[3-9]\d{9})]

-

     └─email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

-

     └─webhook

string

webhook

-

     └─isDefault

boolean

是否默认联系人

-

true

└─payRouteList

array

支付路由列表

-

     └─appcode

string

专属应用编码

-

     └─appName

string

专属应用名称

-

     └─properSceneList

array

专属场景

-

""","""

└─tenantId

int64

租户id

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "userId": 0,
      "accountName": "",
      "accountType": 0,
      "isDefault": true,
      "state": 0,
      "balance": 0,
      "overdraftState": 0,
      "overdraftQuota": 0,
      "forewarnThreshold": 0,
      "forewarnContactList": [
        {
          "id": 0,
          "linkman": "",
          "mobile": "",
          "email": "",
          "webhook": "",
          "isDefault": true
        }
      ],
      "payRouteList": [
        {
          "appcode": "",
          "appName": "",
          "properSceneList": [
            ""
          ]
        }
      ],
      "tenantId": 0
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.5.7.拜访登记

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 拜访登记

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id,不为空编辑

false

-

0

customerId

int64

客户id,客户id和商机id二选一,优先customerId

false

-

0

opportunityId

int64

商机id,客户id和商机id二选一,优先customerId

false

-

0

followDate

string

跟进日期

false

-

yyyy-MM-dd

contactName

string

对接人

false

-

contactPosition

string

对接人职务

false

-

contactMobile

string

对接人联系方式

false

-

flowContent

string

跟进内容 Validation[Length(max=500, min=0, message= 跟进内容最多可输入1000字)]

false

-

enterpriseDesc

string

企业描述 Validation[Length(max=500, min=0, message=企业描述最多可输入500字)]

false

-

feedback

string

客户反馈 Validation[Length(max=500, min=0, message=客户反馈最多可输入1000字)]

false

-

imgList

array

跟进照片 Validation[Size(max=5, min=0, message=最多上传5张照片)]

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/follow/save' --data '{
  "id": 0,
  "customerId": 0,
  "opportunityId": 0,
  "followDate": "yyyy-MM-dd",
  "contactName": "",
  "contactPosition": "",
  "contactMobile": "",
  "flowContent": "",
  "enterpriseDesc": "",
  "feedback": "",
  "imgList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.5.8.拜访记录

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 拜访记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

No comments found.

false

-

customerIds

array

客户id

false

-

"0,0"

opportunityIds

array

商机id

false

-

"0,0"

followDateGte

string

跟进日期大于等于

false

-

yyyy-MM-dd

followDateLte

string

跟进日期小于等于

false

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/follow/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "customerIds": [
    0
  ],
  "opportunityIds": [
    0
  ],
  "followDateGte": "yyyy-MM-dd",
  "followDateLte": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerId

int64

客户id

-

0

     └─opportunityId

int64

商机id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

当前销售员id

-

0

     └─salesmanName

string

当前销售员名

-

     └─followType

string

跟进类型,visit:拜访

-

     └─followDate

string

跟进日期

-

yyyy-MM-dd

     └─contactName

string

对接人

-

     └─contactPosition

string

对接人职务

-

     └─contactMobile

string

对接人联系方式

-

     └─flowContent

string

跟进内容

-

     └─enterpriseDesc

string

企业描述

-

     └─feedback

string

客户反馈

-

     └─imgList

array

跟进照片

-

""","""

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "customerId": 0,
        "opportunityId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "followType": "",
        "followDate": "yyyy-MM-dd",
        "contactName": "",
        "contactPosition": "",
        "contactMobile": "",
        "flowContent": "",
        "enterpriseDesc": "",
        "feedback": "",
        "imgList": [
          ""
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.9.分级列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 分级列表

Body-parameters:

Parameter Type Description Required Since Example

gradeCodeList

array

分级编码

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/grade/list' --data '{
  "gradeCodeList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─gradeCode

string

等级编码

-

└─royaltyRate

number

提成比例,0-1

-

0

└─enabled

boolean

是否启用

-

true

└─remark

string

备注

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "gradeCode": "",
      "royaltyRate": 0,
      "enabled": true,
      "remark": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.5.10.销售员列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售员列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

No comments found.

false

-

salesmanIds

array

销售员id

false

-

"0,0"

roleType

string

角色类型,inner-内部员工,outer-外部推广人

false

-

excludeSalesmanIds

array

No comments found.

false

-

"0,0"

customerId

int64

No comments found.

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/salesman/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "salesmanIds": [
    0
  ],
  "roleType": "",
  "excludeSalesmanIds": [
    0
  ],
  "customerId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─salesmanId

int64

销售员id

-

0

     └─salesmanStaffId

int64

销售员员工id

-

0

     └─salesmanName

string

销售员名称

-

     └─mobile

string

手机号

-

     └─email

string

邮箱

-

     └─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

     └─beePriceConfigList

array

api价格配置,详情才会返回

-

          └─checkItem

string

产品编码

-

          └─itemName

string

产品名称

-

          └─checkType

int32

产品类型: 100基础查询 101画像查询 110标签查询 111 黑名单查询 112 模型查询 200核验 300工具 400其他

-

0

          └─feeType

int32

计费方式,10-查询计费,20-查得计费

-

0

          └─price

number

单价

-

0

          └─floorPrice

number

销售底价

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "salesmanId": 0,
        "salesmanStaffId": 0,
        "salesmanName": "",
        "mobile": "",
        "email": "",
        "roleType": "",
        "beePriceConfigList": [
          {
            "checkItem": "",
            "itemName": "",
            "checkType": 0,
            "feeType": 0,
            "price": 0,
            "floorPrice": 0
          }
        ]
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.11.直客列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 直客列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/organization/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

机构编码

-

     └─orgName

string

机构名称

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "orgCode": "",
        "orgName": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.12.设置ip白名单

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 设置ip白名单

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

enable

boolean

是否开启白名单

true

-

true

ipList

string

白名单ip,多个逗号分割,enable为true时必填

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/saveWhiteIpList' --data '{
  "deptId": 0,
  "enable": true,
  "ipList": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.5.13.发送开发者信息

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 发送开发者信息

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

开发者账号id

true

-

0

method

enum

发送方式,sms-短信,email-邮箱
(See: 验证码渠道)

true

-

SMS

receiver

string

接收人

true

-

ccList

array

抄送人

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/sendDeveloperInfo' --data '{
  "deptId": 0,
  "method": "",
  "receiver": "",
  "ccList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.5.14.销售客户统计列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售客户统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/customerStatisticsList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─organizationId

int64

组织id

-

0

     └─merchantId

int64

商户id

-

0

     └─mobile

string

手机号

-

     └─organizationName

string

组织名称

-

     └─aliasName

string

组织别名

-

     └─state

int32

企业状态,0:待审核,10:正常

-

0

     └─overdraftType

enum

超支类型

-

UNACTIVATED

     └─logo

string

企业logo

-

     └─assistantId

int64

维护人id

-

0

     └─assistantName

string

维护人姓名

-

     └─linkman

string

联系人

-

     └─linkMobile

string

联系方式

-

     └─email

string

邮箱

-

     └─customerType

int32

客户类型,10-试用客户,20-正式客户

-

0

     └─industry

string

所属行业

-

     └─enableDevelop

boolean

开发者权限是否开通

-

true

     └─deptId

int64

开发账户id

-

0

     └─appId

string

接口appId

-

     └─appSecret

string

接口密钥,

-

     └─authRecord

object

认证记录

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─userId

int64

用户id

-

0

          └─authType

int32

认证类型,0-未认证,10-个人认证,20-企业认证

-

0

          └─state

int32

状态

-

0

          └─enterpriseName

string

企业姓名

-

          └─enterpriseNo

string

统一社会信用编码

-

          └─realName

string

真实姓名/法人姓名

-

          └─idCard

string

身份证号/法人身份证

-

          └─mobile

string

手机号

-

          └─businessImg

string

营业执照

-

          └─idCardFront

string

身份证/法人身份证正面

-

          └─idCardBack

string

法人身份证法人身份证反面

-

          └─workspaceImgList

array

办公场所

-

""","""

          └─certificationList

array

资质文件

-

""","""

          └─linkman

string

联系人

-

          └─linkMobile

string

联系电话

-

          └─linkEmail

string

联系人邮箱

-

          └─linkPosition

string

联系人职位

-

          └─businessDesc

string

业务介绍

-

          └─addressInfo

object

地址

-

               └─id

int64

id

-

0

               └─provinceCode

string

省编码

-

               └─provinceName

string

省名称

-

               └─cityCode

string

市编码

-

               └─cityName

string

市名称

-

               └─districtCode

string

区县编码

-

               └─districtName

string

区县名称

-

               └─streetCode

string

街道编码

-

               └─streetName

string

街道编名称

-

               └─addressDetail

string

详细地址

-

               └─fullAddress

string

完整地址

-

          └─industry

enum

行业编码

-

LEASE3C

          └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

          └─auditRemark

string

审核意见

-

          └─sourceAppcode

string

注册系统编码

-

          └─tenantId

int64

租户id

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─certificationList

array

资质文件

-

""","""

     └─whiteIpList

string

ip白名单

-

     └─addressInfo

object

地址信息

-

          └─id

int64

id

-

0

          └─provinceCode

string

省编码

-

          └─provinceName

string

省名称

-

          └─cityCode

string

市编码

-

          └─cityName

string

市名称

-

          └─districtCode

string

区县编码

-

          └─districtName

string

区县名称

-

          └─streetCode

string

街道编码

-

          └─streetName

string

街道编名称

-

          └─addressDetail

string

详细地址

-

          └─fullAddress

string

完整地址

-

     └─sourceAppcode

string

注册系统编码

-

     └─enabledApps

array

已开通应用编码

-

          └─appcode

string

应用编码

-

          └─appName

string

应用名称

-

          └─appType

string

应用类型,miniapp-小程序,mp-公众号

-

          └─systemCode

string

所属系统编码

-

          └─domain

string

域名

-

          └─logo

string

应用logo

-

          └─tenantId

int64

默认所属租户id

-

0

          └─bizAppList

array

关联的业务系统

-

     └─nearFollowDate

string

最近跟进时间

-

yyyy-MM-dd

     └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─gradeCode

string

客户分级

-

     └─royaltyRate

number

提成比例,0-1

-

0

     └─gainChannel

string

获客渠道

-

     └─enterpriseDesc

string

企业描述

-

     └─customerNature

string

客户业务类型

-

     └─opportunitySalesmanId

int64

商机业务员id

-

0

     └─opportunityRoleType

string

商机业务员类型

-

     └─salesAmount

number

总金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "organizationId": 0,
        "merchantId": 0,
        "mobile": "",
        "organizationName": "",
        "aliasName": "",
        "state": 0,
        "overdraftType": 0,
        "logo": "",
        "assistantId": 0,
        "assistantName": "",
        "linkman": "",
        "linkMobile": "",
        "email": "",
        "customerType": 0,
        "industry": "",
        "enableDevelop": true,
        "deptId": 0,
        "appId": "",
        "appSecret": "",
        "authRecord": {
          "id": 0,
          "createBy": 0,
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "modifyTime": "yyyy-MM-dd HH:mm:ss",
          "userId": 0,
          "authType": 0,
          "state": 0,
          "enterpriseName": "",
          "enterpriseNo": "",
          "realName": "",
          "idCard": "",
          "mobile": "",
          "businessImg": "",
          "idCardFront": "",
          "idCardBack": "",
          "workspaceImgList": [
            ""
          ],
          "certificationList": [
            ""
          ],
          "linkman": "",
          "linkMobile": "",
          "linkEmail": "",
          "linkPosition": "",
          "businessDesc": "",
          "addressInfo": {
            "id": 0,
            "provinceCode": "",
            "provinceName": "",
            "cityCode": "",
            "cityName": "",
            "districtCode": "",
            "districtName": "",
            "streetCode": "",
            "streetName": "",
            "addressDetail": "",
            "fullAddress": ""
          },
          "industry": "",
          "auditTime": "yyyy-MM-dd HH:mm:ss",
          "auditRemark": "",
          "sourceAppcode": "",
          "tenantId": 0
        },
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "certificationList": [
          ""
        ],
        "whiteIpList": "",
        "addressInfo": {
          "id": 0,
          "provinceCode": "",
          "provinceName": "",
          "cityCode": "",
          "cityName": "",
          "districtCode": "",
          "districtName": "",
          "streetCode": "",
          "streetName": "",
          "addressDetail": "",
          "fullAddress": ""
        },
        "sourceAppcode": "",
        "enabledApps": [
          {
            "appcode": "",
            "appName": "",
            "appType": "",
            "systemCode": "",
            "domain": "",
            "logo": "",
            "tenantId": 0,
            "bizAppList": [
              {
                "$ref": ".."
              }
            ]
          }
        ],
        "nearFollowDate": "yyyy-MM-dd",
        "assignTime": "yyyy-MM-dd HH:mm:ss",
        "gradeCode": "",
        "royaltyRate": 0,
        "gainChannel": "",
        "enterpriseDesc": "",
        "customerNature": "",
        "opportunitySalesmanId": 0,
        "opportunityRoleType": "",
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.15.销售客户产品统计列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售客户产品统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/deptItemStatisticsList' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─checkItem

string

检测项

-

     └─itemName

string

检测项名称

-

     └─usedVersion

string

开通版本

-

     └─checkType

int32

检测类型 1:身份维度 2:手机维度 3:两者都包含

-

0

     └─isOpen

int32

是否启用

-

0

     └─price

number

单价

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─state

int32

状态,0:待审核,10:已开通,-1:已禁用,-10:已驳回

-

0

     └─fee

number

费用

-

0

     └─chargeType

int32

计费方式 10 按实际子项计费 20一口价

-

0

     └─feeType

int32

计费类型,10-查询计费,20-查得计费

-

0

     └─isFusion

boolean

是否是聚合产品

-

true

     └─feeDetail

string

费用明细

-

     └─freeCount

int32

免费次数

-

0

     └─applyRemark

string

申请备注

-

     └─auditRemark

string

审核备注(驳回原因)

-

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─taskAble

boolean

是否可在线测试

-

true

     └─categoryCode

string

分类编码

-

     └─categoryName

string

分类编码

-

     └─docUrl

string

文档下载地址

-

     └─respTime

string

响应时间

-

     └─backgroundImg

string

背景图

-

     └─description

string

描述

-

     └─isCollected

boolean

是否已收藏

-

true

     └─createDate

string

申请时间

-

yyyy-MM-dd HH:mm:ss

     └─applicable

boolean

是否可以在线申请

-

true

     └─cacheFetchDays

int32

取缓存有效天数

-

0

     └─isHidden

boolean

是否隐藏

-

true

     └─adjusting

object

调整中记录

-

          └─id

int64

主键

-

0

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─updateDate

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构id

-

          └─deptItemId

int64

机构单项费用id

-

0

          └─checkItem

string

检测项

-

          └─itemName

string

检测项

-

          └─state

int32

状态,-10:已驳回,-1:已取消,0:未生效,10:待审核,20:已变更

-

0

          └─beforeFee

number

变更前费用

-

0

          └─beforeFeeDetail

string

变更前费用明细

-

          └─beforeChargeType

int32

变更前计费类型 10 按实际子项计费 20一口价

-

0

          └─beforeFeeType

int32

变更前计费方式,10-查询计费,20-查得计费

-

0

          └─afterFee

number

变更后费用

-

0

          └─afterFeeDetail

string

变更后费用明细

-

          └─afterChargeType

int32

变更后计费类型 10 按实际子项计费 20一口价

-

0

          └─afterFeeType

int32

变更后计费方式,10-查询计费,20-查得计费

-

0

          └─planTime

string

计划生效时间

-

yyyy-MM-dd HH:mm:ss

          └─effectTime

string

实际生效时间

-

yyyy-MM-dd HH:mm:ss

     └─orgCode

string

组织编码

-

     └─riskThreshold

number

风险阈值

-

0

     └─hasAssignSource

boolean

是否指定数据源

-

true

     └─spreaderRoyalties

array

推广方提成配置

-

          └─id

int64

主键

-

0

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─customerId

int64

客户id

-

0

          └─customerName

string

客户名

-

          └─deptId

int64

客户组织id

-

0

          └─spreaderId

int64

当前销售员id

-

0

          └─spreaderName

string

当前销售员名

-

          └─deptItemId

int64

授权记录id

-

0

          └─checkItem

string

产品编码

-

          └─royaltyType

string

提成计算方式

-

          └─royaltyPrice

number

单笔提成金额

-

0

          └─royaltyRate

number

提成比例

-

0

          └─state

enum

是否绑定中

-

INVALID

          └─effectMonth

string

生效月份

-

          └─assignTime

string

指派时间

-

yyyy-MM-dd HH:mm:ss

     └─salesAmount

number

总金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "updateDate": "yyyy-MM-dd HH:mm:ss",
        "checkItem": "",
        "itemName": "",
        "usedVersion": "",
        "checkType": 0,
        "isOpen": 0,
        "price": 0,
        "deptId": 0,
        "deptName": "",
        "state": 0,
        "fee": 0,
        "chargeType": 0,
        "feeType": 0,
        "isFusion": true,
        "feeDetail": "",
        "freeCount": 0,
        "applyRemark": "",
        "auditRemark": "",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "taskAble": true,
        "categoryCode": "",
        "categoryName": "",
        "docUrl": "",
        "respTime": "",
        "backgroundImg": "",
        "description": "",
        "isCollected": true,
        "createDate": "yyyy-MM-dd HH:mm:ss",
        "applicable": true,
        "cacheFetchDays": 0,
        "isHidden": true,
        "adjusting": {
          "id": 0,
          "createDate": "yyyy-MM-dd HH:mm:ss",
          "updateDate": "yyyy-MM-dd HH:mm:ss",
          "deptId": 0,
          "deptName": "",
          "deptItemId": 0,
          "checkItem": "",
          "itemName": "",
          "state": 0,
          "beforeFee": 0,
          "beforeFeeDetail": "",
          "beforeChargeType": 0,
          "beforeFeeType": 0,
          "afterFee": 0,
          "afterFeeDetail": "",
          "afterChargeType": 0,
          "afterFeeType": 0,
          "planTime": "yyyy-MM-dd HH:mm:ss",
          "effectTime": "yyyy-MM-dd HH:mm:ss"
        },
        "orgCode": "",
        "riskThreshold": 0,
        "hasAssignSource": true,
        "spreaderRoyalties": [
          {
            "id": 0,
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "customerId": 0,
            "customerName": "",
            "deptId": 0,
            "spreaderId": 0,
            "spreaderName": "",
            "deptItemId": 0,
            "checkItem": "",
            "royaltyType": "",
            "royaltyPrice": 0,
            "royaltyRate": 0,
            "state": 0,
            "effectMonth": "",
            "assignTime": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.16.销售客户产品统计列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售客户产品统计列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/deptItemStatisticsSum' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─salesAmount

number

总金额

-

0

└─chargeCalls

int32

计费笔数

-

0

└─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "salesAmount": 0,
    "chargeCalls": 0,
    "royaltyAmount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.17.销售客户产品统计导出

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 销售客户产品统计导出

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/deptItemStatisticsExport' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.5.18.添加商机

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 添加商机

Body-parameters:

Parameter Type Description Required Since Example

id

int64

不为空代表编辑

false

-

0

customerName

string

客户名

true

-

contactName

string

联系人

false

-

contactMobile

string

联系方式

false

-

customerNature

string

客户业务类型

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/opportunity/save' --data '{
  "id": 0,
  "customerName": "",
  "contactName": "",
  "contactMobile": "",
  "customerNature": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

int64

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": 0,
  "timestamp": 0,
  "traceId": ""
}

4.5.19.商机列表

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 商机列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

关键字

false

-

createTimeGte

string

创建时间大于等于

false

-

yyyy-MM-dd HH:mm:ss

createTimeLte

string

创建时间小于等于

false

-

yyyy-MM-dd HH:mm:ss

hiddenConverted

boolean

已转客户是否隐藏,默认true

false

-

true

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/opportunity/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "createTimeGte": "yyyy-MM-dd HH:mm:ss",
  "createTimeLte": "yyyy-MM-dd HH:mm:ss",
  "hiddenConverted": true
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─customerName

string

客户名

-

     └─contactName

string

联系人

-

     └─contactMobile

string

联系方式

-

     └─customerNature

string

客户业务类型

-

     └─salesmanId

int64

当前销售员id

-

0

     └─salesmanName

string

当前销售员名

-

     └─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

     └─customerId

int64

转客户id

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "customerName": "",
        "contactName": "",
        "contactMobile": "",
        "customerNature": "",
        "salesmanId": 0,
        "salesmanName": "",
        "roleType": "",
        "customerId": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.5.20.删除商机

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 删除商机

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/opportunity/delete' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.5.21.调用趋势统计

Type: POST

Author: wangqidong created on 2025/8/18

Content-Type: application/json

Description: 调用趋势统计

Body-parameters:

Parameter Type Description Required Since Example

customerIds

array

客户id

false

-

"0,0"

checkItemList

array

产品编码

false

-

""","""

matchMonth

string

匹配月份

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/customer/salesTrendStatisticsList' --data '{
  "customerIds": [
    0
  ],
  "checkItemList": [
    ""
  ],
  "matchMonth": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalSalesAmount

number

总金额

-

0

└─totalChargeCalls

int32

总计费笔数

-

0

└─totalRoyaltyAmount

number

总提成金额(不考虑绩效目标)

-

0

└─details

array

明细

-

     └─statisticsDate

string

统计日期

-

     └─salesAmount

number

销售金额

-

0

     └─chargeCalls

int32

计费笔数

-

0

     └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

     └─items

array

明细

-

          └─checkItem

string

产品编码

-

          └─itemName

string

产品名称

-

          └─salesAmount

number

销售金额

-

0

          └─chargeCalls

int32

计费笔数

-

0

          └─royaltyAmount

number

预计提成金额(不考虑绩效目标)

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalSalesAmount": 0,
    "totalChargeCalls": 0,
    "totalRoyaltyAmount": 0,
    "details": [
      {
        "statisticsDate": "",
        "salesAmount": 0,
        "chargeCalls": 0,
        "royaltyAmount": 0,
        "items": [
          {
            "checkItem": "",
            "itemName": "",
            "salesAmount": 0,
            "chargeCalls": 0,
            "royaltyAmount": 0
          }
        ]
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

4.6.登录相关

4.6.1.查询登录信息

Type: GET

Author: wangqidong created on 2025/9/23

Content-Type: application/x-www-form-urlencoded

Description: 查询登录信息

Request-example:

curl -X GET -i '/mt/sales/login/querySession'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─loginId

string

登录id

-

└─stoken

string

登录token

-

└─userId

int64

用户id

-

0

└─username

string

用户名

-

└─nickname

string

昵称

-

└─mobile

string

手机号

-

└─merchantId

int64

当前登录的商户id

-

0

└─merchantName

string

商户名

-

└─enterpriseId

int64

企业id

-

0

└─enterpriseName

string

企业名称

-

└─industry

string

所属行业

-

└─authType

int32

登录用户认证类型,0-未认证,10-个人认证,20-企业认证

-

0

└─loginAppCode

string

登录端code

-

└─appcode

string

当前访问端code

-

└─appName

string

当前访问端名称

-

└─bizAppcode

string

业务应用编码(适用于管理后台访问业务数据)

-

└─requestIp

string

请求ip

-

└─agentId

int64

当前应用下代理id

-

0

└─salesmanId

int64

销售id

-

0

└─assistantId

int64

维护人id

-

0

└─tenantId

int64

租户id

-

0

└─bizTenantId

int64

业务租户id

-

0

└─tenantOwnerId

int64

租户所有者用户id

-

0

└─realName

string

真实姓名

-

└─linkman

string

联系人(商户)

-

└─linkMobile

string

联系方式(商户)

-

└─email

string

邮箱(商户)

-

└─isTemp

boolean

是否临时登录

-

true

└─terminal

enum

终端类型,android-安卓,ios-ios,harmony-鸿蒙
(See: 应用终端类型)

-

ANDROID

└─iv

int32

当前内部版本号

-

0

└─isTest

boolean

是否测试用户

-

true

└─refreshTime

int64

刷新时间戳

-

0

└─roleType

string

角色类型,inner-内部员工,outer-外部推广人

-

└─isAppManage

boolean

是否是app管理员

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "loginId": "",
    "stoken": "",
    "userId": 0,
    "username": "",
    "nickname": "",
    "mobile": "",
    "merchantId": 0,
    "merchantName": "",
    "enterpriseId": 0,
    "enterpriseName": "",
    "industry": "",
    "authType": 0,
    "loginAppCode": "",
    "appcode": "",
    "appName": "",
    "bizAppcode": "",
    "requestIp": "",
    "agentId": 0,
    "salesmanId": 0,
    "assistantId": 0,
    "tenantId": 0,
    "bizTenantId": 0,
    "tenantOwnerId": 0,
    "realName": "",
    "linkman": "",
    "linkMobile": "",
    "email": "",
    "isTemp": true,
    "terminal": "",
    "iv": 0,
    "isTest": true,
    "refreshTime": 0,
    "roleType": "",
    "isAppManage": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.6.2.编辑基本信息

Type: POST

Author: wangqidong created on 2025/9/23

Content-Type: application/json

Description: 发送验证码场景编码,修改手机号:bindMobile,修改密码:resetPassword

Body-parameters:

Parameter Type Description Required Since Example

mobile

string

手机号

false

-

email

string

邮箱

false

-

smsCode

string

验证码,修改手机号和密码时必须

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/login/editInfo' --data '{
  "mobile": "",
  "email": "",
  "smsCode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.财务管理

4.7.1.客户账单

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 客户账单

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

billDateGte

string

账单月份大于

false

-

billDateLte

string

账单月份小于

false

-

statementNoList

array

账单编号

false

-

""","""

deptIdList

array

前端无需传递

false

-

"0,0"

stateList

array

账单状态

false

-

"0,0"

invoiceStateList

array

开票状态

false

-

"0,0"

overdraftTypeList

array

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

false

-

"0,0"

paymentStateList

array

回款状态,0:未回款,10:部分回款,20:已回款

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/billStatement/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "billDateGte": "",
  "billDateLte": "",
  "statementNoList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "invoiceStateList": [
    0
  ],
  "overdraftTypeList": [
    0
  ],
  "paymentStateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─userId

int64

客户id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─stateDesc

string

账单状态

-

     └─invoiceState

int32

开票状态

-

0

     └─totalAmount

number

总金额

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─notInvoicedAmount

number

未开票金额

-

0

     └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─billDetailList

array

账单明细(详情会返回)

-

          └─id

int64

No comments found.

-

0

          └─billDate

string

账单日期

-

          └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─checkItem

string

检测项

-

          └─checkItemName

string

检测项名称

-

          └─tag

string

标记

-

          └─dataSourceId

int32

数据源id

-

0

          └─dataSource

string

数据源

-

          └─dataSourceCode

string

数据源代号

-

          └─checkConfigId

int32

数据源配置id

-

0

          └─count

int32

调用笔数

-

0

          └─freeCount

int32

免费次数

-

0

          └─chargeCount

int32

计费次数

-

0

          └─price

number

单价

-

0

          └─totalFee

number

总费用

-

0

          └─totalCost

number

总成本

-

0

          └─settledAmount

number

已结算金额

-

0

          └─statementNo

string

对账单号

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─emails

array

通知邮箱地址

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─settledAmount

number

已结算金额

-

0

     └─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

     └─sendRecordList

array

账单发送记录

-

          └─receiverList

array

收件人

-

""","""

          └─ccList

array

抄送

-

""","""

          └─attachmentUrl

string

账单附件地址

-

          └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

          └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

     └─paymentStateDesc

string

回款状态

-

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "userId": 0,
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "stateDesc": "",
        "invoiceState": 0,
        "totalAmount": 0,
        "invoicedAmount": 0,
        "notInvoicedAmount": 0,
        "confirmDate": "yyyy-MM-dd HH:mm:ss",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "billDetailList": [
          {
            "id": 0,
            "billDate": "",
            "billType": "",
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "checkItem": "",
            "checkItemName": "",
            "tag": "",
            "dataSourceId": 0,
            "dataSource": "",
            "dataSourceCode": "",
            "checkConfigId": 0,
            "count": 0,
            "freeCount": 0,
            "chargeCount": 0,
            "price": 0,
            "totalFee": 0,
            "totalCost": 0,
            "settledAmount": 0,
            "statementNo": "",
            "createDate": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "emails": [
          ""
        ],
        "attachmentUrl": "",
        "settledAmount": 0,
        "overdraftType": 0,
        "sendRecordList": [
          {
            "receiverList": [
              ""
            ],
            "ccList": [
              ""
            ],
            "attachmentUrl": "",
            "sendTime": "yyyy-MM-dd HH:mm:ss",
            "state": 0
          }
        ],
        "paymentStateDesc": ""
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.2.修改账单

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 修改账单

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

statementNo

string

账单编号

true

-

canInvoiceAmount

number

可开票金额

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/modifyStatement' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "statementNo": "",
  "canInvoiceAmount": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.3.手动保存账单明细

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 手动保存账单明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id,不为空代表编辑

false

-

0

statementNo

string

对账单号,新增必填

false

-

checkItem

string

产品编码

true

-

checkItemName

string

产品名称

false

-

count

int32

调用笔数

false

-

0

chargeCount

int32

计费次数

false

-

0

price

number

单价

false

-

0

totalFee

number

总费用

false

-

0

settledAmount

number

已结算金额

false

-

0

receivableAmount

number

未结算金额

false

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/saveSubBill' --data '{
  "id": 0,
  "statementNo": "",
  "checkItem": "",
  "checkItemName": "",
  "count": 0,
  "chargeCount": 0,
  "price": 0,
  "totalFee": 0,
  "settledAmount": 0,
  "receivableAmount": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.4.账单详情

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 账单详情

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

statementNo

string

对账单号

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/detail' --data '{
  "deptId": 0,
  "statementNo": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

id

-

0

└─statementNo

string

账单编号

-

└─billDate

string

账单月份

-

└─userId

int64

客户id

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─appId

string

appid

-

└─state

int32

账单状态

-

0

└─stateDesc

string

账单状态

-

└─invoiceState

int32

开票状态

-

0

└─totalAmount

number

总金额

-

0

└─invoicedAmount

number

已开票金额

-

0

└─notInvoicedAmount

number

未开票金额

-

0

└─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

└─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

└─billDetailList

array

账单明细(详情会返回)

-

     └─id

int64

No comments found.

-

0

     └─billDate

string

账单日期

-

     └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─checkItem

string

检测项

-

     └─checkItemName

string

检测项名称

-

     └─tag

string

标记

-

     └─dataSourceId

int32

数据源id

-

0

     └─dataSource

string

数据源

-

     └─dataSourceCode

string

数据源代号

-

     └─checkConfigId

int32

数据源配置id

-

0

     └─count

int32

调用笔数

-

0

     └─freeCount

int32

免费次数

-

0

     └─chargeCount

int32

计费次数

-

0

     └─price

number

单价

-

0

     └─totalFee

number

总费用

-

0

     └─totalCost

number

总成本

-

0

     └─settledAmount

number

已结算金额

-

0

     └─statementNo

string

对账单号

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─emails

array

通知邮箱地址

-

""","""

└─attachmentUrl

string

账单附件地址

-

└─settledAmount

number

已结算金额

-

0

└─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

└─sendRecordList

array

账单发送记录

-

     └─receiverList

array

收件人

-

""","""

     └─ccList

array

抄送

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

     └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

└─paymentStateDesc

string

回款状态

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "statementNo": "",
    "billDate": "",
    "userId": 0,
    "deptId": 0,
    "deptName": "",
    "appId": "",
    "state": 0,
    "stateDesc": "",
    "invoiceState": 0,
    "totalAmount": 0,
    "invoicedAmount": 0,
    "notInvoicedAmount": 0,
    "confirmDate": "yyyy-MM-dd HH:mm:ss",
    "invoiceTime": "yyyy-MM-dd HH:mm:ss",
    "billDetailList": [
      {
        "id": 0,
        "billDate": "",
        "billType": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "checkItem": "",
        "checkItemName": "",
        "tag": "",
        "dataSourceId": 0,
        "dataSource": "",
        "dataSourceCode": "",
        "checkConfigId": 0,
        "count": 0,
        "freeCount": 0,
        "chargeCount": 0,
        "price": 0,
        "totalFee": 0,
        "totalCost": 0,
        "settledAmount": 0,
        "statementNo": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "emails": [
      ""
    ],
    "attachmentUrl": "",
    "settledAmount": 0,
    "overdraftType": 0,
    "sendRecordList": [
      {
        "receiverList": [
          ""
        ],
        "ccList": [
          ""
        ],
        "attachmentUrl": "",
        "sendTime": "yyyy-MM-dd HH:mm:ss",
        "state": 0
      }
    ],
    "paymentStateDesc": ""
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.5.归档

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 归档

Body-parameters:

Parameter Type Description Required Since Example

ids

array

ids

true

-

"0,0"

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/archive' --data '{
  "ids": [
    0
  ],
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.6.移除账单明细

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 移除账单明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/removeSubBill' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.7.合并账单明细

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 合并账单明细

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

组织id

true

-

0

statementNo

string

对账单号

true

-

mergeDetailIds

array

合并明细id

true

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/mergeDetail' --data '{
  "deptId": 0,
  "statementNo": "",
  "mergeDetailIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.8.核准账单

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 核准账单

Body-parameters:

Parameter Type Description Required Since Example

billId

int64

账单id

true

-

0

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/recheck' --data '{
  "billId": 0
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.9.账单导出

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 账单导出

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

keyword

string

搜索关键字

false

-

billDateGte

string

账单月份大于

false

-

billDateLte

string

账单月份小于

false

-

statementNoList

array

账单编号

false

-

""","""

deptIdList

array

前端无需传递

false

-

"0,0"

stateList

array

账单状态

false

-

"0,0"

invoiceStateList

array

开票状态

false

-

"0,0"

overdraftTypeList

array

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

false

-

"0,0"

paymentStateList

array

回款状态,0:未回款,10:部分回款,20:已回款

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/billStatement/export' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "keyword": "",
  "billDateGte": "",
  "billDateLte": "",
  "statementNoList": [
    ""
  ],
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ],
  "invoiceStateList": [
    0
  ],
  "overdraftTypeList": [
    0
  ],
  "paymentStateList": [
    0
  ]
}'

Response-example:

Return void.

4.7.10.应收账款

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 应收账款

Body-parameters:

Parameter Type Description Required Since Example

customerIds

array

客户id

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/payment/receivableBillList' --data '{
  "customerIds": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─receivableAmount

number

应收账款

-

0

└─receivableCount

int32

账单数

-

0

└─lastPaymentDate

string

最近回款日期

-

yyyy-MM-dd

└─linkman

string

联系人

-

└─linkMobile

string

联系方式

-

└─statementList

array

账单明细

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─userId

int64

客户id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─stateDesc

string

账单状态

-

     └─invoiceState

int32

开票状态

-

0

     └─totalAmount

number

总金额

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─notInvoicedAmount

number

未开票金额

-

0

     └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─billDetailList

array

账单明细(详情会返回)

-

          └─id

int64

No comments found.

-

0

          └─billDate

string

账单日期

-

          └─billType

string

账单类型 cust_daily客户每日账单。cust_monthly客户月度账单 source_daily数据源每日账单 source_monthly数据源月账单

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─checkItem

string

检测项

-

          └─checkItemName

string

检测项名称

-

          └─tag

string

标记

-

          └─dataSourceId

int32

数据源id

-

0

          └─dataSource

string

数据源

-

          └─dataSourceCode

string

数据源代号

-

          └─checkConfigId

int32

数据源配置id

-

0

          └─count

int32

调用笔数

-

0

          └─freeCount

int32

免费次数

-

0

          └─chargeCount

int32

计费次数

-

0

          └─price

number

单价

-

0

          └─totalFee

number

总费用

-

0

          └─totalCost

number

总成本

-

0

          └─settledAmount

number

已结算金额

-

0

          └─statementNo

string

对账单号

-

          └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─emails

array

通知邮箱地址

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─settledAmount

number

已结算金额

-

0

     └─overdraftType

int32

超支类型,0-预充值,10-预充值(额度内可超支),20-月结

-

0

     └─sendRecordList

array

账单发送记录

-

          └─receiverList

array

收件人

-

""","""

          └─ccList

array

抄送

-

""","""

          └─attachmentUrl

string

账单附件地址

-

          └─sendTime

string

发送时间

-

yyyy-MM-dd HH:mm:ss

          └─state

int32

发送状态,0:发送中,-1:发送失败,1:发送成功

-

0

     └─paymentStateDesc

string

回款状态

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "customerId": 0,
      "customerName": "",
      "receivableAmount": 0,
      "receivableCount": 0,
      "lastPaymentDate": "yyyy-MM-dd",
      "linkman": "",
      "linkMobile": "",
      "statementList": [
        {
          "id": 0,
          "statementNo": "",
          "billDate": "",
          "userId": 0,
          "deptId": 0,
          "deptName": "",
          "appId": "",
          "state": 0,
          "stateDesc": "",
          "invoiceState": 0,
          "totalAmount": 0,
          "invoicedAmount": 0,
          "notInvoicedAmount": 0,
          "confirmDate": "yyyy-MM-dd HH:mm:ss",
          "invoiceTime": "yyyy-MM-dd HH:mm:ss",
          "billDetailList": [
            {
              "id": 0,
              "billDate": "",
              "billType": "",
              "deptId": 0,
              "deptName": "",
              "appId": "",
              "checkItem": "",
              "checkItemName": "",
              "tag": "",
              "dataSourceId": 0,
              "dataSource": "",
              "dataSourceCode": "",
              "checkConfigId": 0,
              "count": 0,
              "freeCount": 0,
              "chargeCount": 0,
              "price": 0,
              "totalFee": 0,
              "totalCost": 0,
              "settledAmount": 0,
              "statementNo": "",
              "createDate": "yyyy-MM-dd HH:mm:ss"
            }
          ],
          "emails": [
            ""
          ],
          "attachmentUrl": "",
          "settledAmount": 0,
          "overdraftType": 0,
          "sendRecordList": [
            {
              "receiverList": [
                ""
              ],
              "ccList": [
                ""
              ],
              "attachmentUrl": "",
              "sendTime": "yyyy-MM-dd HH:mm:ss",
              "state": 0
            }
          ],
          "paymentStateDesc": ""
        }
      ]
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.7.11.回款记录列表

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 回款记录列表

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

customerIds

array

客户id

false

-

"0,0"

stateList

array

客户名

false

-

"0,0"

paymentDateGte

string

回款日期

false

-

yyyy-MM-dd

paymentDateLte

string

回款日期

false

-

yyyy-MM-dd

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/payment/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "customerIds": [
    0
  ],
  "stateList": [
    0
  ],
  "paymentDateGte": "yyyy-MM-dd",
  "paymentDateLte": "yyyy-MM-dd"
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

主键

-

0

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─paymentNo

string

回款单号

-

     └─customerId

int64

客户id

-

0

     └─customerName

string

客户名

-

     └─salesmanId

int64

回款销售员id

-

0

     └─salesmanName

string

回款销售员名称

-

     └─amount

number

回款金额

-

0

     └─residueAmount

number

结清账单剩余金额(充值到账户)

-

0

     └─afterDebtAmount

number

剩余未回款金额

-

0

     └─state

int32

状态,0:待审核,10:已通过,-10:已驳回

-

0

     └─paymentDate

string

回款日期

-

yyyy-MM-dd

     └─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

     └─certificateList

array

回款凭证,多个逗号分割

-

""","""

     └─remark

string

备注

-

     └─settleDetails

array

账单结算明细,详情接口返回

-

          └─createBy

int64

创建人id

-

0

          └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

          └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

          └─id

int64

id

-

0

          └─statementNo

string

账单编号

-

          └─billDate

string

账单月份

-

          └─userId

int64

客户id

-

0

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─state

int32

账单状态

-

0

          └─stateDesc

string

账单状态

-

          └─invoiceState

int32

开票状态

-

0

          └─totalAmount

number

总金额

-

0

          └─invoicedAmount

number

已开票金额

-

0

          └─notInvoicedAmount

number

未开票金额

-

0

          └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

          └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

          └─emails

array

通知邮箱地址

-

""","""

          └─attachmentUrl

string

账单附件地址

-

          └─paymentAmount

number

已回款金额

-

0

          └─settleAmount

number

该笔回款结算金额

-

0

     └─rejectReason

string

驳回原因

-

     └─royaltyRate

number

提成比例

-

0

     └─royaltyAmount

number

提成金额

-

0

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "paymentNo": "",
        "customerId": 0,
        "customerName": "",
        "salesmanId": 0,
        "salesmanName": "",
        "amount": 0,
        "residueAmount": 0,
        "afterDebtAmount": 0,
        "state": 0,
        "paymentDate": "yyyy-MM-dd",
        "auditTime": "yyyy-MM-dd HH:mm:ss",
        "certificateList": [
          ""
        ],
        "remark": "",
        "settleDetails": [
          {
            "createBy": 0,
            "createTime": "yyyy-MM-dd HH:mm:ss",
            "modifyTime": "yyyy-MM-dd HH:mm:ss",
            "id": 0,
            "statementNo": "",
            "billDate": "",
            "userId": 0,
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "state": 0,
            "stateDesc": "",
            "invoiceState": 0,
            "totalAmount": 0,
            "invoicedAmount": 0,
            "notInvoicedAmount": 0,
            "confirmDate": "yyyy-MM-dd HH:mm:ss",
            "invoiceTime": "yyyy-MM-dd HH:mm:ss",
            "emails": [
              ""
            ],
            "attachmentUrl": "",
            "paymentAmount": 0,
            "settleAmount": 0
          }
        ],
        "rejectReason": "",
        "royaltyRate": 0,
        "royaltyAmount": 0
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.12.回款记录详情

Type: GET

Author: wangqidong created on 2025/8/19

Content-Type: application/x-www-form-urlencoded

Description: 回款记录详情

Path-parameters:

Parameter Type Description Required Since Example

paymentNo

string

No comments found.

true

-

Request-example:

curl -X GET -i '/mt/sales/finance/payment/detail/{paymentNo}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─paymentNo

string

回款单号

-

└─customerId

int64

客户id

-

0

└─customerName

string

客户名

-

└─salesmanId

int64

回款销售员id

-

0

└─salesmanName

string

回款销售员名称

-

└─amount

number

回款金额

-

0

└─residueAmount

number

结清账单剩余金额(充值到账户)

-

0

└─afterDebtAmount

number

剩余未回款金额

-

0

└─state

int32

状态,0:待审核,10:已通过,-10:已驳回

-

0

└─paymentDate

string

回款日期

-

yyyy-MM-dd

└─auditTime

string

审核时间

-

yyyy-MM-dd HH:mm:ss

└─certificateList

array

回款凭证,多个逗号分割

-

""","""

└─remark

string

备注

-

└─settleDetails

array

账单结算明细,详情接口返回

-

     └─createBy

int64

创建人id

-

0

     └─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

     └─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─userId

int64

客户id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─stateDesc

string

账单状态

-

     └─invoiceState

int32

开票状态

-

0

     └─totalAmount

number

总金额

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─notInvoicedAmount

number

未开票金额

-

0

     └─confirmDate

string

确认时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─emails

array

通知邮箱地址

-

""","""

     └─attachmentUrl

string

账单附件地址

-

     └─paymentAmount

number

已回款金额

-

0

     └─settleAmount

number

该笔回款结算金额

-

0

└─rejectReason

string

驳回原因

-

└─royaltyRate

number

提成比例

-

0

└─royaltyAmount

number

提成金额

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "createBy": 0,
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "modifyTime": "yyyy-MM-dd HH:mm:ss",
    "paymentNo": "",
    "customerId": 0,
    "customerName": "",
    "salesmanId": 0,
    "salesmanName": "",
    "amount": 0,
    "residueAmount": 0,
    "afterDebtAmount": 0,
    "state": 0,
    "paymentDate": "yyyy-MM-dd",
    "auditTime": "yyyy-MM-dd HH:mm:ss",
    "certificateList": [
      ""
    ],
    "remark": "",
    "settleDetails": [
      {
        "createBy": 0,
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "modifyTime": "yyyy-MM-dd HH:mm:ss",
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "userId": 0,
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "stateDesc": "",
        "invoiceState": 0,
        "totalAmount": 0,
        "invoicedAmount": 0,
        "notInvoicedAmount": 0,
        "confirmDate": "yyyy-MM-dd HH:mm:ss",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "emails": [
          ""
        ],
        "attachmentUrl": "",
        "paymentAmount": 0,
        "settleAmount": 0
      }
    ],
    "rejectReason": "",
    "royaltyRate": 0,
    "royaltyAmount": 0
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.13.新增回款

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 新增回款

Body-parameters:

Parameter Type Description Required Since Example

customerId

int64

客户id

true

-

0

amount

number

回款金额

true

-

0

paymentDate

string

回款日期

true

-

yyyy-MM-dd

certificateList

array

回款凭证,多个逗号分割

false

-

""","""

remark

string

备注

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/payment/add' --data '{
  "customerId": 0,
  "amount": 0,
  "paymentDate": "yyyy-MM-dd",
  "certificateList": [
    ""
  ],
  "remark": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.14.查询账单发送邮箱

Type: GET

Author: wangqidong created on 2025/8/19

Content-Type: application/x-www-form-urlencoded

Description: 查询账单发送邮箱

Path-parameters:

Parameter Type Description Required Since Example

deptId

int64

No comments found.

true

-

0

Request-example:

curl -X GET -i '/mt/sales/finance/billStatement/selectReceivers/{deptId}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─receiverList

array

收件人

-

""","""

└─ccList

array

抄送

-

""","""

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "receiverList": [
      ""
    ],
    "ccList": [
      ""
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.15.获取账单附件

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 获取账单附件

Body-parameters:

Parameter Type Description Required Since Example

billId

int64

账单id

true

-

0

rebuildForce

boolean

是否强制重新生成,默认false

false

-

true

appcode

string

No comments found.

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/billStatement/gainAttachment' --data '{
  "billId": 0,
  "rebuildForce": true,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

string

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.16.发送账单

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 发送账单

Body-parameters:

Parameter Type Description Required Since Example

billId

int64

账单id

true

-

0

receiverList

array

收件人 Validation[Size(max=10, min=0, message=收件人最多10个)]

true

-

""","""

ccList

array

抄送 Validation[Size(max=10, min=0, message=抄送最多10个)]

false

-

""","""

attachmentUrl

string

附件地址

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/billStatement/resend' --data '{
  "billId": 0,
  "receiverList": [
    ""
  ],
  "ccList": [
    ""
  ],
  "attachmentUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.17.完成开票

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 完成开票

Body-parameters:

Parameter Type Description Required Since Example

id

int64

开票记录id

true

-

0

invoiceUrl

string

发票文件地址

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoice/finish' --data '{
  "id": 0,
  "invoiceUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.18.未开票统计

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 未开票统计

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

statementNoList

array

账单编号,传null统计全部可开票账单

false

-

""","""

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoice/calculate' --data '{
  "deptId": 0,
  "statementNoList": [
    ""
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─totalAmountSum

number

账单金额合计

-

0

└─invoicedAmountSum

number

已开票金额合计

-

0

└─notInvoicedAmountSum

number

未开票金额

-

0

└─statementDetails

array

No comments found.

-

     └─statementId

int64

对账单id

-

0

     └─statementNo

string

对账单编号

-

     └─invoiceAmount

number

开票金额

-

0

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "totalAmountSum": 0,
    "invoicedAmountSum": 0,
    "notInvoicedAmountSum": 0,
    "statementDetails": [
      {
        "statementId": 0,
        "statementNo": "",
        "invoiceAmount": 0
      }
    ]
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.19.新增开票

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 新增开票

Body-parameters:

Parameter Type Description Required Since Example

deptId

int64

客户id

true

-

0

statementNoList

array

账单编号,不传默认全部开票

false

-

""","""

invoiceAmount

number

开票金额

true

-

0

invoiceType

string

开票类型,normal-普票,special-专票

true

-

headerName

string

抬头

true

-

tin

string

税号

true

-

email

string

邮箱

true

-

invoiceUrl

string

发票地址

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoice/add' --data '{
  "deptId": 0,
  "statementNoList": [
    ""
  ],
  "invoiceAmount": 0,
  "invoiceType": "",
  "headerName": "",
  "tin": "",
  "email": "",
  "invoiceUrl": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.20.发送发票到邮箱

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 发送发票到邮箱

Body-parameters:

Parameter Type Description Required Since Example

id

int64

开票记录id

true

-

0

email

string

邮箱 Validation[Pattern(regexp=(?:[a-z0-9!#$%&*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)]))]

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoice/sendEmail' --data '{
  "id": 0,
  "email": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "timestamp": 0,
  "traceId": ""
}

4.7.21.查询客户发票抬头

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 查询客户发票抬头

Body-parameters:

Parameter Type Description Required Since Example

userId

int64

客户id

true

-

0

invoiceType

string

开票类型,normal-普票,special-专票

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoiceHeader/list' --data '{
  "userId": 0,
  "invoiceType": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─id

int64

主键

-

0

└─createBy

int64

创建人id

-

0

└─createTime

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─modifyTime

string

修改时间

-

yyyy-MM-dd HH:mm:ss

└─userId

int64

用户id

-

0

└─username

string

用户名f

-

└─invoiceType

string

开票类型,normal-普票,special-专票

-

└─name

string

发票抬头

-

└─tin

string

税号

-

└─email

string

邮箱

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": 0,
      "createBy": 0,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "modifyTime": "yyyy-MM-dd HH:mm:ss",
      "userId": 0,
      "username": "",
      "invoiceType": "",
      "name": "",
      "tin": "",
      "email": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}

4.7.22.开票记录

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 开票记录

Body-parameters:

Parameter Type Description Required Since Example

pageNo

int32

页码,从1开始

false

-

0

pageSize

int32

每页条数

false

-

0

nonPage

boolean

是否不分页,nonPage和largePage都为true时优先nonPage

false

-

true

largePage

boolean

是否大数据量分页,nonPage和largePage都为true时优先nonPage

false

-

true

deptId

int64

机构id

false

-

0

deptIdList

array

机构id

false

-

"0,0"

stateList

array

开票状态

false

-

"0,0"

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoice/list' --data '{
  "pageNo": 0,
  "pageSize": 0,
  "nonPage": true,
  "largePage": true,
  "deptId": 0,
  "deptIdList": [
    0
  ],
  "stateList": [
    0
  ]
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─pageNo

int32

页码,从1开始

-

0

└─pageSize

int32

每页条数

-

0

└─hasNext

boolean

是否还有下一页

-

true

└─total

int64

总条数

-

0

└─results

array

当前页结果

-

     └─id

int64

id

-

0

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─invoiceType

string

开票类型,normal-普票,special-专票

-

     └─state

int32

开票状态

-

0

     └─invoiceAmount

number

开票金额

-

0

     └─statementList

array

包含的账单编号

-

          └─id

int64

id

-

0

          └─statementNo

string

账单编号

-

          └─billDate

string

账单月份

-

          └─deptId

int64

机构id

-

0

          └─deptName

string

机构名称

-

          └─appId

string

appid

-

          └─state

int32

账单状态

-

0

          └─invoiceState

int32

开票状态

-

0

          └─invoicedAmount

number

已开票金额

-

0

          └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

     └─headerName

string

发票抬头

-

     └─tin

string

税号

-

     └─email

string

邮箱

-

     └─invoiceTime

string

开具时间

-

yyyy-MM-dd HH:mm:ss

     └─invoiceUrl

string

发票地址

-

     └─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

└─isLarge

boolean

是否大数据分页

-

true

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "pageNo": 0,
    "pageSize": 0,
    "hasNext": true,
    "total": 0,
    "results": [
      {
        "id": 0,
        "deptId": 0,
        "deptName": "",
        "invoiceType": "",
        "state": 0,
        "invoiceAmount": 0,
        "statementList": [
          {
            "id": 0,
            "statementNo": "",
            "billDate": "",
            "deptId": 0,
            "deptName": "",
            "appId": "",
            "state": 0,
            "invoiceState": 0,
            "invoicedAmount": 0,
            "invoiceTime": "yyyy-MM-dd HH:mm:ss"
          }
        ],
        "headerName": "",
        "tin": "",
        "email": "",
        "invoiceTime": "yyyy-MM-dd HH:mm:ss",
        "invoiceUrl": "",
        "createDate": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "isLarge": true
  },
  "timestamp": 0,
  "traceId": ""
}

4.7.23.开票记录明细

Type: POST

Author: wangqidong created on 2025/8/19

Content-Type: application/json

Description: 开票记录明细

Body-parameters:

Parameter Type Description Required Since Example

id

int64

id

true

-

0

appcode

string

应用编码

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/finance/invoice/detail' --data '{
  "id": 0,
  "appcode": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

object

响应数据

-

└─id

int64

id

-

0

└─deptId

int64

机构id

-

0

└─deptName

string

机构名称

-

└─invoiceType

string

开票类型,normal-普票,special-专票

-

└─state

int32

开票状态

-

0

└─invoiceAmount

number

开票金额

-

0

└─statementList

array

包含的账单编号

-

     └─id

int64

id

-

0

     └─statementNo

string

账单编号

-

     └─billDate

string

账单月份

-

     └─deptId

int64

机构id

-

0

     └─deptName

string

机构名称

-

     └─appId

string

appid

-

     └─state

int32

账单状态

-

0

     └─invoiceState

int32

开票状态

-

0

     └─invoicedAmount

number

已开票金额

-

0

     └─invoiceTime

string

开票时间

-

yyyy-MM-dd HH:mm:ss

└─headerName

string

发票抬头

-

└─tin

string

税号

-

└─email

string

邮箱

-

└─invoiceTime

string

开具时间

-

yyyy-MM-dd HH:mm:ss

└─invoiceUrl

string

发票地址

-

└─createDate

string

创建时间

-

yyyy-MM-dd HH:mm:ss

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "deptId": 0,
    "deptName": "",
    "invoiceType": "",
    "state": 0,
    "invoiceAmount": 0,
    "statementList": [
      {
        "id": 0,
        "statementNo": "",
        "billDate": "",
        "deptId": 0,
        "deptName": "",
        "appId": "",
        "state": 0,
        "invoiceState": 0,
        "invoicedAmount": 0,
        "invoiceTime": "yyyy-MM-dd HH:mm:ss"
      }
    ],
    "headerName": "",
    "tin": "",
    "email": "",
    "invoiceTime": "yyyy-MM-dd HH:mm:ss",
    "invoiceUrl": "",
    "createDate": "yyyy-MM-dd HH:mm:ss"
  },
  "timestamp": 0,
  "traceId": ""
}

4.8.SalesBaseController

4.8.1.枚举列表

Type: POST

Author: wangqidong created on 2025/9/24

Content-Type: application/json

Description: 枚举列表

Body-parameters:

Parameter Type Description Required Since Example

className

string

枚举类名

true

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i '/mt/sales/base/enumList' --data '{
  "className": ""
}'

Response-fields:

Field Type Description Since Example

code

int32

响应码,0-成功

-

0

msg

string

响应提示

-

data

array

响应数据

-

└─code

string

No comments found.

-

└─desc

string

No comments found.

-

timestamp

int64

时间戳

-

0

traceId

string

请求链路id

-

Response-example:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "code": "",
      "desc": ""
    }
  ],
  "timestamp": 0,
  "traceId": ""
}
Top