添加员工。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/teacher?enterpriseId=分配的企业id
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
name | Map | Body | 是 | 无 | 员工姓名,支持汉字、字母、数字和下划线(长度要求20位以内) |
countryCode | Sting | Body | 是 | 无 | 国家区号(默认是+86) |
phone | String | Body | 是 | 无 | 电话号码 |
mailbox | String | Body | 否 | 无 | 邮箱 |
departmentIds | Array | Body | 是 | 无 | 所属部门ID(数组类型) |
description | String | Body | 否 | 无 | 员工描述(长度要求300字以内) |
schoolTypeId | long | Body | 否 | 无 | 培训分类id |
subjectId | long | Body | 否 | 无 | 培训子类id |
roleId | long | Body | 否 | 无 | 角色id(默认是员工) |
sendMail | boolean | Body | 否 | 无 | true:发送邮件提醒,false:不发邮件 |
sendMessage | boolean | Body | 否 | 无 | true:发送短信提醒,false:不发短信 |
profilePictureId | long | Body | 否 | 无 | 头像资源id(文件上传oss后获得) |
请求消息体示例(Json)
{
"name": "李四",
"phone": "18380227711",
"countryCode": "+86",
"profilePictureId": "",
"roleId": "讲师",
"departmentIds": [1106]
"sendMail":true,
"sendMessage":true,
"description":""
}
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"teacherId":"1009825"
}
返回参数说明
参数名称 | 说明 |
teacherId | 员工id |