昶戈开放平台
  1. 企业配置
昶戈开放平台
  • 昶戈开放平台
    • 概述
    • 对接步骤
    • 开始开发
      • 获取企业授权
    • 通讯录管理
      • 岗位管理
        • 批量添加岗位
        • 删除岗位
        • 获取岗位列表
        • 增加/修改岗位信息
        • 批量删除岗位成员数据
        • 增加岗位成员数据
      • 成员管理
        • 批量增加修改用户信息
        • 批量删除用户
        • 批量启用用户
        • 批量停用用户
        • 获取用户列表
        • 增加修改用户信息
        • 获取显示企业用户自定义字段列表 *
      • 产品线管理
        • 删除产品线
        • 获取产品线列表
        • 增加修改产品线人员信息
        • 增加修改产品线信息
      • 标签管理
        • 删除标签
        • 获取标签列表
        • 增加修改标签信息
        • 批量删除标签成员数据
        • 获取标签成员数据
        • 增加标签成员数据
      • 部门管理
        • 批量添加/修改部门
        • 批量添加部门(树形结构添加)
        • 删除部门
        • 获取部门列表
        • 增加修改部门信息
    • 授权登录
      • 免登录URL
    • 合作商开放接口
      • 企业配置
        • 获取合作商授权 *
          GET
        • 删除企业信息 *
          POST
        • 获取企业列表 *
          POST
        • 增加/修改企业信息 *
          POST
    • 消息和事件通知
      • 消息和事件通知
        • 订阅 *
        • 取消订阅 *
      • 消息和事件通知接收消息
        • 接收消息推送
    • 培训数据
      • 课程
        • 获取PC端首页第一个推荐课程
        • 获取移动端首页第一个推荐课程 *
      • 学员培训数据
        • 获取学员培训项目数据
        • 获取学员培训项目数据 V2
      • 实验室课程
        • 获取课程人员基础信息接口
        • 实验数据上传接口
    • 附录
      • 加密及算法
  1. 企业配置

获取企业列表 *

测试环境
https://api.test.tgtrain.cn
测试环境
https://api.test.tgtrain.cn
POST
/partner/customer/list
/partner/customer 合作商_企业配置
获取企业列表

请求参数

Query 参数
access_token
string 
合作商密钥
必需
Body 参数application/json
customerCode
string 
客户标识
可选
customerName
string 
客户名称
可选
own
boolean 
只看自己
可选
page
integer 
可选
*当前页(导出时可不填)
示例值:
1
pageSize
integer 
可选
*每页记录数量(导出时可不填)
示例值:
30
partnerId
integer 
可选
合作伙伴编号 企业来源
sort
integer 
可选
排序 0不处理 1正序排序 2倒序排序
sortKey
string 
按KEY排序
可选
sourceType
integer 
可选
租户来源 手动创建、官网注册、企微市场、企微市场【成员】、钉钉市场、钉钉市场【成员】、企微市场-官网安装
status
integer 
可选
状态 0全部 1已过期 2未过期 3一个月内过期 4两个月内过期
versionId
integer 
购买系统版本
可选
示例
{
    "customerCode": "string",
    "customerName": "string",
    "own": true,
    "page": 1,
    "pageSize": 30,
    "partnerId": 0,
    "sort": 0,
    "sortKey": "string",
    "sourceType": 0,
    "status": 0,
    "versionId": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.test.tgtrain.cn/partner/customer/list?access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerCode": "string",
    "customerName": "string",
    "own": true,
    "page": 1,
    "pageSize": 30,
    "partnerId": 0,
    "sort": 0,
    "sortKey": "string",
    "sourceType": 0,
    "status": 0,
    "versionId": 0
}'

返回响应

🟢200返回企业列表
application/json
Body
array of:
accounts
integer 
购买账号数量
可选
areaId
integer 
中孚区域编号 固定
可选
authMode
integer 
可选
授权模式:0为管理员授权;1为成员授权
beginDate
integer 
开通时间
可选
city
string 
城市
可选
concurrents
integer 
并发数
可选
contactEmail
string 
联系邮箱
可选
contactMobile
string 
联系手机号
可选
contactName
string 
联系人
可选
copyright
string 
版权声明
可选
createTime
integer 
创建时间
可选
createUid
integer 
创建人
可选
customerCode
string 
客户标识
可选
customerId
integer 
客户编号
可选
customerName
string 
客户名称
可选
customerShortName
string 
客户名称简称
可选
customerType
integer 
可选
企业来源 1客户 2合作伙伴 3供应商 4飞书
defPass
string 
员工默认密码
可选
disclaimer
string 
免责声明
可选
diskUseSize
integer 
可选
空间使用大小, 单位是M
expireDate
integer 
到期日期
可选
industryId
integer 
所属行业
可选
industryName
string 
行业名称
可选
loginImg
string 
登录图片
可选
loginType
integer 
可选
登陆类型:1侧边logo;2整个背景图片;3自定义+资源包
logo1
string 
前台Logo
可选
logo2
string 
后台Logo
可选
members
integer 
用户数量
可选
mobileSkin
string 
手机端皮肤
可选
orgCode
string 
中孚机构代码 唯一
可选
partnerId
integer 
合作伙伴编号
可选
partnerName
string 
合作伙伴名称
可选
permanentCode
string 
企业微信永久授权码
可选
realName
string 
创建人
可选
sourceType
integer 
可选
租户来源 1企业微信应用市场 2企业微信应用市场-官网安装 3飞书应用市场 4飞书应用市场-官网安装 11官网注册
storageSize
integer 
存储空间 单位是G
可选
theme
string 
主题
可选
useAudit
integer 
可选
开启审核 1开启 2不开启
useGroup
integer 
可选
开启管理小组 1开启 2不开启
useMajor
integer 
可选
开启产品线 1开启 2不开启
versionId
integer 
购买系统版本
可选
versionName
string 
版本名称
可选
示例
[
    {
        "accounts": 0,
        "areaId": 0,
        "authMode": 0,
        "beginDate": 0,
        "city": "string",
        "concurrents": 0,
        "contactEmail": "string",
        "contactMobile": "string",
        "contactName": "string",
        "copyright": "string",
        "createTime": 0,
        "createUid": 0,
        "customerCode": "string",
        "customerId": 0,
        "customerName": "string",
        "customerShortName": "string",
        "customerType": 0,
        "defPass": "string",
        "disclaimer": "string",
        "diskUseSize": 0,
        "expireDate": 0,
        "industryId": 0,
        "industryName": "string",
        "loginImg": "string",
        "loginType": 0,
        "logo1": "string",
        "logo2": "string",
        "members": 0,
        "mobileSkin": "string",
        "orgCode": "string",
        "partnerId": 0,
        "partnerName": "string",
        "permanentCode": "string",
        "realName": "string",
        "sourceType": 0,
        "storageSize": 0,
        "theme": "string",
        "useAudit": 0,
        "useGroup": 0,
        "useMajor": 0,
        "versionId": 0,
        "versionName": "string"
    }
]
🔴500返回错误消息
修改于 2023-11-27 06:58:20
上一页
删除企业信息 *
下一页
增加/修改企业信息 *
Built with