我的网站

手机短信接口

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

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

mobile

event

响应输出

返回参数

无

无

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

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

mobile

event

captcha

响应输出

返回参数

无

无

Token接口

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

检测Token是否过期

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 刷新Token /api/token/refresh

刷新Token

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

会员接口

GET 获取用户信息，如果没有登录，则返回没有登录的错误码 /api/user/index

获取用户信息，如果没有登录，则返回没有登录的错误码

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 获取用户手机号码 /api/user/getmobile

获取用户手机号码

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	string	是	微信小程序授权码

正文

无

参数

追加

响应输出

返回参数

无

无

POST 微信快速登录 /api/user/wechatlogin

微信快速登录

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	string	是	微信小程序授权码

正文

无

参数

追加

响应输出

返回参数

无

无

POST 会员登录 - 支持密码和验证码双登录方式 /api/user/login

用户登录

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
Content-Type	string	是	application/x-www-form-urlencoded 或 application/json

参数

名称	类型	必选	描述
mobile	string	是	手机号码，11位中国大陆手机号
password	string	否	登录密码，密码登录时必需
code	string	否	短信验证码，验证码登录时必需

正文

无

Headers

Content-Type

参数

追加

mobile

password

code

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.userinfo	object	用户信息

type="object", description="返回登录成功的用户信息和token"

POST 手机验证码登录OR注册接口 /api/user/mobilelogin

手机验证码登录OR注册接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号, 18011111111 用于测试，不校验验证码
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 用户注册 /api/user/register

手机号注册新用户

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
Content-Type	string	是	application/x-www-form-urlencoded 或 application/json

参数

名称	类型	必选	描述
mobile	string	是	手机号码，11位中国大陆手机号
password	string	是	登录密码，6-20位字符
code	string	是	短信验证码，6位数字

正文

无

Headers

Content-Type

参数

追加

mobile

password

code

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.userinfo	object	用户信息

type="object", description="返回注册成功的用户信息和token"

POST 退出登录 /api/user/logout

退出登录

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 重置密码 /api/user/resetpwd

重置密码

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

mobile

newpassword

captcha

响应输出

返回参数

无

无

验证接口

POST 检测手机 /api/validate/check_mobile_available

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

mobile

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_exist

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

响应输出

返回参数

无

无

公共接口

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

加载初始化

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

无

无

POST 上传文件 /api/common/upload

上传文件

权限

登录	是
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

响应输出

返回参数

无

无

GET 验证码 /api/common/captcha

验证码

权限

登录	否
鉴权	否

Headers

无

参数

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

正文

无

参数

追加

响应输出

返回参数

无

无

Coze AI聊天系统

GET 获取智能体列表 /api/chat/getBots

获取可用的智能体列表

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
Content-Type	string	否	application/json

参数

无

正文

无

Headers

Content-Type

参数

追加

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.bots	array	智能体列表
data.bots[].id	int	智能体数据库ID
data.bots[].name	string	智能体名称
data.bots[].description	string	智能体描述
data.bots[].bot_id	string	Coze智能体ID
data.bots[].avatar	string	智能体头像URL
data.bots[].model	string	使用的AI模型
data.bots[].welcome_message	string	欢迎消息
data.bots[].status	string	状态：normal=正常，disabled=禁用

type="object", description="返回智能体列表，包含id、name、description、bot_id、avatar、model、welcome_message、status等字段"

GET 获取用户会话列表 /api/chat/getSessions

获取当前用户的聊天会话列表

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	否	application/json

参数

名称	类型	必选	描述
page	int	否	页码，从1开始
limit	int	否	每页数量，最大100

正文

无

Headers

token

Content-Type

参数

追加

page

limit

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.sessions	array	会话列表
data.sessions[].id	int	会话ID
data.sessions[].title	string	会话标题
data.sessions[].last_message	string	最后一条消息内容
data.sessions[].message_count	int	消息总数
data.sessions[].bot	object	关联的智能体信息
data.sessions[].bot.id	int	智能体ID
data.sessions[].bot.name	string	智能体名称
data.sessions[].bot.avatar	string	智能体头像
data.sessions[].createtime	int	创建时间戳
data.sessions[].updatetime	int	更新时间戳
data.page	int	当前页码
data.limit	int	每页数量

type="object", description="返回会话列表，包含sessions数组，每个会话包含id、title、last_message、message_count、bot信息、时间戳等"

POST 创建新的聊天会话 /api/chat/createSession

创建新的聊天会话

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	是	application/x-www-form-urlencoded 或 application/json

参数

名称	类型	必选	描述
bot_id	int	是	智能体ID，从getBots接口获取
title	string	否	会话标题，为空时自动生成

正文

无

Headers

token

Content-Type

参数

追加

bot_id

title

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.session	object	新创建的会话信息
data.session.id	int	会话ID，后续聊天需要使用
data.session.title	string	会话标题
data.session.last_message	string	最后一条消息，新会话为空
data.session.message_count	int	消息数量，新会话为0
data.session.bot	object	关联的智能体完整信息
data.session.createtime	int	创建时间戳
data.session.updatetime	int	更新时间戳

