调用 开放平台API需要授权,才有权限调用,提供三种授权机制,admin_token(管理员授权),org_token(组织授权),app_token(应用授权),不同的授权获得的权限是不一样的

获得 admin_token 管理员授权

此授权是高级授权模式,可调用所有的接口。一般用来、添加组织、添加全局 APP。

第一步、获得 client_id 和 client_secret

第二步、调接口 /openapi/oauth2/admin_token 获得授权

获得 org_token 组织授权

此授权的权限,只限于当前的组织下,如在组织下,添加用户,添加部门的,添加 APP,所有的操作只仅限于当前授权的组织。

第一步、获得 org_id 和 org_secret

第二步、调接口 /openapi/oauth2/org_token 获得授权

获得 app_token 应用授权

应用授权,可以调用应用相关的API,例如 给应用发送推送消息,如果属于某个组织的应用,也可以根据权限来管理组织或获取组织的用户和组织架构信息。

第一步、获得 app_id 和 app_secret

第二步、调接口 /openapi/oauth2/app_token 获得授权

授权

名称 请求类型 说明
/openapi/oauth2/admin_token POST 获取管理接口授权
/openapi/oauth2/org_token POST 获取组织接口授权
/openapi/oauth2/app_token POST 获取应用接口授权

组织和分支

名称 请求类型 说明
/openapi/dept/get_orgs GET 获取所有组织(需要admin授权)
/openapi/dept/add_org POST 添加组织(需要admin授权)
/openapi/dept/del_org POST 删除组织(需要admin授权)
/openapi/dept/get_org_info GET 获取组织信息
/openapi/dept/mod_org POST 修改组织
/openapi/dept/get_dept_list GET 获取所有根分支下的所有子分支列表
/openapi/dept/add_dept POST 添加分支
/openapi/dept/del_dept POST 删除分支
/openapi/dept/mod_dept POST 修改分支
/openapi/dept/get_dept_info GET 获取分支信息
/openapi/dept/add_user POST 添加用户
/openapi/dept/del_user POST 删除用户
/openapi/dept/mod_user POST 修改用户
/openapi/dept/add_user_post POST 在分支下添加用户职位
/openapi/dept/del_user_post POST 在分支下删除用户职位
/openapi/dept/mod_user_post POST 修改用户在分支的位置顺序
/openapi/dept/get_user_list GET 获取用户列表
/openapi/dept/get_user_list_by_tag GET 根据标签获取用户列表
/openapi/dept/refresh POST 通知客户端组织架构已发送变化,要求客户端刷新组织架构
/openapi/dept/change_org_secret POST 更改组织密钥
/openapi/dept/change_dept_order POST 调整分支位置
/openapi/dept/change_post_order POST 调整分支位置

用户

名称 请求类型 说明
/openapi/user/get_info GET 获取用户信息
/openapi/user/get_online_status GET 获取用户状态
/openapi/user/is_super_admin GET 获取用户是否超级管理员
/openapi/user/get_open_id_by_account GET 根据账号获取openID

应用

名称 请求类型 说明
/openapi/app/get_app_list GET 获取应用列表(需要 admin授权 或 org授权)
/openapi/app/add_app POST 添加应用(需要 admin授权 或 org授权)
/openapi/app/del_app POST 删除应用(需要 admin授权 或 org授权)
/openapi/app/change_secret POST 更换应用密钥
/openapi/app/mod_app POST 修改应用的信息
/openapi/app/get_app_info GET 获取应用的信息
/openapi/app/get_global_app_list GET 获取全局应用列表(需要 admin授权)
/openapi/app/get_global_hides GET 获取组织隐藏的全局应用列表(需要 admin授权 或 org授权)
/openapi/app/set_global_hides POST 设置组织隐藏的全局应用(需要 admin授权 或 org授权)
/openapi/app/push_msg_to_users POST 给应用推送消息
/openapi/app/set_msg_status POST 设置消息状态
/openapi/app/get_qr POST 生成一张二维码

如果调用成功 ret返回0,否则就是有错误。

ret msg
-3 密钥不正确
-2 access_token 无效
-1 内部错误
0 调用成功
1 请求参数错误
2 无权限
3 请求方式错误
4 App不存在
5 API不存在
99 组织Domain已存在
100 组织ID已存在
101 下此获取的next_org_id不存在
102 组织已不存在
103 只能删除空组织
104 该组织还没有设置登录域
105 该组织人数已到最大值
106 手机号码已被注册
200 用户不存在
201 帐号已存在
202 用户已在分支下有职位
203 职位已不存在
204 用户只有一个岗位了,不能直接删除,如果需要请调用删除用户接口
205 头像下载失败
206 头像不能超过1M
207 管理员不能删除
302 已有相同名字分支
304 分支已经不存在
306 只能删除空分支
307 不可将父分支设置自己
308 不可将分支下的子分支设为上级分支
400 应用的图标不能超过512K
401 应用的图标下载失败
402 APP不属于指定的组织
403 应用包不是无效的
404 应用包没找到
405 应用站点创建失败
406 应用站点浏览初始化页面失败
407 上传文件签名认证失败
408 上传文件过期
409 必须有上传的文件
500 消息按钮的JSON格式不正确
501 消息按钮name不能为空
502 消息按钮name不能超过10个字符
503 消息按钮key不能为空
504 消息按钮name不能超过100个字符
505 消息按钮color格式不正确,必须是个颜色值
506 必须设置点击消息按钮打开指定Url窗口大小
507 必须设置消息图片的宽度和高度
508 必须设置消息图片的对齐方式(top,bottom,left,right)
510 此消息ID只能使用一次
511 消息不存在或推送失败
600 登录域已被注册
601 每个IP每天只能注册50个登录域
602 开通手机版,必须要有个外网IP才能注册成功