> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 社員数を取得

> DingTalk のアクティベーション状況に応じて企業の社員数を取得します

本 API を呼び出して社員数を取得します。

## API 呼び出し説明

本 API は連絡先の権限スコープの制限を受けません。

## リクエスト

| **基本情報**     |                                                                                        |
| ------------ | -------------------------------------------------------------------------------------- |
| HTTP URL     | [https://api.dingtalk.io/topapi/user/count](https://api.dingtalk.io/topapi/user/count) |
| HTTP Method  | POST                                                                                   |
| サポートするアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ                                                     |
| 必要な権限        | permission-qyapi\_get\_member-ユーザー情報の読み取り権限                                            |

### クエリパラメータ

| 名前            | タイプ    | 必須 | 例        | 説明                                                                                                                                                                               |
| ------------- | ------ | -- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| access\_token | String | はい | bE74xxxx | 本 API を呼び出すアプリ認証情報。   - 社内アプリの場合、[社内アプリの access\_token を取得する](/ja/open/development/obtain-orgapp-token) API で取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access\_token を取得する API で取得します。 |

### リクエストボディ

| 名前           | タイプ     | 必須 | 例     | 説明                                                                                                                            |
| ------------ | ------- | -- | ----- | ----------------------------------------------------------------------------------------------------------------------------- |
| only\_active | Boolean | はい | false | DingTalk 未アクティベーションのメンバー数を含むかどうか：   - **false**：DingTalk 未アクティベーションのメンバー数を含みます。 - **true**：DingTalk アクティベーション済みのメンバー数のみを含みます。 |

### リクエスト例

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.dingtalk.io/topapi/user/count" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=7a1bee78-57cb-4a05-9316-0341b1ca303f' \
-d 'only_active=false'
```

Java

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/user/count");
OapiUserCountRequest req = new OapiUserCountRequest();
req.setOnlyActive(false);
OapiUserCountResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import dingtalk.api

req=dingtalk.api.OapiUserCountRequest("https://api.dingtalk.io/topapi/user/count")

req.only_active=false
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
```

PHP

```php theme={"theme":{"light":"github-light","dark":"github-dark"}}
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiUserCountRequest;
$req->setOnlyActive("false");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/user/count");
```

C#

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/user/count");
OapiUserCountRequest req = new OapiUserCountRequest();
req.OnlyActive = false;
OapiUserCountResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

## レスポンス

### レスポンスボディ

| 名前          | タイプ               | 例                  | 説明                            |
| ----------- | ----------------- | ------------------ | ----------------------------- |
| request\_id | String            | o38h5bztjouc       | リクエスト ID。                     |
| errcode     | Number            | 0                  | ステータスコード。0 は呼び出しに成功したことを示します。 |
| errmsg      | String            | 不合法的 access\_token | 呼び出しに失敗した場合に返されるエラーメッセージ。     |
| result      | CountUserResponse |                    | 返却結果。                         |
| count       | Number            | 4                  | 社員数。                          |

### レスポンスボディ例

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "errcode": 0,
    "errmsg":"ok",
    "result": {
        "count": 4
    },
    "request_id": "40k5v0mgbzyh"
}
```

### エラーコード

本 API の呼び出しでエラーが発生した場合は、[グローバルエラーコード](/ja/open/development/server-api-error-codes-1)ドキュメントでエラーメッセージから解決方法を検索してください。

| エラーコード（errcode） | エラーコードの説明（errmsg） | 解決方法                              |
| --------------- | ----------------- | --------------------------------- |
| 400002          | パラメータが空です         | 必須パラメータがすべて入力されているか確認してください       |
| 40035           | 不正なパラメータです        | パラメータが上記ドキュメントの要件に準拠しているか確認してください |
| -1              | システムビジー           | 後で再試行してください                       |