Skip to content

根据手机号获取用户

适用版本>=v7.0.2509.20250925

接口说明:根据手机号获取用户

标签通讯录

请求说明

字段
请求地址
配置域名+/openapi+/v7/users/by_phones
HTTP 方法
POST
接口描述
根据手机号获取用户
签名方式
KSO-1(配置域名+/openapi不参与签名)
限频策略
权限要求
查询和管理通讯录信息(应用授权) kso.contact.readwrite
查询通讯录信息(应用授权) kso.contact.read

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

请求体(Body)

请求体格式: application/json

没有可用的数据

请求体示例

json
{
  "phones": [
    "string"
  ],
  "status": [
    "string"
  ],
  "with_dept": true
}

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "avatar": "string",
        "ctime": 0,
        "depts": [
          {
            "abs_path": "string",
            "id": "string",
            "name": "string"
          }
        ],
        "email": "string",
        "ex_user_id": "string",
        "id": "string",
        "login_name": "string",
        "phone": "string",
        "role": "string",
        "status": "string",
        "title": "string",
        "user_name": "string"
      }
    ]
  },
  "code": 0,
  "msg": "string"
}