腾讯乐享接口文档

# 搜索

通过开放接口获取的搜索内容与页面获取的内容有所不同，通过此开放接口获取的内容列表不会提示实体内容保密。

若开发者需要隐藏保密实体的标题，可根据返回列表中的privilege_type字段以及关联实体team中的team.is_secret自行过滤。

$can_show = $doc->privilege_type==0 && $doc->team->is_secret==0;

# 接口调用说明：

GET https://lxapi.lexiangla.com/cgi-bin/v1/search?type={type}&keyword={keyword}&team_code={team_code}

# 参数说明：

参数 是否必须 默认值 说明
type 是 无 表示要搜索的资源类型，文档：doc，乐问：question，论坛：thread，活动：event，投票：survey，轻享：share，K吧：team，直播：liveroom，课堂：clazz
keyword 是 无 要搜索的关键字
sort 否 相关度 -created_at：按创建时间倒序返回（不支持k吧） ；created_at：按创建时间顺序返回（不支持k吧） ；-edited_at：按更新时间倒序返回（仅支持课堂）；edited_at：按更新时间顺序返回（仅支持课堂）；-read_count：按浏览量倒序返回（仅支持课堂和直播）；read_count：按浏览量顺序返回（仅支持课堂和直播）；
team_code 否 无 k吧code，支持按照传入的K吧，仅搜索该K吧内的知识

# SDK封装方法使用示例：

$Lxapi = new \Lexiangla\Openapi\Api(AppKey, AppSecret);
$response = $Lxapi->get('search?type=doc&keyword=打印机&page=2&per_page=2');

# 文档响应document

# 200 OK 状态码
{
  "data": [
    {
      "type": "doc", 
      "id": "36689dde9dc711ecaec97e92b72f4d8e", 
      "attributes": {
        "name": "搜索", 
        "privilege_type": 0, 
        "is_star": 0, 
        "comment_count": 0, 
        "read_count": 1, 
        "created_at": "2022-03-07 11:32:27", 
        "updated_at": "2022-03-07 11:32:27", 
        "edited_at": "2022-03-07 11:32:27", 
        "recommended_at": null, 
        "picture_url": "", 
        "allow_comment": 1, 
        "only_team": null, 
        "search_summary": "搜索，一是指仔细查找，搜寻，如徐怀中 《西线轶事》八：“在树棵里搜索了好久，什么也没有发现。”也指往来貌；接续貌。如《文选·王褒》：“玄猿悲啸，搜索乎其间。”李善注：“搜索，往来貌。”"
      }, 
      "links": {
        "platform": "https://lexiangla.com/docs/36689dde9dc711ecaec97e92b72f4d8e?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }, 
        "category": {
          "data": {
            "type": "category", 
            "id": "6397c720dc0311eb83dad64054d9ee53"
          }
        }
      }
    }, 
    {
      "type": "doc", 
      "id": "4ce6914c9dc711ec99807e92b72f4d8e", 
      "attributes": {
        "name": "搜索2", 
        "privilege_type": 0, 
        "is_star": 0, 
        "comment_count": 0, 
        "read_count": 1, 
        "created_at": "2022-03-07 11:33:05", 
        "updated_at": "2022-03-07 11:33:05", 
        "edited_at": "2022-03-07 11:33:05", 
        "recommended_at": null, 
        "picture_url": "", 
        "allow_comment": 1, 
        "only_team": null, 
        "search_summary": "搜索的内容"
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100004/docs/4ce6914c9dc711ec99807e92b72f4d8e?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }, 
        "category": {
          "data": {
            "type": "category", 
            "id": "6397c720dc0311eb83dad64054d9ee53"
          }
        }, 
        "team": {
          "data": {
            "type": "team", 
            "id": "e78db5d6018211ecaecd4a8bbfee0a0f"
          }
        }
      }
    }, 
    {
      "type": "doc", 
      "id": "63a32976dc0311eb8c22d64054d9ee53", 
      "attributes": {
        "name": "乐享新手攻略：快速开启乐享社区之旅", 
        "privilege_type": 0, 
        "is_star": 1, 
        "comment_count": 0, 
        "read_count": 0, 
        "created_at": "2021-07-03 21:34:27", 
        "updated_at": "2021-07-03 21:34:28", 
        "edited_at": "2021-07-03 21:34:27", 
        "recommended_at": null, 
        "picture_url": "https://static.lexiang-asset.com/build/img/init/v1/xin_shou_gong_lue-ecb3589aac.png", 
        "allow_comment": 1, 
        "only_team": null, 
        "search_summary": "欢迎使用乐享！ 腾讯是互联网化知识管理先驱者，分享和学习已经成为员工工作的一部分。每天，会有70%的员工主动登录知识社区，在此分享和查阅工作相关的文档，请教专家技术产品难点，与同事讨论新的产品趋势与方案。腾讯KM已经成为业界标杆。 乐享是基于腾讯多年知识社区最佳实践打造的企业云应用。乐享，也将会是你的沟通、工作、学习、生活一站式企业社区。 多终端访问乐享 使用手机和电脑均可登录乐享： 1、手机登录： 手机打开企业微信，在“工作台”中点击“乐享”即可进入乐享主页。 2、电脑登录： 方式一：用电脑打开企业微信"
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100001/docs/63a32976dc0311eb8c22d64054d9ee53?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "system-bot"
          }
        }, 
        "category": {
          "data": {
            "type": "category", 
            "id": "63996382dc0311ebba82d64054d9ee53"
          }
        }, 
        "team": {
          "data": {
            "type": "team", 
            "id": "62ff5094dc0311eb8612d64054d9ee53"
          }
        }
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 3, 
    "total": 3
  }, 
  "included": [
    {
      "type": "staff", 
      "id": "zuo", 
      "attributes": {
        "name": "左", 
        "english_name": null, 
        "organization": "测试组"
      }
    }, 
    {
      "type": "staff", 
      "id": "system-bot", 
      "attributes": {
        "name": "小秘书", 
        "english_name": null, 
        "organization": null
      }
    }, 
    {
      "type": "category", 
      "id": "6397c720dc0311eb83dad64054d9ee53", 
      "attributes": {
        "name": "规章制度", 
        "weight": 0
      }
    }, 
    {
      "type": "category", 
      "id": "63996382dc0311ebba82d64054d9ee53", 
      "attributes": {
        "name": "其他", 
        "weight": 0
      }
    }, 
    {
      "type": "team", 
      "id": "e78db5d6018211ecaecd4a8bbfee0a0f", 
      "attributes": {
        "code": "k100004", 
        "name": "测试", 
        "type": 2, 
        "logo": null, 
        "signature": "", 
        "is_secret": 0
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100004?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }
    }, 
    {
      "type": "team", 
      "id": "62ff5094dc0311eb8612d64054d9ee53", 
      "attributes": {
        "code": "k100001", 
        "name": "全员吧", 
        "type": 1, 
        "logo": null, 
        "signature": null, 
        "is_secret": 0
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100001?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }
    }
  ]
}

