调用UpdateContacts接口对指定联系人进行全量更新,即更新联系人的全部属性,包括名称、手机和邮箱。
请求说明
- 请求方式:POST
- 请求地址:https://open.volcengineapi.com?Action=UpdateContacts&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing
AccessKey : xxx
SecretKey : xxx
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
去调试请求参数
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | UpdateContacts | 接口名称。当前 API 的名称为 UpdateContacts 。 |
Version | String | 是 | 2018-01-01 | 接口版本。当前 API 的版本为 2018-01-01 。 |
Body
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Id | String | 是 | 1452*****7244 | 联系人ID。 |
Name | String | 是 | name1 | 联系人的新名称。 |
Phone | String | 否 | 1234567**** | 联系人的新手机号。若不填,则默认清空本参数原有值。 |
Email | String | 是 | name1.account@xxx.com | 联系人的新邮箱地址。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
---|
Data | Array of String | ["1452*****7244"] | 联系人ID。 |
请求示例
POST https://open.volcengineapi.com?Action=UpdateContacts&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
"Name":"name1",
"Email":"name1.account@xxx.com",
"Phone":"",
"Id":"1452*****7244"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2022092215001701017423503808******",
"Action": "UpdateContacts",
"Version": "2018-01-01",
"Service": "Volc_Observe",
"Region": ""
},
"Result": {
"Data": [
"1452*****7244"
]
}
}
错误码
本接口无特有的错误码。更多信息请参见错误码。