添加消息通知聯(lián)系人。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 是 | 聯(lián)系人的名稱。 聯(lián)系人的名稱在資源目錄內(nèi)必須唯一。 格式:2~12 個(gè)英文字母或漢字。 | tom |
EmailAddress | string | 是 | 聯(lián)系人的郵箱地址。 添加郵箱地址后,您需要繼續(xù)調(diào)用 SendEmailVerificationForMessageContact 向該郵箱地址發(fā)送驗(yàn)證信息,通過驗(yàn)證后,該聯(lián)系人的郵箱地址才能生效。 | someone***@example.com |
PhoneNumber | string | 否 | 聯(lián)系人的手機(jī)號(hào)碼。 格式: 說明
僅支持填寫 86-<手機(jī)號(hào)碼> 的中國(guó)內(nèi)地手機(jī)號(hào)碼。
添加手機(jī)號(hào)碼后,您需要繼續(xù)調(diào)用 SendPhoneVerificationForMessageContact 向該手機(jī)號(hào)碼發(fā)送驗(yàn)證信息,通過驗(yàn)證后,該聯(lián)系人的手機(jī)號(hào)碼才能生效。 | 86-139****1234 |
Title | string | 是 | 聯(lián)系人的職位。 枚舉值:
| TechnicalDirector |
MessageTypes | array | 是 | 聯(lián)系人接收的消息分類。 | |
string | 是 | 聯(lián)系人接收的消息分類。 枚舉值:
| AccountExpenses |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "2DFCE4C9-04A9-4C83-BB14-FE791275EC53",
"Contact": {
"ContactId": "c-qL4HqKONzOM7****",
"CreateDate": "2023-03-27 17:19:21"
}
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | MissingParameter.Name | You must specify Name. | 參數(shù)Name為必填參數(shù)。 |
400 | InvalidParameter.Name | The Name is invalid. | Name參數(shù)非法,可以包含漢字、英文。 |
400 | InvalidParameter.Name.Length | The Name exceeds the length limit. | Name長(zhǎng)度超限,必須為2~12字符,可以包含漢字、英文。 |
400 | InvalidParameter.Name.AlreadyUsed | The Name already exists. Please change to another name. | 資源目錄中已存在該聯(lián)系人名稱,請(qǐng)更換。 |
400 | MissingParameter.EmailAddress | You must specify EmailAddress. | EmailAddress參數(shù)缺失。 |
400 | InvalidParameter.EmailAddress | The EmailAddress is invalid. | 郵箱格式無效。 |
400 | MissingParameter.PhoneNumber | You must specify PhoneNumber. | PhoneNumber參數(shù)缺失。 |
400 | InvalidParameter.PhoneNumber | The PhoneNumber is invalid. | 手機(jī)號(hào)格式無效。 |
400 | MissingParameter.Title | You must specify Title. | Title參數(shù)缺失。 |
400 | InvalidParameter.Title | The Title is invalid. | 職位參數(shù)無效。 |
400 | MissingParameter.MessageTypes | You must specify MessageTypes. | MessageTypes參數(shù)缺失。 |
400 | InvalidParameter.MessageTypes | The MessageTypes is invalid. | 消息分類參數(shù)無效。 |
400 | LimitExceeded.Contacts | The maximum number of contacts in a resource directory exceeds the limit. | 聯(lián)系人數(shù)量超出最大限額。 |
400 | InvalidParameter.MobileCountryCode | The current site does not support the country code. | 當(dāng)前站點(diǎn)不支持您輸入的國(guó)家碼。 |
400 | InvalidParameter.EmailAddress.Length | The EmailAddress exceeds the length limit. | EmailAddress長(zhǎng)度超限。 |
429 | ConcurrentCallNotSupported | The operation conflicts with other operations. Please try again later. | 當(dāng)前操作與其他操作沖突,請(qǐng)稍后再試。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-07-25 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 看變更集 | ||||||
|