リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/v2/user/getbymobile |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ |
| 権限要件 | permission-qyapi_get_member_by_mobile-携帯電話番号でユーザーの基本情報を取得する権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | be3Fxxxx | 当該インターフェースを呼び出すためのアプリ認証情報。社内アプリの access_token を取得するインターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| mobile | String | はい | 185xxxxx676 | ユーザーの携帯電話番号。 |
| support_exclusive_account_search | Boolean | はい | true | 携帯電話番号による企業アカウント検索をサポートするかどうか。 - true:サポートします。 - fasle:サポートしません。 説明 - 企業アカウントのみ適用されます。 - 現在の企業で作成された企業アカウントのみ検索可能です。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/v2/user/getbymobile" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a16xxxxa2efbee' \
-d 'mobile=1851xxxx676' \
-d 'support_exclusive_account_search=true'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/getbymobile");
OapiV2UserGetbymobileRequest req = new OapiV2UserGetbymobileRequest();
req.setMobile("185xxxx");
OapiV2UserGetbymobileResponse rsp = client.execute(req, acces_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiV2UserGetbymobileRequest("https://api.dingtalk.io/topapi/v2/user/getbymobile")
req.mobile="13800138000"
req.support_exclusive_account_search=true
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2UserGetbymobileRequest;
$req->setMobile("13800138000");
$req->setSupportExclusiveAccountSearch("true");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/user/getbymobile");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/getbymobile");
OapiV2UserGetbymobileRequest req = new OapiV2UserGetbymobileRequest();
req.Mobile = "1851xxxx76";
req.SupportExclusiveAccountSearch = true;
OapiV2UserGetbymobileResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| request_id | String | 5w82ciuur781 | リクエスト ID。 |
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | ok | リターンコードの説明。 |
| result | Object | 戻り結果。 | |
| userid | String | zhangsan | 社員の userId。 |
| exclusive_account_userid_list | String[] | [“zxxxx”,“lixxxi”] | 企業アカウント社員の userId リスト。 説明 現在の組織で作成された企業アカウントのみ返されます。 |
レスポンスボディ例
{
"errcode":"0",
"result":{
"exclusive_account_userid_list":"[\"zxxxx\",\"lixxxi\"]",
"userid":"zhangsan"
},
"errmsg":"ok"
}
エラーコード
当該インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決策 |
|---|---|---|
| 400002 | 無効なパラメータ | 上記ドキュメントの要件に従ってパラメータが入力されているかご確認ください |
| 40104 | 企業内で無効な携帯電話番号 | 携帯電話番号が正しいかご確認ください |
| 60121 | 該当ユーザーが見つかりません | 入力情報が正しいかご確認ください |
| -1 | システムが混雑しています | 後で再度お試しください |