AddContacts - Chat App Message Service - Alibaba Cloud Documentation Center

Edits a contact - add contact.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:AddContacts

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ContactName	string	No	The name of the contact.	mary
ContactDetails	string	No	The description of the contact.	15111111111
Country	string	No	The country.	China
NeedUpdate	boolean	Yes	Indicates whether the back-to-origin IP address whitelist needs to be updated. This parameter returns true when the current back-to-origin IP address whitelist differs from the latest back-to-origin IP address whitelist. true: The whitelist needs to be updated. false: The whitelist does not need to be updated.	true
Groups	string	Yes	The user group information.	示例值示例值
FilePath	string	No	The file path.	示例值示例值示例值
		No	The business code.
		No	The business extension information. Default value: an empty collection.
		No	The email address.
		No	The remarks.

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	示例值示例值
RequestId	string	The request ID.	示例值示例值示例值
Data	string	The returned data.	true
Code	string	The status code.	示例值
Success	boolean	Indicates whether the call was successful. true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "示例值示例值",
  "RequestId": "示例值示例值示例值",
  "Data": "true",
  "Code": "示例值",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.