企业微信


消息接收
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
msg_signature string 消息签名
timestamp integer 时间戳
nonce string 随机数
echostr string echostr参数
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'成功'
     *      'data': {}
     *}
获取客户群
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
status_filter string 客户群跟进状态过滤,0-全部,1-离职待继承,2-离职继承中,3-离职继承完成,默认:0
owner_filter integer 客户群所有者过滤,用户ID列表
cursor string 分页游标,首页为空
limit integer 每页数量,默认10,最大100
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'成功'
     *      'data': {}
     *}
客户群详情
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
chat_id string 客户群ID
need_name integer 是否返回群成员名称,默认:0
正文
参数
响应输出

                                                            

                                                        
返回参数
名称 类型 描述
code integer 返回操作编号,0:成功,大于0:警告信息,小于0:错误信息
msg string 返回操作信息
data object 返回数据
{
     *      'code':'0',
     *      'msg':'成功'
     *      'data': {}
     *}

公共接口


加载初始化
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
version string 版本号
lng string 经度
lat string 纬度
正文
参数
响应输出

                                                            

                                                        
返回参数
获取系统配置
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
name string 配置名称
正文
参数
响应输出

                                                            

                                                        
返回参数
上传文件
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
file file 文件流
正文
参数
响应输出

                                                            

                                                        
返回参数
验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
id string 要生成验证码的标识
正文
参数
响应输出

                                                            

                                                        
返回参数

手机短信接口


发送验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
event string 事件名称[mobilelogin,register,changemobile]
正文
参数
响应输出

                                                            

                                                        
返回参数
检测验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
event string 事件名称
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数

会员接口


会员中心
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
会员登录
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
account string 账号
password string 密码
正文
参数
响应输出

                                                            

                                                        
返回参数
手机验证码登录
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
注册会员
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
username string 用户名
password string 密码
mobile string 手机号
code string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
退出登录
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
获取用户信息
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
修改会员个人信息
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
avatar string 头像地址
username string 用户名
nickname string 昵称
mobile string 手机号
code string 手机验证码
realname string 真实姓名
idcard string 身份证
bio string 个人简介
正文
参数
响应输出

                                                            

                                                        
返回参数
修改邮箱
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
修改手机号
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数
第三方登录
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
platform string 平台名称
code string Code码
正文
参数
响应输出

                                                            

                                                        
返回参数
重置密码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
newpassword string 新密码
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数

验证接口


检测邮箱
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测用户名
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
username string 用户名
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测昵称
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
nickname string 昵称
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测手机
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
id string 排除会员ID
正文
参数
响应输出

                                                            

                                                        
返回参数
检测手机
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
正文
参数
响应输出

                                                            

                                                        
返回参数
检测邮箱
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
正文
参数
响应输出

                                                            

                                                        
返回参数
检测手机验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
mobile string 手机号
captcha string 验证码
event string 事件
正文
参数
响应输出

                                                            

                                                        
返回参数
检测邮箱验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
captcha string 验证码
event string 事件
正文
参数
响应输出

                                                            

                                                        
返回参数

邮箱验证码接口


发送验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
event string 事件名称
正文
参数
响应输出

                                                            

                                                        
返回参数
检测验证码
权限
登录
鉴权
Headers
参数
名称 类型 必选 描述
email string 邮箱
event string 事件名称
captcha string 验证码
正文
参数
响应输出

                                                            

                                                        
返回参数

Token接口


检测Token是否过期
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数
刷新Token
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数

首页接口


首页
权限
登录
鉴权
Headers
参数
正文
参数
响应输出

                                                            

                                                        
返回参数