getPersonList 操作を呼び出して、個人グループ内のすべての個人の ID を照会できます。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 20 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。その結果、ビジネスに影響が出る可能性があります。この操作を呼び出すときは、制限に注意することをお勧めします。
リクエスト構文
POST /green/sface/group/persons HTTPS|HTTPリクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | ClientInfo 構造体から JSON 形式でシリアル化されたクライアント情報。この情報には、クライアントの一意識別子（UMID）と国際移動体装置識別番号（IMEI）が含まれます。詳細については、「ClientInfo」をご参照ください。 |
RequestBody
RequestBody に次のパラメーターも指定して、照会する個人グループの情報を指定する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
groupId | String | はい | group1 | 照会する個人グループの ID。 |
currentPage | Integer | いいえ | 1 | 返す現在のページ番号（ 1 から開始）。デフォルト値： 1 。 |
pageSize | Integer | いいえ | 20 | 各ページに返すエントリの数。デフォルト値： 20 。有効な値： 1 ～ 100 。 |
レスポンスパラメーター
JSON 形式のデータがすべてのリクエストに対して返されます。共通のレスポンスパラメーターの詳細については、「共通レスポンスパラメーター」をご参照ください。レスポンスの data パラメーターは、ビジネス関連のデータを返すために使用されます。一般に、このパラメーターの値は JSON 構造体または配列です。
エラーが発生した場合、data パラメーターは空になる場合があります。
次の表は、data フィールドで返されるパラメーターについて説明しています。
パラメーター | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「共通エラーコード」をご参照ください。 |
personIds | StringArray | ["person1","person2"] | 個人グループ内のすべての個人 ID のリスト。 |
currentPage | Integer | 1 | 返された現在のページ番号。 |
pageSize | Integer | 20 | 各ページに返されるエントリの数。 |
totalCount | Integer | 100 | 個人の総数。 |
例
リクエストの例
POST /green/sface/group/persons HTTP/1.1
Common request headers
{
"groupId": "group1",
"pageSize": 10,
"currentPage": 1
}成功レスポンスの例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personIds": [
"person1",
"person2"
],
"pageSize": 10,
"currentPage": 1,
"totalCount": 17
}
}