Skip to content

用户

MODULE_NAMEMODULE_DESC入参返参路径
user_info用户其他信息UserInfoParamsUserInfoRespuser/form/info
user_submit提交用户信息UserSumbitParamsUserSumbitRespuser/form/submit
form_info用户基础信息FormInfoParamsFormInfoRespuser/index/info
get_phone获取安全手机号GetPhoneParamsGetPhoneRespcomm/setting/getsphone

用户其他信息

UserInfoParams 参数

ts
interface USER_INFO_PARAMS {
  scene_id: string; // 场景ID
}
字段名类型描述必传
scene_idstring场景 ID

UserInfoResp 参数

ts
interface USER_INFO_RESP {
  id: number; // ID
  company_id: number; // 公司 ID
  app_id: number; // 应用 ID
  title: string; // 标题
  input_type: string; // 输入类型
  content: string; // 内容
  use_scene: number; // 使用场景
  user_field: string; // 用户字段
  system: number; //  是否系统
  state: number; // 状态
  operator_id: number; // 操作人 ID
  created_at: string; // 创建时间
  updated_at: string; // 更新时间
  value: string; // 值
}
参数名参数描述类型
idIDnumber
title标题string
input_type输入类型string
content内容string
use_scene使用场景number
user_field用户字段string
system是否系统number
valuestring
state状态number
operator_id操作人 IDnumber
company_id公司 IDnumber
app_id应用 IDnumber
created_at创建时间string
updated_at更新时间string

提交用户信息

UserSumbitParams 参数

ts
interface USER_SUMBIT_PARAMS {
  scene_id: string; // 场景ID
  json: string; // 用户信息
  task_code: string; // 任务码
}
字段名类型描述必传
scene_idstring场景 ID
jsonstring用户信息
task_codestring任务码(默认值是 perfect_info)

UserSumbitResp 参数

ts
interface USER_SUMBIT_RESP {
  无实际意义参数;
}
参数名参数描述类型

用户基础信息

FormInfoParams 参数

ts
interface FORM_INFO_PARAMS {
  scene_id: string; // 场景ID
}
字段名类型描述必传
scene_idstring场景 ID

FormInfoResp 参数

ts
interface FORM_INFO_RESP {
  id: number;
  app_id: number;
  merge_user_id: number;
  phone: string;
  country_code: string;
  nickname: string;
  headimgurl: string;
  birthday: string;
  gender: number;
  f_avatar: string;
  f_avatar_org: string;
  idcard: string;
  email: string;
  province: string;
  city: string;
  district: string;
  address: string;
  group_id: number;
  source: string;
  store_id: number;
  is_perfect_info: number;
  state: number;
  created_ip: string;
  created_at: string;
  updated_at: string;
  operator_id: number;
  u_from: string;
  is_partner: number;
  wallet: number;
  score: number;
  card: string;
  coupon: number;
  is_wechat: number;
}
参数名参数描述类型
idIDnumber
app_id应用 IDnumber
merge_user_id合并用户 IDnumber
phone手机号码string
country_code国家代码string
nickname昵称string
headimgurl头像 URLstring
birthday生日string
gender性别number
f_avatar头像string
f_avatar_org原始头像string
idcard身份证号码string
email电子邮件string
province省份string
city城市string
district区县string
address地址string
group_id分组 IDnumber
source来源string
store_id商店 IDnumber
is_perfect_info是否完善信息number
state状态number
created_ip创建 IPstring
created_at创建时间string
updated_at更新时间string
operator_id操作人 IDnumber
u_from用户来源string
is_partner是否合作伙伴number
wallet钱包number
score分数number
card卡片string
coupon优惠券数量number
is_wechat是否微信用户number

获取安全手机号

GetPhoneParams 参数

ts
interface USER_SUMBIT_PARAMS {
;
}

GetPhoneResp 参数

ts
interface USER_SUMBIT_RESP {
  phone: string; // 手机号码
  is_wechat: number; // 是否微信用户
}
参数名参数描述类型
phone手机号码string
is_wechat是否微信用户number