獲取聯系人列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-cert:ListContact | list |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Keyword | string | 否 | 搜索關鍵詞。例如姓名、郵箱和電話中的關鍵字。 | 186 |
ShowSize | integer | 否 | 分頁查詢時,設置每頁顯示聯系人的個數。 | 20 |
CurrentPage | integer | 否 | 分頁,當前頁,默認 1。 | 1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "31C66C7B-671A-4297-9187-2C4477247A74",
"TotalCount": 12,
"ShowSize": 20,
"CurrentPage": 1,
"Keyword": "186",
"ContactList": [
{
"ContactId": 519580,
"Name": "張三",
"Mobile": "139****8888",
"MobileStatus": 1,
"Email": "username@example.com",
"EmailStatus": 1,
"Webhooks": "[\\\"https://open.feishu.cn/open-apis/bot/v2/hook/XXX\\\",\\\"https://oapi.dingtalk.com/robot/send?access_token=XXX\\\",\\\"https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX\\\"]"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。