用户添加

1 功能说明

添加用户

2 接口调用说明

2.1 URL
http://yourdomain.kf5.com/api/v1/user/add
2.2 格式

JSON

2.3 HTTP请求方式

GET, POST

2.4 IP限制

2.5 输入参数说明
参数名称是否必须类型描述
usernamestring用户帐号(邮箱地址,需要激活才能使用账号)
namestring昵称
rolestring角色。默认为end_user:普通用户,agent:客服,admin:管理员
organization_idinteger所属组织编号
phonestring电话
detailsstring详细信息
notesstring注释
signaturestring用户签名
statusinteger帐号状态
field_xxxstring用户自定义字段(后缀代表用户自定义字段的编号)高级版拥有此功能
2.6 请求示例
http://yourdomain.kf5.com/api/v1/user/add?username=your@126.com&sign=12d45c66523dd069d7c64c22fea10f34
2.7 返回参数说明
参数名称说明
err返回码。0:执行成功,1:有错误
msg如果错误,返回错误信息。
datas返回数据
id用户ID编号
username用户邮箱
name昵称
role角色
organization_id所属组织编号
photo头像
phone电话
details详细信息
notes注释
signature用户签名
status帐号状态
field_xxx用户自定义字段(后缀代表用户自定义字段的编号)高级版拥有此功能
2.8 正确返回示例
Content-type: text/html; charset=utf-8
{
	"err":0,
	"msg":""	
}
2.9 错误返回示例
Content-type: text/html; charset=utf-8
{
 	"err":1,
	"msg":"参数错误"
}

3 备注