All Products
Search
Document Center

Resource Management:ListMessageContacts

Last Updated:Jun 25, 2024

Queries contacts.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ContactIdstringNo

The ID of the contact.

c-qL4HqKONzOM7****
MemberstringNo

The ID of the object to which the contact is bound. Valid values:

  • ID of the resource directory
  • ID of the folder
  • ID of the member
fd-ZDNPiT****
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

95060F1D-6990-4645-8920-A81D1BBFE992
TotalCountinteger

The total number of entries returned.

20
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
Contactsobject []

The time when the contact was bound to the objects.

ContactIdstring

The ID of the contact.

c-qL4HqKONzOM7****
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
MessageTypesarray

The types of messages received by the contact.

string

The type of the message received by the contact.

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

The time when the contact was added.

2023-03-27 17:19:21
AssociatedDatestring

The time when the contact was bound to the objects.

2023-03-27 17:19:21

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.ContactIdThe ContactId is invalid.The value of the ContactId parameter is invalid.
400InvalidParameter.MemberThe Member is invalid.The value of the Member parameter is invalid.
404EntityNotExists.ContactThis Contact does not exist.The specified contact does not exist.
404EntityNotExists.MemberThis Member does not exist.The specified member does not exist.

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

Change history

Change timeSummary of changesOperation
No change history