Chime / Client / get_user_settings

get_user_settings#

Chime.Client.get_user_settings(**kwargs)#

Retrieves settings for the specified user ID, such as any associated phone number settings.

See also: AWS API Documentation

Request Syntax

response = client.get_user_settings(
    AccountId='string',
    UserId='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) –

    [REQUIRED]

    The user ID.

Return type:

dict

Returns:

Response Syntax

{
    'UserSettings': {
        'Telephony': {
            'InboundCalling': True|False,
            'OutboundCalling': True|False,
            'SMS': True|False
        }
    }
}

Response Structure

  • (dict) –

    • UserSettings (dict) –

      The user settings.

      • Telephony (dict) –

        The telephony settings associated with the user.

        • InboundCalling (boolean) –

          Allows or denies inbound calling.

        • OutboundCalling (boolean) –

          Allows or denies outbound calling.

        • SMS (boolean) –

          Allows or denies SMS messaging.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException