聆客开放平台
从Link同步组织到第三方应用
同步第三方部门到Link（父部门必须在子部门之前，可同时传递）

# 从Link同步组织到第三方应用

GET /v1/organizations/sync

应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。参数不传或传Null表示不修改，传空字符串表示改为null。 参见接入事项-应用身份认证接口

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
cursor integer N query 最后修改时间
limit integer N query 数量

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfListOfOrganizationSyncParam 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/organizations/sync?cursor={cursor}&limit={limit}

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "data" : [ {                          //请求返回的数据
    "orgNum" : "string",                //部门编号
    "orderNo" : "integer",              //排序，默认：0
    "hidden" : "boolean",
    "level" : "integer",                //层级
    "linkOrgId" : "string",             //Link内部的部门ID，必须是UUID，不指定则随机生成新的UUID
    "fullName" : "string",              //部门全称
    "description" : "string",           //部门描述
    "telephone" : "string",             //联系电话
    "enableChat" : "integer",           //是否允许聊天（1：允许，0：不允许），默认：1
    "source" : "string",                //检测来源
    "fullPathName" : "string",          //全名称
    "secretLevel" : "integer",          //用户隐私密级，默认：0
    "orgId" : "string",                 //同步方的部门ID
    "parentId" : "string",              //同步方的父部门ID
    "isForceReceive" : "boolean",       //是否强制接收消息，为true时用户开启部门消息免打扰将无效，默认：false
    "isHidden" : "boolean",             //是否隐藏，默认：false
    "principal" : "string",             //负责人
    "linkParentId" : "string",          //Link内部的父部门ID
    "deleted" : "boolean",
    "isDeleted" : "boolean",            //是否删除，默认：false
    "forceReceive" : "boolean",
    "name" : "string",                  //部门名称
    "email" : "string",                 //部门邮箱
    "status" : "integer"                //状态（1：启用， 0：停用），默认：1
  } ],
  "code" : "integer",                   //结果码 200:成功
  "message" : "string"                  //当状态码不是200时，错误信息
}

PUT /v1/organizations/sync

企业应用身份：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。
域应用身份：注册应用，联系管理员配置应用id绑定企业域。

参数不传或传Null表示不修改，传空字符串表示改为null。

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
orgs OrganizationSyncParam[ ] Y body 部门列表
indicated-e-code string N header 域权限应用身份请求，需要设置企业编码

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfListOfSyncFailLog 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

PUT /v1/organizations/sync
Content-Type: application/json

[ {
  "orgNum" : "string",                //部门编号
  "orderNo" : "integer",              //排序，默认：0
  "hidden" : "boolean",
  "level" : "integer",                //层级
  "linkOrgId" : "string",             //Link内部的部门ID，必须是UUID，不指定则随机生成新的UUID
  "fullName" : "string",              //部门全称
  "description" : "string",           //部门描述
  "telephone" : "string",             //联系电话
  "enableChat" : "integer",           //是否允许聊天（1：允许，0：不允许），默认：1
  "source" : "string",                //检测来源
  "fullPathName" : "string",          //全名称
  "secretLevel" : "integer",          //用户隐私密级，默认：0
  "orgId" : "string",                 //同步方的部门ID
  "parentId" : "string",              //同步方的父部门ID
  "isForceReceive" : "boolean",       //是否强制接收消息，为true时用户开启部门消息免打扰将无效，默认：false
  "isHidden" : "boolean",             //是否隐藏，默认：false
  "principal" : "string",             //负责人
  "linkParentId" : "string",          //Link内部的父部门ID
  "deleted" : "boolean",
  "isDeleted" : "boolean",            //是否删除，默认：false
  "forceReceive" : "boolean",
  "name" : "string",                  //部门名称
  "email" : "string",                 //部门邮箱
  "status" : "integer"                //状态（1：启用， 0：停用），默认：1
} ]

# 返回示例

Content-Type: application/json;charset=UTF-8

{
  "data" : [ {                  //请求返回的数据
    "id" : "string",            //同步方的ID
    "message" : "string"        //失败原因
  } ],
  "code" : "integer",           //结果码 200:成功
  "message" : "string"          //当状态码不是200时，错误信息
}

← 接口定义 →