Adds a contact.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
Yes |
The name of the contact. The name must be unique in your resource directory. The name must be 2 to 12 characters in length and can contain only letters. |
tom |
| EmailAddress |
string |
Yes |
The email address of the contact. After you specify an email address, you need to call SendEmailVerificationForMessageContact to send verification information to the email address. After the verification is passed, the email address takes effect. |
someone***@example.com |
| PhoneNumber |
string |
No |
The mobile phone number of the contact. Specify the mobile phone number in the Note
Only mobile phone numbers in the After you specify a mobile phone number, you need to call SendPhoneVerificationForMessageContact to send verification information to the mobile phone number. After the verification is passed, the mobile phone number takes effect. |
86-139****1234 |
| Title |
string |
Yes |
The job title of the contact. Valid values:
Valid values:
|
TechnicalDirector |
| MessageTypes |
array |
Yes |
The types of messages received by the contact. |
|
|
string |
No |
The type of the message received by the contact. Valid values:
Valid values:
|
AccountExpenses |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned result. |
||
| RequestId |
string |
The request ID. |
2DFCE4C9-04A9-4C83-BB14-FE791275EC53 |
| Contact |
object |
The information about the contact. |
|
| ContactId |
string |
The ID of the contact. |
c-qL4HqKONzOM7**** |
| CreateDate |
string |
The time when the contact was created. |
2023-03-27 17:19:21 |
Examples
Success response
JSON format
{
"RequestId": "2DFCE4C9-04A9-4C83-BB14-FE791275EC53",
"Contact": {
"ContactId": "c-qL4HqKONzOM7****",
"CreateDate": "2023-03-27 17:19:21"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | MissingParameter.Name | You must specify Name. | |
| 400 | InvalidParameter.Name | The Name is invalid. | |
| 400 | InvalidParameter.Name.Length | The Name exceeds the length limit. | |
| 400 | InvalidParameter.Name.AlreadyUsed | The Name already exists. Please change to another name. | |
| 400 | MissingParameter.EmailAddress | You must specify EmailAddress. | |
| 400 | InvalidParameter.EmailAddress | The EmailAddress is invalid. | |
| 400 | MissingParameter.PhoneNumber | You must specify PhoneNumber. | |
| 400 | InvalidParameter.PhoneNumber | The PhoneNumber is invalid. | |
| 400 | MissingParameter.Title | You must specify Title. | |
| 400 | InvalidParameter.Title | The Title is invalid. | |
| 400 | MissingParameter.MessageTypes | You must specify MessageTypes. | |
| 400 | InvalidParameter.MessageTypes | The MessageTypes is invalid. | |
| 400 | LimitExceeded.Contacts | The maximum number of contacts in a resource directory exceeds the limit. | |
| 400 | InvalidParameter.MobileCountryCode | The current site does not support the country code. | |
| 400 | InvalidParameter.EmailAddress.Length | The EmailAddress exceeds the length limit. | |
| 429 | ConcurrentCallNotSupported | The operation conflicts with other operations. Please try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.