AddMessageContact - 添加联系人

添加消息通知联系人。

调试

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

授权信息

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

请求参数

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

联系人的名称。

联系人的名称在资源目录内必须唯一。

格式:2~12 个英文字母或汉字。

tom
EmailAddressstring

联系人的邮箱地址。

添加邮箱地址后,您需要继续调用 SendEmailVerificationForMessageContact 向该邮箱地址发送验证信息,通过验证后,该联系人的邮箱地址才能生效。

someone***@example.com
PhoneNumberstring

联系人的手机号码。

格式:<国家码>-<手机号码>

说明 仅支持填写86-<手机号码>的中国内地手机号码。

添加手机号码后,您需要继续调用 SendPhoneVerificationForMessageContact 向该手机号码发送验证信息,通过验证后,该联系人的手机号码才能生效。

86-139****1234
Titlestring

联系人的职位。

枚举值:
  • FinanceDirector财务负责人
  • TechnicalDirector技术负责人
  • MaintenanceDirector运维负责人
  • CEOCEO
  • ProjectDirector项目负责人
  • Other其它
TechnicalDirector
MessageTypesarray

联系人接收的消息分类。

string

联系人接收的消息分类。

枚举值:
  • ServiceMessage服务消息
  • FaultMessage故障消息
  • AccountExpenses账号资金消息
  • SecurityMessage安全消息
  • ActivityMessage活动消息
  • ProductMessage产品消息
AccountExpenses

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

2DFCE4C9-04A9-4C83-BB14-FE791275EC53
Contactobject

联系人信息。

ContactIdstring

联系人 ID。

c-qL4HqKONzOM7****
CreateDatestring

联系人创建时间。

2023-03-27 17:19:21

示例

正常返回示例

JSON格式

{
  "RequestId": "2DFCE4C9-04A9-4C83-BB14-FE791275EC53",
  "Contact": {
    "ContactId": "c-qL4HqKONzOM7****",
    "CreateDate": "2023-03-27 17:19:21"
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter.NameYou must specify Name.参数Name为必填参数。
400InvalidParameter.NameThe Name is invalid.Name参数非法,可以包含汉字、英文。
400InvalidParameter.Name.LengthThe Name exceeds the length limit.Name长度超限,必须为2~12字符,可以包含汉字、英文。
400InvalidParameter.Name.AlreadyUsedThe Name already exists. Please change to another name.资源目录中已存在该联系人名称,请更换。
400MissingParameter.EmailAddressYou must specify EmailAddress.EmailAddress参数缺失。
400InvalidParameter.EmailAddressThe EmailAddress is invalid.邮箱格式无效。
400MissingParameter.PhoneNumberYou must specify PhoneNumber.PhoneNumber参数缺失。
400InvalidParameter.PhoneNumberThe PhoneNumber is invalid.手机号格式无效。
400MissingParameter.TitleYou must specify Title.Title参数缺失。
400InvalidParameter.TitleThe Title is invalid.职位参数无效。
400MissingParameter.MessageTypesYou must specify MessageTypes.MessageTypes参数缺失。
400InvalidParameter.MessageTypesThe MessageTypes is invalid.消息分类参数无效。
400LimitExceeded.ContactsThe maximum number of contacts in a resource directory exceeds the limit.联系人数量超出最大限额。
400InvalidParameter.MobileCountryCodeThe current site does not support the country code.当前站点不支持您输入的国家码。
400InvalidParameter.EmailAddress.LengthThe EmailAddress exceeds the length limit.EmailAddress长度超限。
429ConcurrentCallNotSupportedThe operation conflicts with other operations. Please try again later.当前操作与其他操作冲突,请稍后再试。

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

变更历史

变更时间变更内容概要操作
2023-07-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:429