获取企业信息
用于获取指定企业的基础信息。
请求说明
请求地址 | https://openapi.wps.cn/plus/v1/company |
---|---|
请求方法 | GET |
签名方式 | wps-3 |
支持应用类型 | 企业自建应用、第三方企业应用 |
权限要求 | 访问通讯录(corp_contacts.read) |
请求头
Header名称 | 是否必填 | 说明 |
---|---|---|
Content-Type | 是 | 目前固定为:"application/json" |
Content-Md5 | 是 | 当HTTP请求的Body有数据时,计算Body的MD5值,否则计算空字符串的MD5值。再将MD5值转为十六进制字符串形式。即:Format("%x", md5Byte) |
Date | 是 | RFC1123格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Auth | 是 | X-Auth计算方法参考签名说明 |
查询参数(Query)
名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|
company_token | string | 是 | 企业授权凭证 |
status | string | 否 | 企业状态。多个状态用“,”分割。可选值: active:正常 disable:禁用 deleted:删除 默认为 active。 |
请求地址示例
[GET] https://openapi.wps.cn/plus/v1/company?company_token=COMPANY_TOKEN
响应体
名称 | 类型 | 说明 |
---|---|---|
result | integer | 状态码,非 0 表示失败,参照《状态码说明》 |
company | object | 企业信息 |
∟ company_id | string | 企业 id |
∟ name | string | 企业名 |
∟ logo | string | 企业 logo 地址 |
∟ ctime | integer | 企业创建时间,秒为单位的时间戳 |
∟ status | string | 企业状态。多个状态用“,”分割。可选值: active:正常 disable:禁用 deleted:删除 |
响应体示例
{
"company": {
"company_id": "COMPANTID",
"name": "NAME",
"logo": "LOGO",
"ctime": 0,
"status": "STATUS"
},
"result": 0
}