创建任务

导出文档访问记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportDocAccessLog",
  "attributes": {
    "doc_id": "DOC_ID",
    "start_at": "2021-06-12",
    "end_at": "2021-06-30",
    "file_type": "json"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportDocAccessLog 表示导出文档访问记录
doc_id	是	无	要导出的文档ID
start_at	否	3个月前	统计开始日期，不能超过3个月前
end_at	是	无	统计结束日期（导出包含当日的数据）
file_type	否	xlsx	导出文件类型，可选值：json，xlsx

返回结果：

{
  "code": 0,
  "msg": "success",
  "data": {
    "job_id": "xxxxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel，json文件

若导出文件格式为json，文件参数说明：

参数	说明
access_time	访问时间
agent	访问来源
corp_staff_id	账号
english_name	别名
name	姓名
organization	部门

导出考试成员记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportExamEventStatics",
  "attributes": {
    "exam_id": "exam_id",
    "file_type": "xlsx"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportExamEventStatics 表示导出考试成员记录
exam_id	是	无	要导出的考试ID
file_type	否	xlsx	导出文件类型，可选值：json，xlsx

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel 或 json文件

若导出文件参数说明：

参数	说明
corp_staff_id	账号
english_name	别名
name	姓名
organization	部门
enable	账号状态
exam_title	考试名称
exam_finish_at	考试完成时间
exam_credit	已获得学分
exam_result_score	最高成绩
exam_top_score_used_time	最高成绩时用时
exam_max_used_switch_count	平均用时
exam_times	考试次数
exam_max_used_switch_count	最高成绩切屏次数
exam_status	状态
tags	标签

导出考试答题记录（新）

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportExamEventAnswersV2",
  "attributes": {
    "exam_id": "9ebb4090906511ec93afa27b443c4520",
    "start_at": "2025-03-11",
    "end_at": "2025-03-13"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportExamEventAnswersV2表示导出考试答题记录
exam_id	是	无	要导出的考试ID
start_at	否	无	统计开始日期
end_at	否	无	统计结束日期（导出不包含当日数据）

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出 Excel 文件标头参数说明:

标头	说明
帐号	学员账号
姓名	学员姓名
别名	学员别名
部门	学员所在部门
账号状态	学员账号状态
提交答卷时间	学员提交答卷时间
分数	学员考试分数
用时（秒）	学员考试用时
标签	考试关联标签

导出考试答题记录（旧）

使用说明：即将废弃该接口，可直接使用导出考试答题记录（新）

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportExamEventAnswers",
  "attributes": {
    "exam_id": "9ebb4090906511ec93afa27b443c4520",
    "start_at": "2022-12-27",
    "end_at": "2023-03-28"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportExamEventAnswers表示导出考试答题记录
exam_id	是	无	要导出的考试ID
start_at	否	无	统计开始日期
end_at	否	无	统计结束日期（导出不包含当日数据）

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出课堂成员记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportClassParticipants",
  "attributes": {
    "class_id": "class_id",
    "learn_status": "0",
    "file_type": "json"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportClassParticipants 表示导出课堂成员记录
class_id	是	无	要导出的课堂ID
learn_status	否	无	0:未学习，1:学习中，2:已完成状态
file_type	否	xlsx	导出文件类型，可选值：json，xlsx

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel，json文件

若导出文件格式为json，文件参数说明：

参数	说明
corp_staff_id	账号
name	姓名
english_name	别名
organization	部门
enable	账号状态：有效 ，无效。
class_title	开课主题
learn_started_at	开始学习时间
learn_succeed_at	完成学习时间
score	已获得学分
learn_time	学习时长
valid_learn_time	有效时长
learn_status	状态
child_course_title|*	子课程*开课主题
child_learn_started_at|*	子课程*开始学习时间
child_learn_succeed_at|*	子课程*完成学习时间
child_learn_time|*	子课程*学习时长
child_valid_learn_time|*	子课程*有效时长
child_learn_status|*	子课程*状态
child_complete_status|*	子课程*完成方式

导出项目成员记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportRoadmapStaff",
  "attributes": {
    "roadmap_id": 7828,
    "staff_id": "zhangsan",
    "status": [1,2]
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportRoadmapStaff表示导出项目成员记录
roadmap_id	staff_id传空或不传时必须	无	要导出的项目ID
staff_id	roadmap_id传空或不传时必须	无	员工ID
status	否	2	成员项目状态 -1:全部，0:未开始，1:进行中，2:已完成，3:失败；支持多参数，格式：“1,2”

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出投票成员记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportCompanySurvey",
  "attributes": {
    "survey_id": "survey_id"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportCompanySurvey 表示导出投票成员记录
survey_id	是	无	要导出的投票ID

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出公司成员数据

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportCompanyStaff"
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportCompanyStaff 表示导出公司成员数据

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出成员培训统计

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportStaffStudyStatistics",
  "attributes": {
    "staff_id": "staff_id",
    "started_at": "2022-08-01",
    "ended_at": "2022-08-17"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportStaffStudyStatistics 表示导出成员培训统计
staff_id	是	无	成员ID
started_at	是	无	开始日期，不能超过一年前
ended_at	是	无	结束日期，结束日期要大于等于开始日期

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出单场直播记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportLiveStaffs",
  "attributes": {
    "live_id": "fbc99716404011ecba3e0242ac180005"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
live_id	是	无	直播id
action	是	无	导出任务类型，固定为：exportLiveStaffs 表示导出单场直播记录

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出单场直播签到人员

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportLiveCheckin",
  "attributes": {
    "live_id": "fbde872c0eca11ec8f658a8f483d7357"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
live_id	是	无	直播id
action	是	无	导出任务类型，固定为：exportLiveCheckin 表示导出单场直播签到人员

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出单场直播预约人员列表

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportLiveSubscribe",
  "attributes": {
    "live_id": "fbde872c0eca11ec8f658a8f483d7357"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
live_id	是	无	直播id
action	是	无	导出任务类型，固定为：exportLiveSubscribe 表示导出单场直播预约人员列表

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出应用增量报表

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
    "action": "exportAppIncrement",
    "attributes": {
        "start_at": "2023-06-25",
        "end_at": "2023-07-04",
        "period": "day"
    }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportAppIncrement 表示导出增量数据报表
start_at	是	无	开始时间，格式：2023-07-01
end_at	是	无	开始时间，格式：2023-07-30
period	是	无	时间类型 日：day; 周：week; 月：month

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出单个项目的成员统计记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
    "action": "exportRoadmapStatistics",
    "attributes": {
        "roadmap_id": 12
    }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportRoadmapStatistics 导出单个项目的成员统计记录表
roadmap_id	是	无	项目id

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出作业统计

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
    "action": "exportAssignmentStatistics",
    "attributes": {
        "assignment_id": "5070852e056c11f0b04a0ad6ad9d7894",
        "status": [1,0]
    }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportAssignmentStatistics 导出作业统计表
assignment_id	是	无	作业id
status	否	0	成员作业状态 -1:全部，0:未提交，1:已提交，2:已批改，3:已打回；支持多参数，格式：“1,2”

返回结果：

{
  "msg": "success",
  "code": 0,
  "data": {
    "job_id": "xxx"
  }
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出单场直播评论记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportLiveChat",
  "attributes": {
    "live_id": "7e8c30b6e43311ef87fb5a21b313baf7"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportLiveChat表示直播评论内容
live_id	是	无	直播id

返回结果：

{
    "data": {
        "job_id": "eb04cbace9da11ef9263a6df45e5cff2"
    },
    "msg": "success",
    "code": 0
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出单场直播送礼记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?access_token={access_token}

请求包体：

{
  "action": "exportLiveGiftLog",
  "attributes": {
    "live_id": "7e8c30b6e43311ef87fb5a21b313baf7"
  }
}

参数说明：

参数	是否必须	默认值	说明
access_token	是	无	调用接口凭证
action	是	无	导出任务类型，固定为：exportLiveGiftLog表示直播送礼记录
live_id	是	无	直播id

返回结果：

{
    "data": {
        "job_id": "eb04cbace9da11ef9263a6df45e5cff2"
    },
    "msg": "success",
    "code": 0
}

参数说明：

参数	说明
job_id	任务ID，可通过查询任务接口查询任务进度，当任务完成时，可通过download_url下载excel文件

导出陪练成员记录

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.com/cgi-bin/v1/jobs?action=exportAITrainingStaffStats

请求包体：

{ 
    "action":"exportAITrainingStaffStats",
    "attributes": {
      "scenario_id": "ddaadd054fe94cca828eb8779ecbxxxx"
  }
}

参数说明：

参数	是否必须	默认值	说明
action	是	无	导出任务类型，固定为：exportAITrainingStaffStats，表示导出AI陪练成员记录
attributes.scenario_id	是	无	陪练场景ID

返回结果：

200 OK 状态码

{
    "data": {
        "job_id": "0a147c42324a11f0b22efabc5axxxxxxx"
    },
    "msg": "success",
    "code": 0
}

参数	说明
job_id	任务ID，可通过查询任务接口查询任务接口查询任务进度，当任务完成时，可通过download_url下载json文件

400 Bad Request 状态码

{
    "errors": [
        {
            "detail": "{\"action\":[\"选定的 action 是无效的.\"]}"
        }
    ]
}

{
    "errors": [
        {
            "detail": "{\"action\":[\"不能为空\"]}"
        }
    ]
}

导出陪练评价报告

请求方式：POST（HTTPS）

请求地址：https://lxapi.lexiangla.net/cgi-bin/v1/jobs?action=exportAITrainingStaffEvaluation 请求包体：

{ 
    "action":"exportAITrainingStaffEvaluation",
    "attributes": {
      "scenario_id": "ddaadd054fe94cca828eb8779ecbxxxx"
  }
}

参数说明：

参数	是否必须	默认值	说明
action	是	无	导出任务类型，固定为：exportAITrainingStaffEvaluation，表示导出AI陪练成员评估报告
attributes.scenario_id	是	无	陪练场景ID

返回结果：

200 OK 状态码

{
    "data": {
        "job_id": "0a147c42324a11f0b22efabc5axxxxxxx"
    },
    "msg": "success",
    "code": 0
}

参数	说明
job_id	任务ID，可通过查询任务接口查询任务接口查询任务进度，当任务完成时，可通过download_url下载json文件

400 Bad Request 状态码

{
    "errors": [
        {
            "detail": "{\"action\":[\"选定的 action 是无效的.\"]}"
        }
    ]
}

{
    "errors": [
        {
            "detail": "{\"action\":[\"不能为空\"]}"
        }
    ]
}