type="object", description="返回新创建的会话信息，包含session对象，包含id、title、message_count、bot完整信息等"

GET 获取会话消息历史记录 /api/chat/getMessages

获取指定会话的消息历史记录

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	否	application/json

参数

名称	类型	必选	描述
session_id	int	是	会话ID，从getSessions或createSession接口获取
limit	int	否	返回消息数量限制，最大100
offset	int	否	偏移量，用于分页，0表示从最新消息开始

正文

无

Headers

token

Content-Type

参数

追加

session_id

limit

offset

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.messages	array	消息列表，按时间正序排列
data.messages[].id	int	消息ID
data.messages[].message_type	string	消息类型：user=用户消息，assistant=AI回复
data.messages[].content	string	消息内容
data.messages[].content_type	string	内容类型：text=纯文本，multimodal=包含文件
data.messages[].createtime	int	创建时间戳
data.messages[].status	string	消息状态：pending=处理中，completed=已完成，failed=失败
data.messages[].metadata	object\|array	消息元数据，包含文件信息等
data.session	object	会话基本信息

type="object", description="返回消息列表，包含messages数组（每个消息含id、message_type、content、status等）和session基本信息"

POST 发送聊天消息（普通模式） /api/chat/sendMessage

向AI发送消息并获取回复

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	是	application/x-www-form-urlencoded 或 application/json

参数

名称	类型	必选	描述
session_id	int	是	会话ID，从getSessions或createSession接口获取
content	string	是	消息内容，支持纯文本
files	array	否	文件ID数组，从uploadFile接口获取的文件ID

正文

无

Headers

token

Content-Type

参数

追加

session_id

content

files

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.user_message	object	用户发送的消息信息
data.user_message.id	int	用户消息ID
data.user_message.content	string	用户消息内容
data.user_message.content_type	string	内容类型：text=纯文本，multimodal=包含文件
data.user_message.metadata	object	用户消息元数据，包含files数组
data.assistant_message	object	AI回复的消息信息
data.assistant_message.id	int	AI消息ID
data.assistant_message.content	string	AI回复内容（已清理格式化）
data.assistant_message.status	string	AI消息状态：completed=成功，failed=失败

type="object", description="返回用户消息和AI回复信息，包含user_message和assistant_message对象，各含id、content、status等字段"

POST 流式聊天（推荐） /api/chat/streamChat

流式发送消息并实时接收AI回复

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	是	application/x-www-form-urlencoded 或 application/json
Accept	string	否	text/event-stream

参数

名称	类型	必选	描述
session_id	int	是	会话ID，从getSessions或createSession接口获取
content	string	是	消息内容，支持纯文本
files	array	否	文件ID数组，从uploadFile接口获取的文件ID

正文

无

Headers

token

Content-Type

参数

追加

session_id

content

files

响应输出

返回参数

名称	类型	描述
流式事件类型	string	SSE事件类型说明
type=start	object	开始事件，包含用户消息信息和AI消息ID
start.user_message	object	用户发送的消息完整信息
start.assistant_message_id	int	AI回复消息的ID，用于后续引用
type=content	object	内容片段事件，AI逐步输出内容
content.content	string	本次输出的内容片段
content.full_content	string	截至目前的完整内容
type=done	object	完成事件，表示AI回复结束
type=error	object	错误事件，包含错误信息
error.message	string	错误描述信息

type="stream", description="SSE流式响应，事件类型包括start、content、done、error，内容逐步输出"

POST 上传聊天文件 /api/chat/uploadFile

上传文件用于聊天

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	是	multipart/form-data

参数

名称	类型	必选	描述
file	file	是	要上传的文件
session_id	int	否	关联的会话ID，可选，用于后续消息关联

正文

无

Headers

token

Content-Type

参数

追加

file

session_id

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	object	返回数据
data.file	object	上传成功的文件信息
data.file.id	int	文件ID，用于sendMessage或streamChat的files参数
data.file.original_name	string	原始文件名
data.file.file_type	string	文件扩展名
data.file.file_size	int	文件大小（字节）
data.file.formatted_size	string	格式化的文件大小
data.file.file_url	string	文件访问URL
data.file.upload_status	string	上传状态：completed=成功，failed=失败
data.file.createtime	int	上传时间戳

type="object", description="返回上传成功的文件信息，包含file对象，含id、original_name、file_type、file_size、file_url、upload_status等"

POST 删除聊天会话 /api/chat/deleteSession

删除指定的聊天会话

权限

登录	是
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	用户认证token
Content-Type	string	是	application/x-www-form-urlencoded 或 application/json

参数

名称	类型	必选	描述
session_id	int	是	要删除的会话ID，从getSessions接口获取

正文

无

Headers

token

Content-Type

参数

追加

响应输出

返回参数

名称	类型	描述
code	int	状态码，1=成功，0=失败
msg	string	返回消息
time	string	时间戳
data	null	删除成功时为null

type="object", description="返回删除结果，data为null"