Files
Web_BAI_Manage_ApiServer/pocket-base/spec/openapi-wx/wechat-auth.yaml
XuJiacheng e47060f54f feat: 添加微信认证相关接口,包括微信登录和用户资料更新功能
- 新增 wechatLogin 接口,支持使用微信临时凭证 code 登录或注册用户,返回用户信息和 auth token。
- 新增 wechatProfile 接口,支持更新微信用户资料,支持非空字段增量更新。
- 定义相关请求和响应的 schema,包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。
- 处理不同的响应状态码,包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00

1004 lines
45 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
paths:
wechatLogin:
post:
security: []
operationId: postWechatLogin
tags:
- 微信认证
summary: 微信登录或首次注册
description: |
使用微信 `users_wx_code` 换取微信 openid。
若 `tbl_auth_users` 中不存在对应用户,则自动创建新 auth 用户并返回 token。
首次注册时,`users_level` 默认保持为空,不自动写入会员等级。
requestBody:
required: true
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/WechatLoginRequest
example:
users_wx_code: 微信小程序登录临时凭证 code|string
responses:
"200":
description: 登录或注册成功
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/AuthSuccessResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
status: status|string
is_info_complete: is_info_complete|boolean
user:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
token: PocketBase 原生 auth token|string
"400":
description: 参数错误或保存用户失败
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"401":
description: 认证失败
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"415":
description: 请求体不是 JSON
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"429":
description: 请求过于频繁
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"500":
description: 服务端错误
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
wechatProfile:
post:
security:
- BearerAuth: []
operationId: postWechatProfile
tags:
- 微信认证
summary: 更新微信用户资料
description: |
基于当前 `Authorization` 对应的 auth 用户按“非空字段增量更新”资料。
更新规则:
- 所有字段都不是必填
- 如果传了 `users_phone_code`,服务端优先调用微信接口换取真实手机号并写入 `users_phone`
- 如果没传 `users_phone_code`,但传了 `users_phone`,则直接将该手机号写入数据库
- 如果上传了 `users_picture`、`users_id_pic_a`、`users_id_pic_b`、`users_title_picture`,会按附件 ID 进行关联校验并更新
- 若当前用户类型为 `游客`,且本次未显式传 `users_type`,服务端会自动升级为 `注册用户`
- 如果某个字段未传或传空,则不会清空数据库中的已有值
- 只有请求体里非空的字段才会更新到数据库
requestBody:
required: true
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/WechatProfileRequest
example:
users_name: 用户姓名 / 昵称|string
users_phone_code: 可选。若传入,服务端优先通过微信接口换取真实手机号并写入数据库|string
users_phone: 可选。未传 users_phone_code 时,可直接写入手机号|string
users_type: 可选。用户类型;仅在传入非空值时更新|string
company_id: 可选。公司业务 id仅在传入非空值时更新|string
users_tag: 可选。用户标签;非空时才更新|string
users_picture: 可选。用户头像附件的 attachments_id|string
users_id_pic_a: 可选。证件正面附件的 attachments_id|string
users_id_pic_b: 可选。证件反面附件的 attachments_id|string
users_title_picture: 可选。资质附件的 attachments_id|string
responses:
"200":
description: 更新成功
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/WechatProfileResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
status: status|string
user:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
"400":
description: 参数错误、手机号已被占用、附件 ID 无效、微信手机号换取失败或资料更新失败
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"401":
description: token 无效或缺少 openid
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"415":
description: 请求体不是 JSON
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"429":
description: 请求过于频繁
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
"500":
description: 服务端错误
content:
application/json:
schema:
$ref: ../openapi-wx.yaml#/components/schemas/ErrorResponse
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
components:
schemas:
ApiResponseBase:
type: object
required:
- statusCode
- errMsg
- data
properties:
statusCode:
type:
- integer
- string
description: 业务状态码
example: 业务状态码 | integer
errMsg:
type: string
description: 业务提示信息
example: 业务提示信息 | string
data:
description: 业务响应数据
type: object
additionalProperties: true
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
ErrorResponse:
type: object
required:
- statusCode
- errMsg
- data
properties:
statusCode:
type:
- integer
- string
description: 业务状态码
example: 业务状态码 | integer
errMsg:
type: string
description: 业务提示信息
example: 失败原因提示 | string
data:
description: 业务响应数据
type: object
additionalProperties: true
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
业务响应数据字段|string: 业务响应数据值|string
UserInfo:
type: object
properties:
pb_id:
description: PocketBase 记录主键 id
type: string
users_convers_id:
description: 会话侧用户 ID
type: string
users_id:
description: 用户业务 ID
type: string
users_idtype:
description: 身份来源类型或证件类型
anyOf:
- type: string
enum:
- WeChat
- ManagePlatform
- type: string
users_id_number:
description: 证件号
type: string
users_type:
description: 用户类型
anyOf:
- type: string
enum:
- 游客
- 注册用户
- type: string
users_name:
description: 用户姓名 / 昵称
type: string
users_status:
description: 用户状态
type:
- string
- number
users_rank_level:
description: 用户星级数值
type:
- number
- integer
- string
users_auth_type:
description: 账户类型
type:
- number
- integer
- string
users_phone:
description: 手机号
type: string
users_phone_masked:
type: string
users_level:
type: string
description: 用户等级
users_level_name:
type: string
description: 用户等级名称,按 `users_level -> 数据-会员等级` 字典描述实时解析
users_tag:
type: string
description: 用户标签
users_picture:
type: string
description: 用户头像附件的 `attachments_id`
users_picture_url:
type: string
description: 根据 `users_picture -> tbl_attachments` 自动解析出的头像文件流链接
users_id_pic_a:
type: string
description: 证件正面附件的 `attachments_id`
users_id_pic_a_url:
type: string
description: 根据 `users_id_pic_a -> tbl_attachments` 自动解析出的文件流链接
users_id_pic_b:
type: string
description: 证件反面附件的 `attachments_id`
users_id_pic_b_url:
type: string
description: 根据 `users_id_pic_b -> tbl_attachments` 自动解析出的文件流链接
users_title_picture:
type: string
description: 资质附件的 `attachments_id`
users_title_picture_url:
type: string
description: 根据 `users_title_picture -> tbl_attachments` 自动解析出的文件流链接
openid:
type: string
description: 全平台统一身份标识
company_id:
type: string
description: 公司业务 id存储 `tbl_company.company_id`
users_parent_id:
type: string
description: 上级用户业务 id
users_promo_code:
type: string
description: 推广码
usergroups_id:
type: string
description: 用户组业务 id
company:
$ref: ../openapi-wx.yaml#/components/schemas/CompanyInfo
created:
type: string
description: 用户创建时间
updated:
type: string
description: 用户更新时间
example:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
WechatLoginRequest:
type: object
required:
- users_wx_code
properties:
users_wx_code:
type: string
description: 微信小程序登录临时凭证 code
example: 0a1b2c3d4e5f6g
example:
users_wx_code: 微信小程序登录临时凭证 code|string
WechatProfileRequest:
type: object
properties:
users_name:
type: string
description: 用户姓名 / 昵称
example: 张三
users_phone_code:
type: string
description: 可选。若传入,服务端优先通过微信接口换取真实手机号并写入数据库
example: 2b7d9f2e3c4a5b6d7e8f
users_phone:
type: string
description: 可选。未传 `users_phone_code` 时,可直接写入手机号
example: "13800138000"
users_type:
type: string
description: 可选。用户类型;仅在传入非空值时更新
example: 服务商
company_id:
type: string
description: 可选。公司业务 id仅在传入非空值时更新
example: WX-COMPANY-10001
users_tag:
type: string
description: 可选。用户标签;非空时才更新
example: 核心客户
users_picture:
type: string
description: 可选。用户头像附件的 `attachments_id`
example: ATT-1743123456789-abc123
users_id_pic_a:
type: string
description: 可选。证件正面附件的 `attachments_id`
users_id_pic_b:
type: string
description: 可选。证件反面附件的 `attachments_id`
users_title_picture:
type: string
description: 可选。资质附件的 `attachments_id`
example:
users_name: 用户姓名 / 昵称|string
users_phone_code: 可选。若传入,服务端优先通过微信接口换取真实手机号并写入数据库|string
users_phone: 可选。未传 users_phone_code 时,可直接写入手机号|string
users_type: 可选。用户类型;仅在传入非空值时更新|string
company_id: 可选。公司业务 id仅在传入非空值时更新|string
users_tag: 可选。用户标签;非空时才更新|string
users_picture: 可选。用户头像附件的 attachments_id|string
users_id_pic_a: 可选。证件正面附件的 attachments_id|string
users_id_pic_b: 可选。证件反面附件的 attachments_id|string
users_title_picture: 可选。资质附件的 attachments_id|string
AuthSuccessData:
type: object
properties:
status:
anyOf:
- type: string
enum:
- register_success
- login_success
- type: string
is_info_complete:
type:
- boolean
- string
user:
$ref: ../openapi-wx.yaml#/components/schemas/UserInfo
example:
status: status|string
is_info_complete: is_info_complete|boolean
user:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
AuthSuccessResponse:
allOf:
- $ref: ../openapi-wx.yaml#/components/schemas/ApiResponseBase
- type: object
required:
- token
properties:
data:
description: 业务响应数据
$ref: ../openapi-wx.yaml#/components/schemas/AuthSuccessData
token:
type: string
description: PocketBase 原生 auth token
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
status: status|string
is_info_complete: is_info_complete|boolean
user:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
token: PocketBase 原生 auth token|string
WechatProfileResponseData:
type: object
properties:
status:
anyOf:
- type: string
enum:
- update_success
- type: string
user:
$ref: ../openapi-wx.yaml#/components/schemas/UserInfo
example:
status: status|string
user:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
WechatProfileResponse:
allOf:
- $ref: ../openapi-wx.yaml#/components/schemas/ApiResponseBase
- type: object
properties:
data:
description: 业务响应数据
$ref: ../openapi-wx.yaml#/components/schemas/WechatProfileResponseData
example:
statusCode: 业务状态码|integer
errMsg: 业务提示信息|string
data:
status: status|string
user:
pb_id: PocketBase 记录主键 id|string
users_convers_id: 会话侧用户 ID|string
users_id: 用户业务 ID|string
users_idtype: users_idtype|string
users_id_number: 证件号|string
users_type: users_type|string
users_name: 用户姓名 / 昵称|string
users_status: 用户状态|string
users_rank_level: 用户星级数值|number
users_auth_type: 账户类型|number
users_phone: 手机号|string
users_phone_masked: users_phone_masked|string
users_level: 用户等级|string
users_level_name: 用户等级名称,按 users_level - 数据-会员等级 字典描述实时解析|string
users_tag: 用户标签|string
users_picture: 用户头像附件的 attachments_id|string
users_picture_url: 根据 users_picture - tbl_attachments 自动解析出的头像文件流链接|string
users_id_pic_a: 证件正面附件的 attachments_id|string
users_id_pic_a_url: 根据 users_id_pic_a - tbl_attachments 自动解析出的文件流链接|string
users_id_pic_b: 证件反面附件的 attachments_id|string
users_id_pic_b_url: 根据 users_id_pic_b - tbl_attachments 自动解析出的文件流链接|string
users_title_picture: 资质附件的 attachments_id|string
users_title_picture_url: 根据 users_title_picture - tbl_attachments 自动解析出的文件流链接|string
openid: 全平台统一身份标识|string
company_id: 公司业务 id存储 tbl_company.company_id|string
users_parent_id: 上级用户业务 id|string
users_promo_code: 推广码|string
usergroups_id: 用户组业务 id|string
company:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string
created: 用户创建时间|string
updated: 用户更新时间|string
CompanyInfo:
anyOf:
- type: object
description: 用户所属公司信息;当用户尚未绑定公司时返回 `null`
properties:
pb_id:
type: string
description: PocketBase 记录主键 id
example: PocketBase记录主键id | string
company_id:
type: string
description: 公司业务 id由数据库自动生成
example: 公司业务id由数据库自动生成 | string
company_name:
type: string
description: 公司名称
example: 公司名称 | string
company_type:
type: string
description: 公司类型
example: 公司类型 | string
company_entity:
type: string
description: 公司法人
example: 公司法人 | string
company_usci:
type: string
description: 统一社会信用代码
example: 统一社会信用代码 | string
company_nationality:
type: string
description: 国家名称
example: 国家名称 | string
company_nationality_code:
type: string
description: 国家编码
example: 国家编码 | string
company_province:
type: string
description: 省份名称
example: 省份名称 | string
company_province_code:
type: string
description: 省份编码
example: 省份编码 | string
company_city:
type: string
description: 城市名称
example: 城市名称 | string
company_city_code:
type: string
description: 城市编码
example: 城市编码 | string
company_district:
type: string
description: 区/县名称
example: 区县名称 | string
company_district_code:
type: string
description: 区/县编码
example: 区县编码 | string
company_postalcode:
type: string
description: 邮政编码
example: 邮政编码 | string
company_add:
type: string
description: 公司地址
example: 公司地址 | string
company_status:
type: string
description: 公司状态
example: 公司状态 | string
company_level:
type: string
description: 公司等级
example: 公司等级 | string
company_owner_openid:
type: string
description: 公司所有者 openid
example: 公司所有者openid | string
company_remark:
type: string
description: 备注
example: 备注 | string
created:
type: string
description: 记录创建时间
example: 记录创建时间 | string
updated:
type: string
description: 记录更新时间
example: 记录更新时间 | string
example:
pb_id: PocketBase记录主键id | string
company_id: 公司业务id由数据库自动生成 | string
company_name: 公司名称 | string
company_type: 公司类型 | string
company_entity: 公司法人 | string
company_usci: 统一社会信用代码 | string
company_nationality: 国家名称 | string
company_nationality_code: 国家编码 | string
company_province: 省份名称 | string
company_province_code: 省份编码 | string
company_city: 城市名称 | string
company_city_code: 城市编码 | string
company_district: 区县名称 | string
company_district_code: 区县编码 | string
company_postalcode: 邮政编码 | string
company_add: 公司地址 | string
company_status: 公司状态 | string
company_level: 公司等级 | string
company_owner_openid: 公司所有者openid | string
company_remark: 备注 | string
created: 记录创建时间 | string
updated: 记录更新时间 | string
- type: "null"
example:
pb_id: PocketBase 记录主键 id|string
company_id: 公司业务 id由数据库自动生成|string
company_name: 公司名称|string
company_type: 公司类型|string
company_entity: 公司法人|string
company_usci: 统一社会信用代码|string
company_nationality: 国家名称|string
company_nationality_code: 国家编码|string
company_province: 省份名称|string
company_province_code: 省份编码|string
company_city: 城市名称|string
company_city_code: 城市编码|string
company_district: 区/县名称|string
company_district_code: 区/县编码|string
company_postalcode: 邮政编码|string
company_add: 公司地址|string
company_status: 公司状态|string
company_level: 公司等级|string
company_owner_openid: 公司所有者 openid|string
company_remark: 备注|string
created: 记录创建时间|string
updated: 记录更新时间|string