連絡先の情報を照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ContactId |
string |
必須 |
連絡先の ID。 |
c-qL4HqKONzOM7**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返された結果。 |
||
| RequestId |
string |
リクエスト ID。 |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| Contact |
object |
連絡先の情報。 |
|
| ContactId |
string |
連絡先の ID。 |
c-qL4HqKONzOM7**** |
| MessageTypes |
array |
連絡先が受信するメッセージのタイプ。 |
|
|
string |
連絡先が受信するメッセージのタイプ。 |
AccountExpenses |
|
| CreateDate |
string |
連絡先が作成された日時。 |
2023-03-27 17:19:21 |
| Name |
string |
連絡先の名前。 |
tom |
| EmailAddress |
string |
連絡先のメールアドレス。 |
someone***@example.com |
| PhoneNumber |
string |
連絡先の携帯電話番号。 |
86-139****1234 |
| Title |
string |
連絡先の役職。 |
TechnicalDirector |
| Members |
array |
連絡先がバインドされているオブジェクトの ID。 |
|
|
string |
連絡先がバインドされているオブジェクトの ID。 |
fd-ZDNPiT**** |
|
| Status |
string |
連絡先のステータス。 有効な値は次のとおりです:
|
Active |
例
成功レスポンス
JSONJSON
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"Contact": {
"ContactId": "c-qL4HqKONzOM7****",
"MessageTypes": [
"AccountExpenses"
],
"CreateDate": "2023-03-27 17:19:21",
"Name": "tom",
"EmailAddress": "someone***@example.com",
"PhoneNumber": "86-139****1234",
"Title": "TechnicalDirector",
"Members": [
"fd-ZDNPiT****"
],
"Status": "Active"
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter.ContactId | The ContactId is invalid. | |
| 400 | MissingParameter.ContactId | You must specify ContactId. | |
| 404 | EntityNotExists.Contact | This Contact does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。