查詢連絡人清單。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ContactId |
string |
否 |
連絡人 ID。 |
c-qL4HqKONzOM7**** |
| Member |
string |
否 |
繫結目標 ID。取值：
|
fd-ZDNPiT**** |
| PageNumber |
integer |
否 |
頁碼。 |
1 |
| PageSize |
integer |
否 |
分頁時每頁顯示的資料條數。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
95060F1D-6990-4645-8920-A81D1BBFE992 |
| TotalCount |
integer |
資料總條數。 |
20 |
| PageSize |
integer |
分頁時每頁顯示的資料條數。 |
10 |
| PageNumber |
integer |
頁碼。 |
1 |
| Contacts |
array<object> |
訊息連絡人清單。 |
|
|
object |
訊息連絡人清單。 |
||
| 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 |
繫結目標。 |
|
|
string |
繫結目標。 |
fd-ZDNPiT**** |
|
| Status |
string |
連絡人狀態。取值：
|
Active |
| CreateDate |
string |
新增連絡人...的時間。 |
2023-03-27 17:19:21 |
| AssociatedDate |
string |
綁定連絡人的時間。 |
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 |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。