All Products
Search
Document Center

Resource Management:GetMessageContact

Last Updated:Dec 18, 2023

Queries the information about a contact.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ContactIdstringYes

The ID of the contact.

c-qL4HqKONzOM7****

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

9B34724D-54B0-4A51-B34D-4512372FE1BE
Contactobject

The information about the contact.

ContactIdstring

The ID of the contact.

c-qL4HqKONzOM7****
MessageTypesarray

The types of messages received by the contact.

string

The type of the message received by the contact.

AccountExpenses
CreateDatestring

The time when the contact was created.

2023-03-27 17:19:21
Namestring

The name of the contact.

tom
EmailAddressstring

The email address of the contact.

someone***@example.com
PhoneNumberstring

The mobile phone number of the contact.

86-139****1234
Titlestring

The job title of the contact.

TechnicalDirector
Membersarray

The IDs of objects to which the contact is bound.

string

The ID of the object to which the contact is bound.

fd-ZDNPiT****
Statusstring

The status of the contact. Valid values:

  • Verifying
  • Active
  • Deleting
Active

Examples

Sample success responses

JSONformat

{
  "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"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.ContactIdThe ContactId is invalid.The value of the ContactId parameter is invalid.
400MissingParameter.ContactIdYou must specify ContactId.The ContactId parameter is not configured.
404EntityNotExists.ContactThis Contact does not exist.The specified contact does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
2023-05-18The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404