ListMessageContacts を使用してメッセージ連絡先をクエリする - Resource Management

連絡先を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ContactId	string	任意	連絡先の ID。	c-qL4HqKONzOM7****
Member	string	任意	連絡先がバインドされているオブジェクトの ID。有効な値：リソースディレクトリの ID フォルダの ID メンバーの ID	fd-ZDNPiT****
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりのエントリ数。	10

レスポンスフィールド

フィールド	型	説明	例
	object	戻り値。
RequestId	string	リクエスト ID。	95060F1D-6990-4645-8920-A81D1BBFE992
TotalCount	integer	返されたエントリの総数。	20
PageSize	integer	1 ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
Contacts	array<object>	連絡先がオブジェクトに関連付けられた時間。
	object	連絡先がバインドされているオブジェクトの ID です。
ContactId	string	連絡先の ID。	c-qL4HqKONzOM7****
Name	string	連絡先の名前。	tom
EmailAddress	string	連絡先のメールアドレス。	someone***@example.com
PhoneNumber	string	連絡先の携帯電話番号。	86-139****1234
Title	string	連絡先の役職。	TechnicalDirector
MessageTypes	array	連絡先が受信するメッセージのタイプ。
	string	連絡先が受信するメッセージのタイプ。	AccountExpenses
Members	array	連絡先がバインドされているオブジェクトの ID。
	string	連絡先がバインドされているオブジェクトの ID。	fd-ZDNPiT****
Status	string	連絡先のステータス。有効な値： Verifying Active Deleting	Active
CreateDate	string	連絡先が追加された日時。	2023-03-27 17:19:21
AssociatedDate	string	連絡先がオブジェクトにバインドされた日時。	2023-03-27 17:19:21

例

成功レスポンス

JSONJSON

{
  "RequestId": "95060F1D-6990-4645-8920-A81D1BBFE992",
  "TotalCount": 20,
  "PageSize": 10,
  "PageNumber": 1,
  "Contacts": [
    {
      "ContactId": "c-qL4HqKONzOM7****",
      "Name": "tom",
      "EmailAddress": "someone***@example.com",
      "PhoneNumber": "86-139****1234",
      "Title": "TechnicalDirector",
      "MessageTypes": [
        "AccountExpenses"
      ],
      "Members": [
        "fd-ZDNPiT****"
      ],
      "Status": "Active",
      "CreateDate": "2023-03-27 17:19:21",
      "AssociatedDate": "2023-03-27 17:19:21"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.ContactId	The ContactId is invalid.
400	InvalidParameter.Member	The Member is invalid.
404	EntityNotExists.Contact	This Contact does not exist.
404	EntityNotExists.Member	This Member does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。