本文へジャンプします。

ニフティクラウド APIリファレンス

クラウド トップ>API>ESS>ListIdentities

ESS:ListIdentities

概要

お客様のアカウントに登録してある送信元ID(メールアドレスおよびドメイン)を返します。IDの検証状況は問いません。

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

要素名 説明 必須 最大値 デフォルト値 備考
IdentityType 取得するIDの種類
有効な値 : EmailAddress | Domain
  文字列  
MaxItems 1ページごとの最大ID数   数値 100  
nextToken ページ分けに使用するトークン   文字列  

レスポンス

要素名 説明 備考
ListIdentitiesResponse ルート  
ListIdentitiesResult 結果  
Identities IDのリスト  
member ID (ドメインもしくはメールアドレス) 文字列  
NextToken 改ページに使用するトークン 文字列  
ResponseMetadata 共通メタ情報  

エラー

エラー種別 HTTPステータスコード 説明
MalformedInput 400 クエリ文字列に構文エラーが含まれています。
InvalidParameterValue 400 無効な値または範囲外の値を入力パラメーターに指定しています。
ValidationError 400 パラメーターが不正です。

サンプル

リクエストサンプル
POST / HTTP/1.1
Authorization: NIFTY4-HMAC-SHA256 Credential=<Credential>/20140320/east-1/email/nifty4_request, SignedHeaders=content-type;host;x-nifty-date, Signature=<Signature>
Host: ess.api.cloud.nifty.com
Content-type: application/x-www-form-urlencoded; charset=utf-8
X-Nifty-Date: 20140320T080418Z
Content-Length: 40

Action=ListIdentities&Version=2010-12-01
レスポンスサンプル
<ListIdentitiesResponse>
 <ListIdentitiesResult>
  <Identities>
    <member>localpart001@example.com</member>
    <member>localpart002@example.com</member>
    <member>localpart003@example.com</member>
    <member>localpart004@example.com</member>
    <member>localpart005@example.com</member>
    <member>example1.com</member>
    <member>example2.com</member>
    <member>example3.com</member>
    <member>example4.com</member>
    <member>example5.com</member>
     : 中略
   </Identities>
   <NextToken>rO0ABXNyAC5jb20ubmlmdHkuY2xvdWQuZXNzLmFwaS5hY3Rpb24ucGFyYW0uTmV4dFRva2VuZDyD RUHljdkCAANJAAxsYXN0SGFzaENvZGVKAAhsYXN0VGltZUwADGlkZW50aXR5VHlwZXQAEkxqYXZh L2xhbmcvU3RyaW5nO3hwazOcmAAAAUTY8UNwcA==</NextToken>
  </ListIdentitiesResult>
  <ResponseMetadata>
   <RequestId>f0a5c871-6014-4e2d-9a9f-45af934d8e19</RequestId>
  </ResponseMetadata>
</ListIdentitiesResponse>

推奨画面サイズ 1024×768 以上