接口管理

——本文主要说明如何调用系统内外的接口获取数据。

准备工作

您需要向您的研发人员要到对应的接口文档，或由您的技术人员配置该功能。

配置系统外部接口

● 动态Token的获取

当您选择动态接口时，您需要按照如下对接方式提供获取Token和刷新Token的接口。

1、获取Token 请求参数：

参数名	类型	描述
app_key	String	应用密钥
timestamp	Long	时间戳
sign	String	签名（Md5(app_key + timestamp + app_secret)加密值）

返回值：

{
  "code": "000000",
  "data": {
    "access_token": "xxxxxxxx",  // token值
    "refresh_token": "xxxxxxxx"  // 刷新token值
  }
}

2、刷新Token 请求参数：

参数名	类型	描述
refresh_token	String	刷新token值

返回值：

{
  "code": "000000",
  "data": {
    "access_token": "xxxxxxxx",  // token值
    "refresh_token": "xxxxxxxx"  // 刷新token值
  }
}

3. 特别说明

• Token 失效处理：在 token 失效时间前 10 分钟内，使用刷新 token 获取新 token
• Token 唯一性：确保使用刷新 token 获取的 token 是新生成的，与旧 token 不一致

● 接口配置

您可以自定义Header参数、请求参数、输出参数。

图 1：添加接口

● 接口测试

您可以测试您的接口是否可以访问。

图 2：接口测试

● 系统外部接口的应用场景

目前在“呼叫中心-设置-基础设置IVR流程”中的数据请求中使用该接口。

图 3：IVR

系统内部接口使用说明

为了方便使用，我们系统内部提供了获取系统内客户信息的查询接口。

请求参数：至少一个，否则返回空

参数名称	类型	是否必填	备注
id	String	否	客户id
tel	String	否	手机号
email	String	否	邮箱
thirdAccountId	String	否	(三方账号id(partnerId、wxUnionId、wxOpenId、wxExternalUserId、whatsappId、faceBookId、instagramId、lineId、telegramId、discordId))

返回参数：

参数名称	类型	是否必填	备注
id	String	是	客户id
tel	String	否	手机号
email	String	否	邮箱
partner_id	String	否	对接ID
wx_unionid	String	否	微信的UnionID
wx_external_userid	String	否	企微外部联系人ID
wx_openid	String	否	微信OpenID
faceBookid	String	否	Facebook
instagramid	String	否	Instagram
whatsappid	String	否	WhatsApp
lineid	String	否	Line
telegramid	String	否	Telegram
discordid	String	否	Discord
visitorids	String	否	访客id
nick	String	是	客户昵称
uname	String	否	真实姓名
sexName	String	是	性别，男、女
countryName	String	否	国家名称
provice_name	String	否	省份名称
city_name	String	否	城市名称
remark	String	否	备注
userStatusName	String	是	客户状态，拉黑、正常
isVip	String	否	是否vip 1.是；2.否
vipLevel	String	否	VIP级别（固定字段，下拉列表用户可以自定义）
vipLeveName	String	否	vip名称
isblack	String	是	是否黑名单 1是，0否
enterprise_name	String	否	企业名称
sourceName	String	否	渠道名称
liableServiceName	String	否	负责人名称
userLabel	String	否	标签id，用逗号分隔
userLableName	String	否	"标签组"：["标签1","标签2"]
客户自定义字段1(id)	String	否	客户自定义字段1值
客户自定义字段2(id)	String	否	客户自定义字段2值

客户自定义字段id可在“CRM-设置-客户字段”处查看

图 4：客户自定义字段id