AI大模型

企业微信

GET|POST 消息接收 /api/workweixin/qiwei_receive

消息接收

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
msg_signature	string	是	消息签名
timestamp	integer	是	时间戳
nonce	string	是	随机数
echostr	string	是	echostr参数

正文

无

参数

追加

msg_signature

timestamp

nonce

echostr

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功'
     *      'data': {}
     *}

POST 获取客户群 /api/workweixin/list_workgroups

获取客户群

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
status_filter	string	是	客户群跟进状态过滤，0-全部，1-离职待继承，2-离职继承中，3-离职继承完成，默认：0
owner_filter	integer	是	客户群所有者过滤，用户ID列表
cursor	string	是	分页游标,首页为空
limit	integer	是	每页数量,默认10,最大100

正文

无

参数

追加

status_filter

owner_filter

cursor

limit

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功'
     *      'data': {}
     *}

POST 客户群详情 /api/workweixin/info_workgroup

客户群详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
chat_id	string	是	客户群ID
need_name	integer	是	是否返回群成员名称，默认：0

正文

无

参数

追加

chat_id

need_name

响应输出

返回参数

名称	类型	描述
code	integer	返回操作编号，0：成功，大于0：警告信息，小于0：错误信息
msg	string	返回操作信息
data	object	返回数据

{
     *      'code':'0',
     *      'msg':'成功'
     *      'data': {}
     *}

公共接口

GET 加载初始化 /api/common/init

加载初始化

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
version	string	是	版本号
lng	string	是	经度
lat	string	是	纬度

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

无

无

POST 获取系统配置 /api/common/config

获取系统配置

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	配置名称

正文

无

参数

追加

响应输出

返回参数

无

无

POST 上传文件 /api/common/upload

上传文件

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
file	file	是	文件流

正文

无

参数

追加

响应输出

返回参数

无

无

GET 验证码 /api/common/captcha

验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	要生成验证码的标识

正文

无

参数

追加

响应输出

返回参数

无

无

手机短信接口

POST 发送验证码 /api/sms/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称[mobilelogin,register,changemobile]

正文

无

参数

追加

mobile

event

响应输出

返回参数

无

无

POST 检测验证码 /api/sms/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

mobile

event

captcha

响应输出

返回参数

无

无

会员接口

GET 会员中心 /api/user/index

会员中心

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 会员登录 /api/user/login

会员登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
account	string	是	账号
password	string	是	密码

正文

无

参数

追加

account

password

响应输出

返回参数

无

无

POST 手机验证码登录 /api/user/mobilelogin

手机验证码登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 注册会员 /api/user/register

注册会员

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
password	string	是	密码
mobile	string	是	手机号
code	string	是	验证码

正文

无

参数

追加

username

password

mobile

code

响应输出

返回参数

无

无

POST 退出登录 /api/user/logout

退出登录

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 获取用户信息 /api/user/info

获取用户信息

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 修改会员个人信息 /api/user/profile

修改会员个人信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
avatar	string	否	头像地址
username	string	否	用户名
nickname	string	否	昵称
mobile	string	否	手机号
code	string	否	手机验证码
realname	string	否	真实姓名
idcard	string	否	身份证
bio	string	否	个人简介

正文

无

参数

追加

avatar

username

nickname

mobile

code

realname

idcard

bio

响应输出

返回参数

无

无

POST 修改邮箱 /api/user/changeemail

修改邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码

正文

无

参数

追加

captcha

响应输出

返回参数

无

无

POST 修改手机号 /api/user/changemobile

修改手机号

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 第三方登录 /api/user/third

第三方登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
platform	string	是	平台名称
code	string	是	Code码

正文

无

参数

追加

platform

code

响应输出

返回参数

无

无

POST 重置密码 /api/user/resetpwd

重置密码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

参数

追加

mobile

newpassword

captcha

响应输出

返回参数

无

无

验证接口

POST 检测邮箱 /api/validate/check_email_available

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
id	string	是	排除会员ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测用户名 /api/validate/check_username_available

检测用户名

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
id	string	是	排除会员ID

正文

无

参数

追加

username

响应输出

返回参数

无

无

POST 检测昵称 /api/validate/check_nickname_available

检测昵称

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
nickname	string	是	昵称
id	string	是	排除会员ID

正文

无

参数

追加

nickname

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_available

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
id	string	是	排除会员ID

正文

无

参数

追加

mobile

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_exist

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测邮箱 /api/validate/check_email_exist

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测手机验证码 /api/validate/check_sms_correct

检测手机验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

mobile

captcha

event

响应输出

返回参数

无

无

POST 检测邮箱验证码 /api/validate/check_ems_correct

检测邮箱验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

captcha

event

响应输出

返回参数

无

无

邮箱验证码接口

POST 发送验证码 /api/ems/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称

正文

无

参数

追加

event

响应输出

返回参数

无

无

POST 检测验证码 /api/ems/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

event

captcha

响应输出

返回参数

无

无

Token接口

GET 检测Token是否过期 /api/token/check

检测Token是否过期

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 刷新Token /api/token/refresh

刷新Token

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

首页接口

GET 首页 /api/index/index

首页

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无