ChimeSDKVoice / Client / disassociate_phone_numbers_from_voice_connector_group

disassociate_phone_numbers_from_voice_connector_group#

ChimeSDKVoice.Client.disassociate_phone_numbers_from_voice_connector_group(**kwargs)#

Disassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_phone_numbers_from_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ]
)
Parameters:
  • VoiceConnectorGroupId (string) –

    [REQUIRED]

    The Voice Connector group ID.

  • E164PhoneNumbers (list) –

    [REQUIRED]

    The list of phone numbers, in E.164 format.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • PhoneNumberErrors (list) –

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) –

        If a phone number action fails for one or more of the phone numbers in a request, a list of the failed phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) –

          The phone number ID for which the action failed.

        • ErrorCode (string) –

          The error code.

        • ErrorMessage (string) –

          The error message.

Exceptions

  • ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

  • ChimeSDKVoice.Client.exceptions.NotFoundException

  • ChimeSDKVoice.Client.exceptions.ForbiddenException

  • ChimeSDKVoice.Client.exceptions.BadRequestException

  • ChimeSDKVoice.Client.exceptions.ThrottledClientException

  • ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

  • ChimeSDKVoice.Client.exceptions.ServiceFailureException