Updates the phone configuration settings for the specified user.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-user-phone-config
--phone-config <value>
--user-id <value>
--instance-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--phone-config
(structure)
Information about phone configuration settings for the user.
PhoneType -> (string)
The phone type.
AutoAccept -> (boolean)
The Auto accept setting.
AfterContactWorkTimeLimit -> (integer)
The After Call Work (ACW) timeout setting, in seconds.
DeskPhoneNumber -> (string)
The phone number for the user’s desk phone.
Shorthand Syntax:
PhoneType=string,AutoAccept=boolean,AfterContactWorkTimeLimit=integer,DeskPhoneNumber=string
JSON Syntax:
{
"PhoneType": "SOFT_PHONE"|"DESK_PHONE",
"AutoAccept": true|false,
"AfterContactWorkTimeLimit": integer,
"DeskPhoneNumber": "string"
}
--user-id
(string)
The identifier of the user account.
--instance-id
(string)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To update a user’s phone configuration
The following update-user-phone-config
example updates the phone configuration for the specified user.
aws connect update-user-phone-config \
--phone-config PhoneType=SOFT_PHONE,AutoAccept=false,AfterContactWorkTimeLimit=60,DeskPhoneNumber=+18005551212 \
--user-id 12345678-4444-3333-2222-111122223333 \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
This command produces no output.
For more information, see Configure Agent Settings in the Amazon Connect Administrator Guide.
None