fresns
  1. 公共业务
fresns
  • 请求标头
  • 通用数据结构
  • 错误码
  • 全局配置
    • 全局配置信息
      GET
    • 状态码信息
      GET
    • 扩展档案配置
      GET
    • 上传用的令牌
      GET
    • 用户角色
      GET
    • 地图服务商
      GET
    • 内容类型
      GET
    • 表情图
      GET
    • 阻止词
      GET
  • 公共业务
    • 输入提示信息
      GET
    • 回调返参查询
      GET
    • 发送验证码
      POST
    • 上传日志
      POST
    • 上传文件
      POST
    • 文件下载链接
      GET
    • 下载过文件的用户
      GET
  • 账号
    • 注册
      POST
    • 登录
      POST
    • 重置密码
      PUT
    • 获取账号详情
      GET
    • 钱包交易记录
      GET
    • 身份验证
      POST
    • 修改账号资料
      PUT
    • 退出登录
      DELETE
    • 申请删除账号
      POST
    • 撤销删除申请
      POST
  • 用户
    • 获取用户列表
    • 获取用户详情
    • 获取用户认识的关注者
    • 获取用户互动的用户列表
    • 获取用户标记的内容列表
    • 用户登录
    • 用户面板
    • 修改用户资料
    • 操作标记
    • 标记备注
  • 消息
    • [通知]获取消息列表
    • [通知]更新阅读状态
    • [通知]删除消息
    • [对话]获取对话列表
    • [对话]获取对话详情
    • [对话]获取消息列表
    • [对话]置顶对话
    • [对话]更新阅读状态
    • [对话]发送消息
    • [对话]删除对话或对话的消息
  • 小组
    • 获取树结构小组列表
    • 获取小组分类
    • 获取小组列表
    • 获取小组详情
    • 获取小组互动的用户列表
  • 话题
    • 获取话题列表
    • 获取话题详情
    • 获取话题互动的用户列表
  • 帖子
    • 获取帖子列表
    • 获取关注对象的帖子列表
    • 获取位置附近的帖子列表
    • 获取帖子详情
    • 获取帖子互动的用户列表
    • 获取帖子的附属用户列表
    • 获取帖子的日志列表
    • 获取帖子日志详情
    • 删除帖子
  • 评论
    • 获取评论列表
    • 获取关注对象的评论列表
    • 获取位置附近的评论列表
    • 获取评论详情
    • 获取评论互动的用户列表
    • 获取评论的日志列表
    • 获取评论日志详情
    • 删除评论
  • 编辑器
    • 快速发表(帖子)
    • 快速发表(评论)
    • 编辑器配置信息
    • 获取草稿列表(帖子)
    • 获取草稿列表(评论)
    • 创建草稿(帖子)
    • 创建草稿(评论)
    • 生成编辑草稿(帖子)
    • 生成编辑草稿(评论)
    • 获取草稿详情(帖子)
    • 获取草稿详情(评论)
    • 更新草稿内容(帖子)
    • 更新草稿内容(评论)
    • 提交发表(或审核)
    • 撤回审核中草稿
    • 删除草稿
  • 搜索
    • 用户
    • 小组
    • 话题
    • 帖子
    • 评论
  1. 公共业务

发送验证码

开发中
POST
http://localhost:8080/api/v2/common/send-verify-code
useType 用途类型
1 新账号验证: 未登录时也可请求,但是账号必须在数据库中不存在。例如,新注册、更换绑定等。
2 已存账号验证: 未登录时也可请求,但是账号必须在数据库中存在。例如,验证码登录等。
3 填空验证: 登录时才可请求,并且账号的对应的邮箱或手机号必须为空。例如,设置账号邮箱或手机号绑定等。
4 身份验证: 登录时才可请求,account 任意传参,接口会忽略该参数,使用当前登记账号的绑定邮箱或手机号发送验证码。例如,修改重要资料的前置验证等。
5 按传参账号直接发送。
接口限制,1 分钟内容仅可发送 1 条验证码,10 分钟内 5 条。接口之外,如果另外限制,则由关联的插件决定。

请求参数

Header 参数
X-Fresns-App-Id
string 
必需
密钥 App ID
密钥位置:控制面板->应用中心->应用密钥
默认值:
{{appId}}
X-Fresns-Client-Platform-Id
integer 
必需
平台编号,与密钥的「平台」匹配
默认值:
{{clientPlatformId}}
X-Fresns-Client-Version
string 
必需
你的客户端版本号,推荐使用语义化版本号
默认值:
{{clientVersion}}
X-Fresns-Client-Device-Info
string 
必需
交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参
默认值:
{{clientDeviceInfo}}
X-Fresns-Aid
string 
可选
账号参数(留空则视为未登录账号)
默认值:
{{aid}}
X-Fresns-Aid-Token
string 
可选
账号身份凭证(传参 aid 时必传)
默认值:
{{aidToken}}
X-Fresns-Uid
integer 
可选
用户参数(留空则视为未登录用户)
默认值:
{{uid}}
X-Fresns-Uid-Token
string 
可选
用户身份凭证(传参 uid 时必传)
默认值:
{{uidToken}}
X-Fresns-Signature
string 
签名
必需
X-Fresns-Signature-Timestamp
string 
必需
签名生成时间(当前 Unix 时间戳,精确到秒或毫秒都支持)
Body 参数application/json
type
enum<string> 
必需
发送类型:email,sms
枚举值:
emailphone
useType
string 
必需
用途类型:1.新账号验证 / 2.已存账号验证 / 3.填空验证 / 4.身份验证 / 5.其他
templateId
string 
必需
模板编号, 1 => 通用验证码, 2 => 注册新账号, 3 => 修改账号资料, 4 => 更换新绑定, 5 => 重置登录密码, 6 => 重置支付密码, 7 => 使用验证码登录, 8 => 使用验证码注销账号
account
string  | null 
可选
邮箱或者手机号(用途为 4 时,填写任意内容,不作使用)
countryCode
string  | null 
可选
手机号码专用,专用时必填,国际区号
示例
{
    "type": "email",
    "useType": "string",
    "templateId": "string",
    "account": "string",
    "countryCode": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:8080/api/v2/common/send-verify-code' \
--header 'X-Fresns-App-Id;' \
--header 'X-Fresns-Client-Platform-Id;' \
--header 'X-Fresns-Client-Version;' \
--header 'X-Fresns-Client-Device-Info;' \
--header 'X-Fresns-Aid: ' \
--header 'X-Fresns-Aid-Token: ' \
--header 'X-Fresns-Uid: ' \
--header 'X-Fresns-Uid-Token: ' \
--header 'X-Fresns-Signature;' \
--header 'X-Fresns-Signature-Timestamp;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "email",
    "useType": "string",
    "templateId": "string",
    "account": "string",
    "countryCode": "string"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
message
string 
必需
data
null 
必需
示例
{
    "code": 0,
    "message": "string",
    "data": null
}
上一页
回调返参查询
下一页
上传日志
Built with