获取单位信息
调用该接口获取指定单位的信息,包括单位 ID、名字、类型。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/contact/v3/unit/:unit_id |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | contact:unit:readonly 获取单位信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
unit_id | string | 单位 ID。 当你在创建单位时,可以在返回结果中获取单位 ID。你也可以调用获取单位列表接口,获取单位 ID。 示例值:"BU121" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ unit | unit | 单位信息。 |
└ unit_id | string | 单位 ID。 |
└ name | string | 单位名字。 |
└ unit_type | string | 单位类型。 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"unit": {
"unit_id": "BU121",
"name": "消费者事业部",
"unit_type": "事业部"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 40003 | internal error | 内部错误,请获取请求的 X-Request-Id,并向技术支持进行反馈。 |
| 400 | 43051 | unit_id invalid | 非法的单位 ID。调用获取单位列表接口,获取正确的单位 ID 后重试。 |
更多错误码信息,参见通用错误码。
