# 咨询信息
# 获取咨询列表
# 接口名称 :
GetStuInfoList
# 接口说明 :
获取咨询列表
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuInfoList (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| beginDate | 是 | datetime | └ 录入时间开始时间，（必填），时间格式示例：2020-01-01T00:00:00 |
| endDate | 是 | datetime | └ 录入时间结束时间，时间跨度为30天（必填），时间格式示例：2020-01-01T00:00:00 |
| schoolId | 否 | integer | └ 咨询校区ID（非必填） |
| stuName | 否 | string | └ 学员姓名（非必填） |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| stuInfoId | integer | └ 学员ID |
| stuName | string | └ 学员姓名 |
| sex | integer | └ 性别，0：未知，1：男，2：女 |
| mainTel | string | └ 主要电话 |
| minorTel | string | └ 次要电话 |
| otherTel | string | └ 其他电话 |
| mainTelRelationship | integer | └ 主要电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| minorTelRelationship | integer | └ 次要电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| otherTelRelationship | integer | └ 其他电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| interest | integer | └ 意向度，1：高，2：中，3：低，4：？ |
| lessonClassId | integer | └ 第一意向课程类别Id |
| lessonClassName | string | └ 第一意向课程类别名称 |
| secondLessonClassId | integer | └ 第二意向课程类别Id |
| secondLessonClassName | string | └ 第二意向课程类别名称 |
| thirdLessonClassId | integer | └ 第三意向课程类别Id |
| thirdLessonClassName | string | └ 第三意向课程类别名称 |
| schoolId | integer | └ 咨询校区 |
| schoolName | string | └ 咨询校区 |
| followUpState | integer | └ 跟进状态，1：待跟进，2：跟进中，3：已成交，4：已失效，5：已到访，6：已邀约，7：已试听； |
| classificationId | integer | └ 渠道分类Id |
| classificationName | string | └ 渠道分类 |
| channelId | integer | └ 渠道Id |
| channelName | string | └ 渠道 |
| remain | number | └ 余额 |
| introduceStuInfoId | integer | └ 介绍人学员ID |
| introduceStuName | string | └ 介绍人学员姓名 |
| addDate | datetime | └ 学员录入时间。时间格式示例：2020-01-01T00:00:00 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","beginDate":"@datetime","endDate":"@datetime","schoolId":"@integer(60, 100)","stuName":"@string"}
请求示例（Java SDK，即将开放，敬请期待）：
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStuInfoList(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"stuInfoId": "@integer(60, 100)",
"stuName": "@string",
"sex": 0,
"mainTel": "@string",
"minorTel": "@string",
"otherTel": "@string",
"mainTelRelationship": "@integer(60, 100)",
"minorTelRelationship": "@integer(60, 100)",
"otherTelRelationship": "@integer(60, 100)",
"interest": 1,
"lessonClassId": "@integer(60, 100)",
"lessonClassName": "@string",
"secondLessonClassId": "@integer(60, 100)",
"secondLessonClassName": "@string",
"thirdLessonClassId": "@integer(60, 100)",
"thirdLessonClassName": "@string",
"schoolId": "@integer(60, 100)",
"schoolName": "@string",
"followUpState": 1,
"classificationId": "@integer(60, 100)",
"classificationName": "@string",
"channelId": "@integer(60, 100)",
"channelName": "@string",
"remain": "@integer(60, 100)",
"introduceStuInfoId": "@integer(60, 100)",
"introduceStuName": "@string",
"addDate": "@datetime"
}
]
}
# 获取咨询详情
# 接口名称 :
GetStuInfo
# 接口说明 :
获取咨询详情
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetStuInfo (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| stuInfoId | 是 | integer | └ 学员Id |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | object | 返回数据信息 |
| stuInfoId | integer | └ 学员ID |
| stuName | string | └ 学员姓名 |
| sex | integer | └ 性别，0：未知，1：男，2：女 |
| mainTel | string | └ 主要电话 |
| minorTel | string | └ 次要电话 |
| otherTel | string | └ 其他电话 |
| mainTelRelationship | integer | └ 主要电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| minorTelRelationship | integer | └ 次要电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| otherTelRelationship | integer | └ 其他电话所属关系，1：母亲，5：父亲，9：自己，13：其他 |
| interest | integer | └ 意向度，1：高，2：中，3：低，4：？ |
| lessonClassId | integer | └ 第一意向课程类别Id |
| lessonClassName | string | └ 第一意向课程类别名称 |
| secondLessonClassId | integer | └ 第二意向课程类别Id |
| secondLessonClassName | string | └ 第二意向课程类别名称 |
| thirdLessonClassId | integer | └ 第三意向课程类别Id |
| thirdLessonClassName | string | └ 第三意向课程类别名称 |
| schoolId | integer | └ 咨询校区 |
| schoolName | string | └ 咨询校区 |
| followUpState | integer | └ 跟进状态，1：待跟进，2：跟进中，3：已成交，4：已失效，5：已到访，6：已邀约，7：已试听； |
| classificationId | integer | └ 渠道分类Id |
| classificationName | string | └ 渠道分类 |
| channelId | integer | └ 渠道Id |
| channelName | string | └ 渠道 |
| remain | number | └ 余额 |
| introduceStuInfoId | integer | └ 介绍人学员ID |
| introduceStuName | string | └ 介绍人学员姓名 |
| addDate | datetime | └ 学员录入时间。时间格式示例：2020-01-01T00:00:00 |
| stuInfoExtend | string | └ 扩展属性，json格式 |
| followupPeoples | array | └ 学员的跟进人（采单员、销售员等） |
| hrDocId | integer | └└ 员工ID |
| hrDocName | string | └└ 员工姓名 |
| followUpPeopleType | integer | └└ 跟进人类型 1：采单员， 2：电话销售， 3：前台， 4：销售员， 5：副销售员 |
请求正文：
{"stuInfoId":"@integer(60, 100)"}
请求示例（Java SDK，即将开放，敬请期待）：
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getStuInfo(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": {
"stuInfoId": "@integer(60, 100)",
"stuName": "@string",
"sex": 0,
"mainTel": "@string",
"minorTel": "@string",
"otherTel": "@string",
"mainTelRelationship": "@integer(60, 100)",
"minorTelRelationship": "@integer(60, 100)",
"otherTelRelationship": "@integer(60, 100)",
"interest": 1,
"lessonClassId": "@integer(60, 100)",
"lessonClassName": "@string",
"secondLessonClassId": "@integer(60, 100)",
"secondLessonClassName": "@string",
"thirdLessonClassId": "@integer(60, 100)",
"thirdLessonClassName": "@string",
"schoolId": "@integer(60, 100)",
"schoolName": "@string",
"followUpState": 1,
"classificationId": "@integer(60, 100)",
"classificationName": "@string",
"channelId": "@integer(60, 100)",
"channelName": "@string",
"remain": "@integer(60, 100)",
"introduceStuInfoId": "@integer(60, 100)",
"introduceStuName": "@string",
"addDate": "@datetime",
"stuInfoExtend": "@string",
"followupPeoples": [
{
"hrDocId": "@integer(60, 100)",
"hrDocName": "@string",
"followUpPeopleType": "@integer(60, 100)"
}
]
}
}
# 新建咨询
# 接口名称 :
AddStuInfo
# 接口说明 :
新建咨询
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/AddStuInfo (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| schoolId | 是 | integer | └ 咨询校区 |
| stuName | 是 | string | └ 学员姓名 |
| sex | 是 | integer | └ 性别，男、女、未知 |
| telphone | 是 | string | └ 主要联系方式 |
| telphoneRelationship | 是 | integer | └ 主要联系方式关系，1：母亲，5：父亲，9：自己，13：其他 |
| secondTelphone | 否 | string | └ 次要联系方式 |
| secondTelphoneRelationship | 否 | integer | └ 次要联系方式关系，1：母亲，5：父亲，9：自己，13：其他 |
| thirdTelphone | 否 | string | └ 其他联系方式 |
| thirdTelphoneRelationship | 否 | integer | └ 其他联系方式关系，1：母亲，5：父亲，9：自己，13：其他 |
| lessonClassID | 否 | integer | └ 第一意向课程 |
| secondLessonClassID | 否 | integer | └ 第二意向课程 |
| thirdLessonClassID | 否 | integer | └ 第三意向课程 |
| method | 是 | integer | └ 咨询方式，默认3，1：来电、2：来访、3：网络、4：其他 |
| interest | 是 | integer | └ 意向度，默认4，1：高、2：中、3：低、4：？ |
| followUpState | 是 | integer | └ 跟进状态，默认1，1：待跟进，2：跟进中，3：已成交，4：已失效，5：已到访，6：已邀约，7：已试听 |
| stuInfoExtend | 否 | string | └ 学员扩展属性，已json的格式，例如：{"学管师","张三","学号","20100101"}。选填 |
| adddate | 是 | datetime | └ 录入时间，默认为当前系统时间，时间格式示例：2020-01-01T00:00:00 |
| sellerId | 否 | integer | └ 销售员 |
| viceSalesId | 否 | integer | └ 副销售员 |
| teleMarketingId | 否 | integer | └ 电话销售 |
| purchaserId | 否 | integer | └ 采单员 |
| receptionId | 否 | integer | └ 前台 |
| introduceStuInfoId | 否 | integer | └ 介绍人学员id |
| channelName | 否 | string | └ 渠道名称 |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | integer | 返回数据信息 |
请求正文：
{"schoolId":"@integer(60, 100)","stuName":"@string","sex":0,"telphone":"@string","telphoneRelationship":1,"secondTelphone":"@string","secondTelphoneRelationship":1,"thirdTelphone":"@string","thirdTelphoneRelationship":1,"lessonClassID":"@integer(60, 100)","secondLessonClassID":"@integer(60, 100)","thirdLessonClassID":"@integer(60, 100)","method":1,"interest":1,"followUpState":1,"stuInfoExtend":"@string","adddate":"@datetime","sellerId":"@integer(60, 100)","viceSalesId":"@integer(60, 100)","teleMarketingId":"@integer(60, 100)","purchaserId":"@integer(60, 100)","receptionId":"@integer(60, 100)","introduceStuInfoId":"@integer(60, 100)","channelName":"@string"}
请求示例（Java SDK，即将开放，敬请期待）：
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.addStuInfo(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": "@integer(60, 100)"
}
# 获取试听记录列表
# 接口名称 :
GetTrialList
# 接口说明 :
获取试听记录列表
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetTrialList (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| beginDate | 是 | datetime | └ 搜索开始时间(查询日期类型)，区间跨度最大为一个月。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00 |
| endDate | 是 | datetime | └ 搜索结束时间(查询日期类型)，区间跨度最大为一个月。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00 |
| schoolId | 否 | integer | └ 校区id，可选 |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| stuInfoId | integer | └ 学员ID |
| trialStatus | integer | └ 试听状态 0 进行 1已到课 2未到课 3已取消 |
| lessonId | integer | └ 试听课程ID |
| periodStart | datetime | └ 试听上课开始时间。时间格式示例：2020-01-01T00:00:00 |
| periodEnd | datetime | └ 试听上课结束时间。时间格式示例：2020-01-01T00:00:00 |
| trialActivityId | integer | └ 试听活动ID |
| trialActivityName | string | └ 试听活动名称 |
| classroomList | array | └ 教室列表 |
| id | integer | └└ 教室ID |
| name | string | └└ 教室名称 |
| trialActivityId | integer | └└ 试听活动ID |
| teacherList | array | └ 教师列表 |
| id | integer | └└ 教师ID |
| name | string | └└ 教师名称 |
| teacherType | integer | └└ 教师类型 0 教师 1助教 |
| trialActivityId | integer | └└ 试听活动ID |
| trialTime | datetime | └ 试听时间。时间格式示例：2020-01-01T00:00:00 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","beginDate":"@datetime","endDate":"@datetime","schoolId":"@integer(60, 100)"}
请求示例（Java SDK，即将开放，敬请期待）：
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getTrialList(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"stuInfoId": "@integer(60, 100)",
"trialStatus": 0,
"lessonId": "@integer(60, 100)",
"periodStart": "@datetime",
"periodEnd": "@datetime",
"trialActivityId": "@integer(60, 100)",
"trialActivityName": "@string",
"classroomList": [
{
"id": "@integer(60, 100)",
"name": "@string",
"trialActivityId": "@integer(60, 100)"
}
],
"teacherList": [
{
"id": "@integer(60, 100)",
"name": "@string",
"teacherType": 0,
"trialActivityId": "@integer(60, 100)"
}
],
"trialTime": "@datetime"
}
]
}
# 获取试听活动列表
# 接口名称 :
GetTrialActivityList
# 接口说明 :
获取试听活动列表
请求地址：
HTTP：https://openplatform-api.xiaobao100.com/open-erp/OpenApi/GetTrialActivityList (opens new window)
Java：https://openplatform-api.xiaobao100.com (opens new window)
请求方式：
POST
请求类型：
Content-Type: application/json
请求头：
"token":"@string"
"corp-id":"@string"
"xb-timestamp":"@integer"
"xb-sign-method":"sha256"
"xb-sign":"@string"
请求参数：
| 参数名 | 是否必填 | 参数类型 | 参数描述 |
|---|---|---|---|
| pageIndex | 是 | integer | └ 当前页，默认从第1页开始 |
| pageSize | 是 | integer | └ 分页大小，默认50条 |
| beginDate | 是 | datetime | └ 搜索开始时间(查询日期类型)，区间跨度最大为一个月。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00 |
| endDate | 是 | datetime | └ 搜索结束时间(查询日期类型)，区间跨度最大为一个月。时间格式示例：2020-01-01、2020-01-01T00:00:00，时间格式示例：2020-01-01T00:00:00 |
| schoolId | 否 | integer | └ 校区id，可选 |
返回参数：
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码 |
| message | string | 描述信息 |
| data | array | 返回数据信息 |
| schoolId | integer | └ 校区id |
| stuCount | integer | └ 学员人数 |
| lessonId | integer | └ 试听课程ID |
| periodStart | datetime | └ 试听上课开始时间。时间格式示例：2020-01-01T00:00:00 |
| periodEnd | datetime | └ 试听上课结束时间。时间格式示例：2020-01-01T00:00:00 |
| trialActivityId | integer | └ 试听活动ID |
| trialActivityName | string | └ 试听活动名称 |
| classroomList | array | └ 教室列表 |
| id | integer | └└ 教室ID |
| name | string | └└ 教室名称 |
| trialActivityId | integer | └└ 试听活动ID |
| teacherList | array | └ 教师列表 |
| id | integer | └└ 教师ID |
| name | string | └└ 教师名称 |
| teacherType | integer | └└ 教师类型 0 教师 1助教 |
| trialActivityId | integer | └└ 试听活动ID |
| createdAt | datetime | └ 创建时间。时间格式示例：2020-01-01T00:00:00 |
请求正文：
{"pageIndex":"@integer(60, 100)","pageSize":"@integer(60, 100)","beginDate":"@datetime","endDate":"@datetime","schoolId":"@integer(60, 100)"}
请求示例（Java SDK，即将开放，敬请期待）：
TokenApi tokenApi = new TokenApi(String apiUrl);
TokenDTO dto = new TokenDTO();
dto.setAccessKeyId(String accessKeyId);
dto.setAccessKeySecret(String accessKeySecret);
String token = tokenApi.getToken(dto);
OpenApiApi api = new OpenApiApi(String apiUrl, String accesskeyId, String accessKeySecret, String token, String corpId);
api.getTrialActivityList(parameter [, parameter1, parameter2...])
返回示例：
{
"code": "@integer(60, 100)",
"message": "@string",
"data": [
{
"schoolId": "@integer(60, 100)",
"stuCount": "@integer(60, 100)",
"lessonId": "@integer(60, 100)",
"periodStart": "@datetime",
"periodEnd": "@datetime",
"trialActivityId": "@integer(60, 100)",
"trialActivityName": "@string",
"classroomList": [
{
"id": "@integer(60, 100)",
"name": "@string",
"trialActivityId": "@integer(60, 100)"
}
],
"teacherList": [
{
"id": "@integer(60, 100)",
"name": "@string",
"teacherType": 0,
"trialActivityId": "@integer(60, 100)"
}
],
"createdAt": "@datetime"
}
]
}