查询讲师列表

功能说明

查询员工列表。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/teacher/list?pageSize=10
&pageIndex=1&enterpriseId=分配的企业id

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明
version	String	Path	是	无	v1
extId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
pageSize	int	Query	是	无	每页数量（限制50）
pageIndex	int	Query	是	无	页码（从1开始）
search	String	Query	否	无	搜索关键词（姓名或手机号）

示例代码

返回结果示例：

成功时返回结果数据，失败时返回小鱼RESTAPI错误码

{
    "total": "7298",
    "pageSize": 10,
    "pageIndex": 0,
    "list": [
        {
            "teacherId": "123456",
            "name": "用户名称1",
            "phone": "13100000000",
            "countryCode": "+86",
            "mailbox": null,
            "profilePicture": null,
            "deptIds": [
                "1610"
            ],
            "schoolTypeId": "381098618670546946",
            "schoolTypeName": "研发",
            "subjectId": "381098619383578659",
            "subjectName": "培训",
            "roleName": "员工",
            "departmentNames": "小鱼易连",
            "description": "",
            "customFields": [
                {
                    "dataFieldId": "820312803842719745",
                    "fieldId": "807290927579136000",
                    "fieldName": "字段名称",
                    "fieldValue": "字段值"
                }
            ]
        }
    ]
}

返回参数说明

参数名称	说明
total	总数
pageIndex	页码
pageSize	查询数量
list	员工列表
teacherId	员工ID
name	姓名
phone	电话号码
mailbox	邮箱地址
countryCode	区号
profilePicture	头像地址
deptIds	归属部门id列表
schoolTypeId	培训类别id
schoolTypeName	培训类别
subjectId	培训子类别id
subjectName	培训子类别
roleName	角色名称
departmentNames	所属部门名称（英文逗号分隔）
description	员工简介
customFields	自定义字段列表
dataFieldId	自定义字段id
fieldId	自定义字段值id
fieldName	自定义字段名称
fieldValue	自定义字段值

2023-03-14 18:43:09

导出PDF文档