嘟哩开放平台
简体中文
繁體中文
English
快速开始 开放接口 嘟哩官网
模板

全局说明【必读】


全局说明

所有未特殊标明的接口均遵守此全局规范

1、 接口均使用http协议,默认端口:9022
2、 均采用Json数据格式。均为application/json
3、 每次主动调用均需要带上accessToken参数,通过EnterpriseIDAppIDAppSecret 获取 AccessToken
4POST请求的数据均需要加密。加密方式详见加解密说明。

请求头部:

请求头

说明

Content-Type

application/json

全局返回值

返回结果类型若无特殊说明,均为application/json

字段

类型

说明


code

Int

状态码;0表示正常,非0表示错误,错误请参考全局错误码

msg

String

状态码说明

data

对象或数组

返回结果

对象类型返回示例:

json

{
"code": 0,
"msg": "ok",
"data": {
"key" : "value"
}
}

数组类型返回示例:

json

{
"code": 0,
"msg": "ok",
"data": [
{"key" : "value"},
{"key" : "value"}
]
}

全局错误码

code

message

说明

1

ok

通用错误码:接口返回正常

2

system error

通用错误码:系统异常

100010

token expire

通用错误码:token已失效

100020

invaild enterprise id

无效的企业ID

100021

invaild app id

无效的接入商

100030

invalid user id

用户 ID 无效

100031

invalid query type

参数类型错误

100040

Invalid params

参数错误

100060

Invalid org or account

无效的组织或用户账号

100061

mobile already exist error

手机号已存在

100062

Invalid mobile number

无效的手机号

100063

email already exist error

邮箱已存在

100064

Invalid email

无效的邮箱

100065

Invalid params

参数错误(其他参数不合法)

100070

org id is required

组织id不能为空

100080

Invalid dept name

部门名称校验失败

100081

Invalid dept id

父部门id校验失败

100082

parent dept not exisit

父部门不存在

100083

Invalid parameters

请求参数错误(其他参数)

100090

Invalid dept name

部门名称校验失败

100091

Invalid dept id

父部门id校验失败

100092

parent dept not exisit

父部门不存在

100093

Invalid org id

组织id校验失败

100094

Invalid parameters

请求参数错误(其他参数)

100093

Invalid org id

组织id校验失败

100094

Invalid parameters

请求参数错误(其他参数)

100110

Invalid group id

无效的群组id

100111

Invalid account

无效的成员

100120

group not exist error

群组不存在

100130

Invalid group name

无效的群组名

100140

Invalid nick name

无效的昵称

100141

Invalid password

无效的密码

100142

account already exist error

账号已存在

100143

org account already exist error

多组织账号已存在

100144

account dept is null

该账号暂无部门(未指定用户无法创建多组织账号)

100150

Invalid status

无效的状态值

100151

Invalid account id list

无效的成员id列表

100160

Invalid file

无效的文件

100161

Invalid column header error

表头错误

100162

Invalid content null

文件内容为空

100163

Invalid type

无效的类型

100164

Invalid cover

是否覆盖校验错误

100165

Invalid language

无效的语言