ニフクラAPI (ESS: ListIdentities)

ListIdentities

処理概要

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

指定するパラメーター

パラメーター	型	説明	必須
IdentityType	string	取得するIDの種類 値: EmailAddress Domain
MaxItems	integer	1ページごとの最大ID数 使用可能文字: 1~100
NextToken	string	ページ分けに使用するトークン

応答フィールド

フィールド (項目)	型	説明
ListIdentitiesResponse	structure	ルート
␣ListIdentitiesResult	structure	結果
␣␣Identities	list	IDのリスト
␣␣␣member	string	ID (ドメインもしくはメールアドレス)
␣␣NextToken	string	改ページに使用するトークン
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
ValidationError		Sender	400	パラメーターが不正です。
InvalidParameterValue		Sender	400	無効な値または範囲外の値を入力パラメーターに指定しています。
MalformedInput		Sender	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.nifcloud.com
Content-type: application/x-www-form-urlencoded
X-Nifty-Date: 20140320T080418Z
Content-Length: 40

Action=ListIdentities&Version=2010-12-01N2014-05-28

  

応答サンプル

    <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>