文档

ListMessageContacts - 查询联系人列表

更新时间:

查询联系人列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ContactIdstring

联系人 ID。

c-qL4HqKONzOM7****
Memberstring

绑定目标 ID。取值:

  • 资源目录 ID。
  • 资源夹 ID。
  • 成员 ID。
fd-ZDNPiT****
PageNumberinteger

页码。

1
PageSizeinteger

分页时每页显示的数据条数。

10

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

95060F1D-6990-4645-8920-A81D1BBFE992
TotalCountinteger

数据总条数。

20
PageSizeinteger

分页时每页显示的数据条数。

10
PageNumberinteger

页码。

1
Contactsobject []

消息联系人列表。

ContactIdstring

联系人 ID。

c-qL4HqKONzOM7****
Namestring

联系人的名称。

tom
EmailAddressstring

联系人的邮箱地址。

someone***@example.com
PhoneNumberstring

联系人的手机号码。

86-139****1234
Titlestring

联系人的职位。

TechnicalDirector
MessageTypesarray

联系人接收的消息分类。

string

联系人接收的消息分类。

AccountExpenses
Membersarray

绑定目标。

string

绑定目标。

fd-ZDNPiT****
Statusstring

联系人状态。取值:

  • Verifying:待验证。
  • Active:生效。
  • Deleting:删除中。
Active
CreateDatestring

添加联系人的时间。

2023-03-27 17:19:21
AssociatedDatestring

绑定联系人的时间。

2023-03-27 17:19:21

示例

正常返回示例

JSON格式

{
  "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 status code错误码错误信息描述
400InvalidParameter.ContactIdThe ContactId is invalid.ContactId无效。
400InvalidParameter.MemberThe Member is invalid.Member参数无效。
404EntityNotExists.ContactThis Contact does not exist.Contact不存在。
404EntityNotExists.MemberThis Member does not exist.成员对象不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史