メンバーリストの照会

Classic/VPC環境で利用できます。

メンバーリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/ncloudmcc/v1/companies/{companyId}/users

リクエストヘッダ

Media Connect Center APIで共通して使用されるヘッダの詳細は、Media Connect Centerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`companyId`	String	Required	連携キーコンソールで確認: Media Connect Center > Developers > 基本設定 > 連携キー

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`limit`	Number	Optional	照会データの最大項目数デフォルト: 10
`offset`	Number	Optional	照会データのスタート位置デフォルト: 0

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/users?limit=3&offset=0' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`page`	Object	-	ページ情報
`page.count`	Number	-	レスポンス結果数
`page.offset`	Number	-	照会データのスタート位置
`page.limit`	Number	-	照会データの最大項目数
`page.total`	Number	-	レスポンス総数
`users`	Array	-	メンバーリスト: users

`users`

usersの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`deptExternalKey`	String	-	部署の外部キー(External Key)
`name`	String	-	メンバーの氏名
`i18nNames`	Object	-	メンバーの多言語名
`i18nNames.{locale}`	String	-	言語ごとのメンバー名 `"言語コード": "値"`形式韓国語、英語、日本語のうち登録された値を表示
`emailAddr`	String	-	メールアドレス(ログイン ID)
`telNo`	String	-	電話番号 `{ISO 3166-1国コード}+{E.164国番号} {電話番号}`形式
`cphNo`	String	-	携帯電話番号 `{ISO 3166-1国コード}+{E.164国番号} {電話番号}`形式
`localeTypeCd`	String	-	ロケールコード
`tmznTypeCd`	String	-	タイムゾーンコード
`jobPositionExternalKey`	String	-	職責の外部キー(External Key)
`jobGradeExternalKey`	String	-	役職の外部キー(External Key)
`externalKey`	String	-	メンバーの外部キー(External Key)

レスポンスステータスコード

Media Connect Center APIで共通して使用されるレスポンスステータスコードの詳細は、Media Connect Centerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "page": {
        "count": 3,
        "offset": 0,
        "limit": 3,
        "total": 4
    },
    "users": [
        {
            "deptExternalKey": "hg-tw",
            "name": "ナサジャン",
            "i18nNames": {
                "ko_KR": "나사장",
                "en_US": "Na Sajang"
            },
            "emailAddr": "iamsajang@ncloud.com",
            "telNo": "KR+82 021231212",
            "cphNo": "KR+82 01098765432",
            "localeTypeCd": "ko_KR",
            "tmznTypeCd": "Asia/Seoul",
            "jobPositionExternalKey": "hg-pstn-1",
            "jobGradeExternalKey": "hg-grade-1",
            "externalKey": "hg-user003"
        },
        {
            "deptExternalKey": "hg-tw-cd",
            "name": "フェサウォン",
            "i18nNames": {
                "ko_KR": "회사원",
                "en_US": "Hoi Sawon"
            },
            "emailAddr": "sawon@ncloud.com",
            "telNo": "KR+82 021239876",
            "cphNo": "KR+82 01012349999",
            "localeTypeCd": "ko_KR",
            "tmznTypeCd": "Asia/Seoul",
            "jobPositionExternalKey": "hg-pstn-6",
            "jobGradeExternalKey": "hg-grade-6",
            "externalKey": "hg-user002"
        },
        {
            "deptExternalKey": "hg-tw-cd",
            "name": "ホンギルドン",
            "i18nNames": {
                "ko_KR": "홍길동",
                "en_US": "Hong Gildong"
            },
            "emailAddr": "gdong@ncloud.com",
            "telNo": "KR+82 0213572468",
            "cphNo": "KR+82 01012345678",
            "localeTypeCd": "ko_KR",
            "tmznTypeCd": "Asia/Seoul",
            "jobPositionExternalKey": "hg-pstn-6",
            "jobGradeExternalKey": "hg-grade-6",
            "externalKey": "hg-user001"
        }
    ]
}