# 参数说明：

参数 说明
attributes.name 文档的标题
attributes.privilege_type 0表示文档公开
1表示部分人可见，
2表示仅创建者可见
attributes.is_star 文档是否K吧内星标文档
attributes.comment_count 文档的评论数
attributes.read_count 文档的浏览数
attributes.created_at 文档的创建时间
attributes.updated_at 文档最后的更新时间
attributes.edited_at 文档的编辑时间
attributes.recommended_at 若文档是管理员设置为推荐文档，则此处值为设置时间，否则为null
attributes.picture_url 链接显示的图片
attributes.allow_comment 是否允许评论：0表示不允许评论，1表示允许评论
attributes.only_team 参数为0，文档发布到k吧或公共知识库，
参数为1，文档将不发表在公共知识库内
attributes.search_summary 基于文档搜索关键词的搜索结果摘要

# 乐问响应document

# 200 OK 状态码
{
  "data": [
    {
      "type": "question", 
      "id": "298bd36c9de811ecbc009e6848d310b4", 
      "attributes": {
        "title": "搜索2", 
        "is_anonymous": 0, 
        "summary": "搜索2的内容", 
        "content": "搜索2的内容", 
        "read_count": 0, 
        "answer_count": 0, 
        "concern_count": 0, 
        "created_at": "2022-03-07 15:28:19", 
        "updated_at": "2022-03-07 15:28:19", 
        "search_summary": "搜索2的内容"
      }, 
      "links": {
        "platform": "https://lexiangla.com/questions/298bd36c9de811ecbc009e6848d310b4?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }, 
    {
      "type": "question", 
      "id": "1bdc14b69de811ec8ae89e6848d310b4", 
      "attributes": {
        "title": "测试搜索", 
        "is_anonymous": 0, 
        "summary": "搜索内容", 
        "content": "搜索内容", 
        "read_count": 0, 
        "answer_count": 0, 
        "concern_count": 0, 
        "created_at": "2022-03-07 15:27:56", 
        "updated_at": "2022-03-07 15:27:56", 
        "search_summary": "搜索内容"
      }, 
      "links": {
        "platform": "https://lexiangla.com/questions/1bdc14b69de811ec8ae89e6848d310b4?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 2, 
    "total": 2
  }, 
  "included": [
    {
      "type": "staff", 
      "id": "zuo", 
      "attributes": {
        "name": "左", 
        "english_name": null, 
        "organization": "测试组"
      }
    }
  ]
}

# 参数说明：

参数 说明
attributes.title 乐问的标题
attributes.summary 乐问的详情摘要
attributes.content 乐问的内容
attributes.read_count 乐问的浏览数
attributes.created_at 乐问的创建时间
attributes.updated_at 乐问最后的更新时间
attributes.concern_count 乐问的关注数
attributes.search_summary 基于乐问搜索关键词的搜索结果摘要
attributes.answer_count 乐问的回答数

# 论坛响应document

# 200 OK 状态码
{
  "data": [
    {
      "type": "thread", 
      "id": "156640969dea11ecaa729e6848d310b4", 
      "attributes": {
        "title": "搜索", 
        "content": "搜索的内容", 
        "summary": "搜索的内容", 
        "read_count": 0, 
        "post_count": 0, 
        "like_count": 0, 
        "is_anonymous": 0, 
        "created_at": "2022-03-07 15:42:04", 
        "updated_at": "2022-03-07 15:42:04", 
        "search_summary": "搜索的内容"
      }, 
      "links": {
        "platform": "https://lexiangla.com/threads/156640969dea11ecaa729e6848d310b4?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }, 
    {
      "type": "thread", 
      "id": "1d75c1e49dea11ec9db49e6848d310b4", 
      "attributes": {
        "title": "搜索1", 
        "content": "搜索1的内容", 
        "summary": "搜索1的内容", 
        "read_count": 0, 
        "post_count": 0, 
        "like_count": 0, 
        "is_anonymous": 0, 
        "created_at": "2022-03-07 15:42:18", 
        "updated_at": "2022-03-07 15:42:18", 
        "search_summary": "搜索的内容"
      }, 
      "links": {
        "platform": "https://lexiangla.com/threads/1d75c1e49dea11ec9db49e6848d310b4?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 2, 
    "total": 2
  }, 
  "included": [
    {
      "type": "staff", 
      "id": "zuo", 
      "attributes": {
        "name": "左", 
        "english_name": null, 
        "organization": "测试组"
      }
    }
  ]
}

# 参数说明：

参数 说明
attributes.title 帖子的标题
attributes.summary 帖子的详情摘要
attributes.content 帖子的内容
attributes.post_count 帖子的回复数量
attributes.read_count 帖子的浏览数
attributes.created_at 帖子的创建时间
attributes.updated_at 帖子最后的更新时间
attributes.like_count 帖子的点赞数量
attributes.search_summary 基于论坛关键词的搜索结果摘要
attributes.is_anonymous 是否匿名,1表示匿名,0表明不匿名

# 活动响应document

# 200 OK 状态码
化JSON：
{
  "data": [
    {
      "type": "event", 
      "id": "a342c6569dee11eca82e9e6848d310b4", 
      "attributes": {
        "title": "搜索2", 
        "content": "", 
        "summary": "", 
        "location": "深圳", 
        "logo": "//static.lexiang-asset.com/build/img/football-be060529.png", 
        "privilege_type": 0, 
        "closed_at": null, 
        "started_at": "2022-03-07 16:14:00", 
        "ended_at": "2022-03-13 16:14:00", 
        "participant_count": 0, 
        "attendee_count": 0, 
        "participant_count_limit": null, 
        "created_at": "2022-03-07 16:14:40", 
        "attend_method": "qrcode", 
        "attend_location": "", 
        "attend_start_at": null, 
        "attend_end_at": null, 
        "search_summary": ""
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100006/events/a342c6569dee11eca82e9e6848d310b4?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }, 
        "team": {
          "data": {
            "type": "team", 
            "id": "c31f5f5c360611ecba6576b61b345692"
          }
        }
      }
    }, 
    {
      "type": "event", 
      "id": "8176a2689dee11eca845328d7ca48a8a", 
      "attributes": {
        "title": "搜索活动", 
        "content": "欢迎参加搜索活动", 
        "summary": "欢迎参加搜索活动", 
        "location": "深圳", 
        "logo": "//static.lexiang-asset.com/build/img/training-4c4f5c0e.png", 
        "privilege_type": 0, 
        "closed_at": null, 
        "started_at": "2022-03-07 16:12:00", 
        "ended_at": "2022-03-13 16:12:00", 
        "participant_count": 0, 
        "attendee_count": 0, 
        "participant_count_limit": null, 
        "created_at": "2022-03-07 16:13:44", 
        "attend_method": "qrcode", 
        "attend_location": "", 
        "attend_start_at": "2022-03-07 16:12:00", 
        "attend_end_at": "2022-03-13 16:12:00", 
        "search_summary": "欢迎参加搜索活动"
      }, 
      "links": {
        "platform": "https://lexiangla.com/events/8176a2689dee11eca845328d7ca48a8a?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 2, 
    "total": 2
  }, 
  "included": [
    {
      "type": "staff", 
      "id": "zuo", 
      "attributes": {
        "name": "zuo", 
        "english_name": null, 
        "organization": "测试组"
      }
    }
  ]
}

# 参数说明：

参数 说明
attributes.title 活动的标题
attributes.summary 活动的详情摘要
attributes.content 活动的内容
attributes.location 活动的地点
attributes.logo 活动的封面图片地址
attributes.created_at 活动的创建时间
attributes.started_at 活动的开始时间
attributes.ended_at 活动的截止时间
attributes.participant_count 活动的参加人数
attributes.search_summary 基于活动搜索关键词的搜索结果摘要
attributes.attendee_count 活动的签到人数
attributes.participant_count_limit 活动的人数限制，为null表示没有限制
attributes.privilege_type 活动的公开情况：
0表示文档公开
1表示部分人可见，
2表示仅创建者可见
attributes.attend_method 活动签到方式
attributes.attend_location 活动签到地点
attributes.attend_start_at 活动签到开始时间
attributes.attend_end_at 活动签到截止时间

# 投票响应document

# 200 OK 状态码
{
  "data": [
    {
      "type": "survey", 
      "id": "988a12a29df111ecb825328d7ca48a8a", 
      "attributes": {
        "title": "k吧搜索", 
        "summary": "", 
        "ended_at": null, 
        "privilege_type": 0, 
        "read_count": 0, 
        "comment_count": 0, 
        "participant_count": 0, 
        "type": "normal", 
        "created_at": "2022-03-07 16:35:51", 
        "search_summary": ""
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100006/surveys/988a12a29df111ecb825328d7ca48a8a?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }, 
        "team": {
          "data": {
            "type": "team", 
            "id": "c31f5f5c360611ecba6576b61b345692"
          }
        }
      }
    }, 
    {
      "type": "survey", 
      "id": "833b24409df111ec9134328d7ca48a8a", 
      "attributes": {
        "title": "搜索投票", 
        "summary": "", 
        "ended_at": null, 
        "privilege_type": 0, 
        "read_count": 1, 
        "comment_count": 0, 
        "participant_count": 0, 
        "type": "normal", 
        "created_at": "2022-03-07 16:35:15", 
        "search_summary": ""
      }, 
      "links": {
        "platform": "https://lexiangla.com/surveys/833b24409df111ec9134328d7ca48a8a?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 2, 
    "total": 2
  }, 
  "included": [
    {
      "type": "staff", 
      "id": "zuo", 
      "attributes": {
        "name": "左", 
        "english_name": null, 
        "organization": "测试组"
      }
    }
  ]
}

# 参数说明：

参数 说明
attributes.title 投票的标题
attributes.summary 投票的摘要内容
attributes.created_at 投票的创建时间
attributes.ended_at 投票的截止时间
attributes.read_count 投票的访问量
attributes.search_summary 基于投票搜索关键词的搜索结果摘要
attributes.comment_count 投票的评论数量
attributes.participant_count 投票的参加人数
attributes.type 投票类型：normal普通，election评选类，third_party第三方应用
attributes.privilege_type 投票的公开情况，
0表示文档公开
1表示部分人可见，
2表示仅创建者可见

# 轻享响应document

# 200 OK 状态码
{
  "data": [
    {
      "type": "share", 
      "id": "22f618689df311ec8ea29e6848d310b4", 
      "attributes": {
        "content": "搜索;", 
        "summary": "搜索", 
        "multimedia": null, 
        "is_top": false, 
        "like_count": 0, 
        "like_type_count": null, 
        "reply_count": 0, 
        "created_at": "2022-03-07 16:46:53", 
        "search_summary": "搜索;"
      }, 
      "links": {
        "platform": "https://lexiangla.com/company/global/moments/22f618689df311ec8ea29e6848d310b4?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }, 
    {
      "type": "share", 
      "id": "267d573a9df311ecbfc8328d7ca48a8a", 
      "attributes": {
        "content": "搜索1;", 
        "summary": "搜索1", 
        "multimedia": null, 
        "is_top": false, 
        "like_count": 0, 
        "like_type_count": null, 
        "reply_count": 0, 
        "created_at": "2022-03-07 16:46:59", 
        "search_summary": "搜索;"
      }, 
      "links": {
        "platform": "https://lexiangla.com/company/global/moments/267d573a9df311ecbfc8328d7ca48a8a?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }, 
      "relationships": {
        "owner": {
          "data": {
            "type": "staff", 
            "id": "zuo"
          }
        }
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 2, 
    "total": 2
  }, 
  "included": [
    {
      "type": "staff", 
      "id": "zuo", 
      "attributes": {
        "name": "左", 
        "english_name": null, 
        "organization": "测试组"
      }
    }
  ]
}

# 参数说明：

参数 说明
attributes.content 轻享的内容
attributes.summary 轻享详情摘要
attributes.created_at 轻享的创建时间
attributes.multimedia 多媒体内容，可参考创建轻享类型的说明
attributes.is_top 轻享是否置顶
attributes.like_count 轻享点赞总数
attributes.like_type_count 轻享每种表情点赞的数（点赞后，接口获取同步有点延缓）
attributes.reply_count 轻享评论回复数
attributes.search_summary 基于轻享搜索关键词的搜索结果摘要

# K吧响应document

# 200 OK 状态码
{
  "data": [
    {
      "type": "team", 
      "id": "c267b7489df411ec8046328d7ca48a8a", 
      "attributes": {
        "code": "k100007", 
        "name": "名字叫搜索的K吧", 
        "type": 2, 
        "logo": null, 
        "signature": "", 
        "is_secret": 0
      }, 
      "links": {
        "platform": "https://lexiangla.com/teams/k100007?company_from=6093c498dc0311ebadd9d64054xxxxxx"
      }
    }
  ], 
  "links": {
    "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1", 
    "prev": null, 
    "next": null
  }, 
  "meta": {
    "current_page": 1, 
    "from": 1, 
    "last_page": 1, 
    "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search", 
    "per_page": 20, 
    "to": 1, 
    "total": 1
  }
}

# 参数说明：

参数 说明
attributes.code K吧的code
attributes.name K吧的名字
attributes.type K吧应用场景类型；1：自定义;2：知识沉淀;3：项目管理;4：协会培训
attributes.logo K吧封面地址
attributes.signature K吧介绍
attributes.is_secret 是否保密K吧

# 直播响应document

# 200 OK 状态码
{
    "data": [
        {
            "type": "live",
            "id": "146b0178c12011eca4a41a8ef11b6bbd",
            "attributes": {
                "title": "乐搭直播乐",
                "started_at": "2022-04-21 11:05:00",
                "intro": "直播简介直播",
                "content": "<p>直播详情</p>",
                "pic": "",
                "status": "finished",
                "push_url": "rtmp://livepush.lexiangla.com/live/146b0178c12011eca4a41a8ef11b6bbd?txSecret=b283aec06e0436f12169bfff762xxxx&txTime=626A045C&vod_sub_app_id=1400311082",
                "created_at": "2022-04-21 11:06:46",
                "updated_at": "2022-09-19 11:47:20",
                "visit_count": 7,
                "online_max_count": 0,
                "subscribe_count": 1,
                "push_method": "wechat work",
                "live_type": 0,
                "video_duration": 0,
                "watch_duration": 0,
                "is_face_detect": 0,
                "vertical": 0,
                "enable_question": 1,
                "enable_comment": 1,
                "enable_gift": 1,
                "enable_record": 1,
                "enable_playback": 0,
                "wx_code": "https://image-pub.lexiang-asset.com/company_85535ed0c66311e5a2f8bf5011933e87/assets/2022/04/146b0178c12011eca4a41a8ef11b6bbd.png",
                "wx_open_code": "",
                "read_count": 159,
                "search_summary": "<em>直播</em>简介<em>直播</em>"
            },
            "links": {
                "platform": "https://km.lexiangla.com/lives/146b0178c12011eca4a41a8ef11b6bbd",
                "manager": "https://km.lexiangla.com/lives/146b0178c12011eca4a41a8ef11b6bbd/settings",
                "qrcodeurl": "https://lexiangla.com/livepush?room_id=146b0178c12011eca4a41a8ef11b6bbd&company_from=km",
                "open": ""
            },
            "relationships": {
                "owner": {
                    "data": {
                        "type": "staff",
                        "id": "zhangsan"
                    }
                }
            }
        }
    ],
    "links": {
        "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1",
        "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1255",
        "prev": null,
        "next": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1255,
        "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search",
        "per_page": 1,
        "to": 1,
        "total": 1255
    },
    "included": [
        {
            "type": "staff",
            "id": "zhangsan",
            "attributes": {
                "name": "zhangsan",
                "english_name": "",
                "organization": "140 开发"
            }
        }
    ]
}

# 参数说明：

参数 说明
attributes.title 直播名称
attributes.started_at 直播开始时间
attributes.intro 直播简介
attributes.content 直播详情
attributes.pic 直播封面
attributes.status 直播状态
attributes.push_url 推流地址
attributes.created_at 创建时间
attributes.updated_at 更新之间
attributes.online_max_count 直播最高在线人数
attributes.subscribe_count 直播预约人数
attributes.push_method 直播方式
attributes.live_type 直播类型
attributes.enable_question 是否开启提问
attributes.enable_comment 是否开启评论
attributes.enable_gift 是否开启直播礼物
attributes.enable_record 是否开启直播录制
attributes.enable_playback 是否开启直播回放
attributes.wx_code 直播小程序码
attributes.wx_open_code 对外直播小程序码
attributes.read_count 直播观看人次

# 课堂响应document

# 200 OK 状态码
{
    "data": [
        {
            "type": "clazz",
            "id": "26e4c53ab1b311edbe811e93a4b94275",
            "attributes": {
                "type": 1,
                "course_count": 10,
                "title": "文档章节课堂",
                "description": "",
                "cover_img": "",
                "is_required": 0,
                "privilege_type": 0,
                "required_privilege_type": 0,
                "optional_privilege_type": 0,
                "read_count": 5,
                "comment_count": 0,
                "created_at": "2023-02-21 14:44:12",
                "updated_at": "2023-02-21 14:44:12",
                "recommended_at": null,
                "search_summary": "第一章 <em>课堂</em>doc 第一章 文档章节投票 第一章 <em>课堂</em>mp4 第一章 <em>课堂</em>pptx 第一章 <em>课堂</em>xls 第一章 <em>课堂</em>xlsx 2 <em>课堂</em>docx 2 <em>课堂</em>ppt 3 <em>课堂</em>pdf 3 <em>课堂</em>txt...",
                "participants_count": 5,
                "app_source_type": "clazz"
            },
            "links": {
                "platform": "https://km.lexiangla.com/classes/26e4c53ab1b311edbe811e93a4b94275?type=1",
                "manager": "https://km.lexiangla.com/classes/26e4c53ab1b311edbe811e93a4b94275/settings?type=1"
            },
            "relationships": {
                "owner": {
                    "data": {
                        "type": "staff",
                        "id": "ls-2"
                    }
                }
            }
        }
    ],
    "links": {
        "first": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=1",
        "last": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=537",
        "prev": null,
        "next": "https://lxapi.lexiangla.com/cgi-bin/v1/search?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 537,
        "path": "https://lxapi.lexiangla.com/cgi-bin/v1/search",
        "per_page": 1,
        "to": 1,
        "total": 537
    },
    "included": [
        {
            "type": "staff",
            "id": "ls-2",
            "attributes": {
                "name": "ls-2",
                "english_name": null,
                "organization": "129 "
            }
        }
    ]
}

# 参数说明：

参数 说明
attributes.type 课堂类型
attributes.course_count 子课程数
attributes.title 开课主题
attributes.description 课程介绍
attributes.cover_img 课程封面
attributes.comment_count 评论数量
attributes.required_privilege_type 必修学员范围。0：所有人; 1：部分人; 2.无;
attributes.optional_privilege_type 选修学员范围。0：所有人; 1：部分人; 2.无;
attributes.read_count 浏览量
attributes.created_at 创建时间
attributes.updated_at 更新时间
attributes.app_source_type 应用来源：clazz，课堂；roadmap，项目

← 文件夹 →