随附宿主账号

用于源码随附应用的注册、登录和账号管理。接入自己的账号系统时，通常只需要用户预置与 Token 接口。

每个接口独立列出请求参数、返回字段和示例。点击下方接口名称即可查看。

接口列表

接口	方法	路径
读取宿主应用配置	GET	/app/auth/config
获取图形验证码	GET	/app/auth/captcha
登录宿主账号	POST	/app/auth/login
注册宿主账号	POST	/app/auth/register
发送注册短信	POST	/app/auth/sms
读取宿主当前用户	GET	/app/auth/me
为宿主会话获取 IM Token	POST	/app/auth/token
修改宿主昵称或签名	POST	/app/auth/profile
上传宿主头像	POST	/app/auth/avatar
修改宿主密码	POST	/app/auth/password
注销宿主账号	POST	/app/auth/deactivate
退出宿主会话	POST	/app/auth/logout

会话保存

浏览器保留 PHPSID Cookie；原生端可保存响应头 PHPSID，并通过同名请求头继续发送。验证码、短信和注册流程要使用同一会话。

读取登录配置

先读取应用名称和注册、验证码开关，再决定页面显示哪些输入框。

• 读取宿主应用配置

图形验证码

验证码返回 JPEG 图片，与 PHPSID 会话绑定。每次校验后重新获取，不缓存图片。

• 获取图形验证码

登录与注册

账号密码登录成功或注册成功后返回用户资料，之后再为 SDK 换取 IM Token。

• 登录宿主账号
• 注册宿主账号

发送注册短信

仅在启用手机验证的注册流程中使用。先取得 register_sms 图形验证码，再发送短信并注册。

• 发送注册短信

换取 SDK 票据

这里使用 PHPSID；自有账号系统则由宿主后端使用 sdkSecret 取票。

• 为宿主会话获取 IM Token
• 获取 IM Token

资料与账号

各操作独立提交。修改资料、头像、密码、退出和注销的参数见对应页面。

• 修改宿主昵称或签名
• 上传宿主头像
• 修改宿主密码
• 退出宿主会话
• 注销宿主账号

宿主错误码

先检查 HTTP 状态，再看 code；各接口列出常见失败原因。常用宿主错误码：3001 账号或密码问题、3002 未登录、3003 图形验证码错误、3004 注册未开启、3005 账号停用、3006 会话无效、3007 短信码错误、3008 发送过快、3009 短信不可用、3010 手机号已使用、3011 短信发送失败、3012 仍拥有群。