版权所有©,上海海鼎信息工程股份有限公司,2016-2025,保留所有权利。

接口

1. 接口定义

1.1. 属性服务

1.1.1. 保存属性服务

POST /{tenant_id}/soms/optionservice/option
1.1.1.1. 说明

保存属性服务

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

option
必填

属性

1.1.1.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容

1.1.1.4. HTTP请求示例
请求 path
/string/soms/optionservice/option?operator=string
请求 body
{
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
}

1.1.2. 保存属性服务

POST /{tenant_id}/soms/optionservice/option/batchsave
1.1.2.1. 说明

保存属性服务

1.1.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

options
必填

属性

< Option > array

1.1.2.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容

1.1.2.4. HTTP请求示例
请求 path
/string/soms/optionservice/option/batchsave?operator=string
请求 body
[ {
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
} ]

1.1.3. 删除属性服务

POST /{tenant_id}/soms/optionservice/option/{type}/delete
1.1.3.1. 说明

删除属性服务

1.1.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型

string

Query

value
可选

string

1.1.3.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容

1.1.3.4. HTTP请求示例
请求 path
/string/soms/optionservice/option/string/delete

1.1.4. 获取属性服务

GET /{tenant_id}/soms/optionservice/options/{type}/getall
1.1.4.1. 说明

获取属性服务

1.1.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型:remind(催单)、comment(评论)

string

1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

1.1.4.4. HTTP请求示例
请求 path
/string/soms/optionservice/options/string/getall
1.1.4.5. HTTP响应示例
响应 200
{
  "options" : [ {
    "type" : "comment",
    "caption" : "说明",
    "value" : "欢迎下次光临",
    "extra" : {
      "auto" : true,
      "conditions" : [ {
        "satisfie_level" : "欢迎下次光临"
      } ]
    }
  } ]
}

1.1.5. 获取属性服务

GET /{tenant_id}/soms/optionservice/options/{type}/getoption
1.1.5.1. 说明

获取属性服务

1.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型:remind(催单)、comment(评论)

string

Query

value
可选

string

1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

1.1.5.4. HTTP请求示例
请求 path
/string/soms/optionservice/options/string/getoption
1.1.5.5. HTTP响应示例
响应 200
{
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
}

2. 定义

2.1. Option

文案选项

名称 说明 类型

caption
可选

说明
样例 : "说明"

string

extra
可选

扩展信息
样例 : OptionExtra

type
可选

类型:remind(催单)、comment(评论)、rtn.receivefailreason(退单收货失败原因)、adjustCategory(调整分类)
样例 : "comment"

string

value
可选

回复文案
样例 : "欢迎下次光临"

string

2.2. OptionExtra

扩展条件

名称 说明 类型

auto
可选

是否开启自动回复
默认值 : false
样例 : true

boolean

conditions
可选

自动回复条件
样例 : [ "OptionExtraCondition" ]

2.3. OptionExtraCondition

评价等级条件

名称 说明 类型

satisfie_level
可选

评价等级(好评:high;中评:medium;差评:low;)
样例 : "欢迎下次光临"

string

2.4. OptionList

文案选项列表

名称 说明 类型

options
可选

文案选项列表
样例 : [ "Option" ]

< Option > array