运营支持 API

接口声明

在调用接口时必须在 https 请求的 header 中携带 "token" 参数。

Token 是智齿客服接口开放平台全局唯一的接口调用凭据。 开发者在调用各业务接口时都需使用 Token，开发者需要进行妥善保存。 Token 的存储至少要保留 32 个字符空间。Token 的有效期目前为 24 个小时，需定时刷新，或根据接口返回的 Token 失效提示，进行重新获取。请求 Token 接口，无论 Token 是否存在，都会返回新的 Token，并重置 Token 的过期时间（目前 24 小时）。

Token 使用方式说明： 1、开发者需要统一获取和管理 Token，在调用智齿客服各个业务开放接口时都应该使用同一个的 Token，不应该每个业务都刷新获取新的 Token，否则容易导致 Token 失效，影响接口的正常调用； 2、目前 Token 的有效期通过返回的 expire_in 来传达，目前是 86,400 秒之内的值。开发者需要根据这个有效时间提前去刷新新 Token。 3、开发者需要根据接口返回的 Token 失效提示，进行重新获取 Token。

接口调用

● 获取Token

接口说明：

获取 API 开放接口 Token，此 Token 仅适用于智齿开放平台 5.0 版本全部 API 接口 。API 接口中的参数 appid 、 app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

 https://sg.sobot.io/api/get_token

请求参数：

参数	类型	必填	描述
appid	String	是	接口凭证 Id，第三方用户接口调用唯一凭证 id
create_time	String	是	10位数时间戳
sign	String	是	签名 md5(appid+create_time+app_key)

返回参数：

参数	类型	必填	描述
ret_code	String	是	返回编码
ret_msg	String	是	返回信息
item	Object	否	返回对象

item 对象：

参数	类型	必填	描述
token	String	是	token 编码
expires_in	String	是	凭证有效时间，单位：秒

时间戳转换参考工具：

http://tool.chinaz.com/Tools/unixtime.aspx

sign 签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl https://sg.sobot.io/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34

返回示例：

{
  "item": {
    "token": "4ac37cb2e9c740dba4b75a34d5358802",
    "expires_in": "86400"
  },
  "ret_code": "000000",
  "ret_msg": "操作成功"
}

查询营销主题分组

接口说明：查询营销主题分组

请求方式：

POST

请求地址：

 https://sg.sobot.io/marketing-open/api/5/marketing_subject_catalog/query_page

请求参数：

参数	类型	必填	描述
catalogid	String	否	营销主题分组id
status	Integer	否	状态：1正常 -1删除
page_no	Integer	否	开始页 （默认1）
page_size	Integer	否	查询条数（默认15,最大100）

返回参数：

参数	类型	描述
ret_code	String	返回编码
ret_msg	String	返回信息
items	List	返回对象
page_count	Integer	总页数
page_no	Integer	开始页
page_size	Integer	条数
total_count	Integer	总条数

items 对象：

参数	类型	描述
catalogid	String	营销主题分组id
name	String	营销主题分组名称
status	Integer	状态：1正常 -1删除

请求示例:

curl https://sg.sobot.io/marketing-open/api/5/marketing_subject_catalog/query_page
-X POST 
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
    "page_no": 1,
    "page_size": 15,
    "status": 1,
    "catalogid": 1123412432341234123412431
}'

返回示例:

{
  "items": [
    {
      "catalogid": 1123412432341234123412431,
      "name": "测试{dc_test}",
      "status": 1
    }
  ],
  "page_count": 1,
  "page_no": 1,
  "page_size": 15,
  "ret_code": "000000",
  "ret_msg": "操作成功",
  "total_count": 1
}

查询营销主题

接口说明：查询营销主题

请求方式：

POST

请求地址：

 https://sg.sobot.io/marketing-open/api/5/marketing_subject/query_page

请求参数：

参数	类型	必填	描述
status	Integer	否	状态：1正常 -1删除
catalogid	String	否	营销主题分组id
subjectid	String	否	营销主题id
page_no	Integer	否	开始页 （默认1）
page_size	Integer	否	查询条数（默认15,最大100）

返回参数：

参数	类型	描述
ret_code	String	返回编码
ret_msg	String	返回信息
items	List	返回对象
page_count	Integer	总页数
page_no	Integer	开始页
page_size	Integer	条数
total_count	Integer	总条数

items 对象：

参数	类型	描述
catalogid	String	营销主题分组id
subjectid	String	营销主题id
subject	String	营销主题名称
status	Integer	数据状态

请求示例:

curl https://sg.sobot.io/marketing-open/api/5/marketing_subject/query_page
-X POST 
-H 'content-type:application/json'
-H 'token: 4ac37cb2e9c740dba4b75a34d5358802' 
-d '{
    "page_no": 1,
    "page_size": 15,
    "status": 1,
    "catalogid": 1123412432341234123412431,
    "subjectid": "1123412472341234123412432"
}'

返回示例:

{
  "items": [
    {
      "catalogid": 1123412432341234123412431,
      "subjectid": 1123412432341234123412432,
      "subject": "测试{dc_test_subject}",
      "status": 1
    }
  ],
  "page_count": 1,
  "page_no": 1,
  "page_size": 15,
  "ret_code": "000000",
  "ret_msg": "操作成功",
  "total_count": 1
}

● 多语言内容

营销主题分组和营销主题支持多语言内容，查询接口返回的营销主题分组名称和营销主题名称可能包含“{dc_xxx}”格式的数据，可以通过查询多语言详情 (opens new window)查询其具体信息。

错误编码

● 操作成功

错误编码	错误说明
000000	操作成功（除此编码以外的编码为错误编码）

● 系统异常

错误编码	错误说明
900001	token 为空
900002	token 已失效，请重新获取
999994	参数异常，请检查
999999	系统未知异常