Skip to content

获取单个工作城市信息

调用该接口获取指定工作城市的信息,包括工作城市的 ID、名称、多语言名称以及启用状态。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/contact/v3/work_cities/:work_city_id
HTTP MethodGET
接口频率限制10 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可contact:work_city:readonly 获取工作城市列表 contact:contact:access_as_user 以用户身份访问通讯录 contact:contact:readonly_as_app 以应用身份读取通讯录

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
work_city_idstring工作城市 ID。你可以调用获取租户工作城市列表接口,获取工作城市 ID。
示例值:"dd39369b19b9"

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ work_citywork_city工作城市信息。
    └ work_city_idstring工作城市 ID。
    └ namestring工作城市名称。
    └ i18n_namei18n_content\[\]多语言工作城市名称。
      └ localestring语言版本。例如:
- zh_cn:中文 - en_us:英语 - ja_jp:日语
      └ valuestring多语言版本对应的值。
    └ statusboolean是否启用工作城市。
可能值有: - true:启用 - false:禁用

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "work_city": {
            "work_city_id": "0dd1ec95f021",
            "name": "北京",
            "i18n_name": [
                {
                    "locale": "zh_cn",
                    "value": "北京"
                }
            ],
            "status": true
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
40040001invalid param无效参数。请根据接口文档的参数描述,检查并传入正确的参数值后重试。

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理