Chime / Client / batch_update_phone_number

batch_update_phone_number#

Chime.Client.batch_update_phone_number(**kwargs)#

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_phone_number(
    UpdatePhoneNumberRequestItems=[
        {
            'PhoneNumberId': 'string',
            'ProductType': 'BusinessCalling'|'VoiceConnector'|'SipMediaApplicationDialIn',
            'CallingName': 'string'
        },
    ]
)
Parameters:

UpdatePhoneNumberRequestItems (list) –

[REQUIRED]

The request containing the phone number IDs and product types or calling names to update.

  • (dict) –

    The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

    • PhoneNumberId (string) – [REQUIRED]

      The phone number ID to update.

    • ProductType (string) –

      The product type to update.

    • CallingName (string) –

      The outbound calling name to update.

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',
            '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 the phone number 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.

        • PhoneNumberId (string) –

          The phone number ID for which the action failed.

        • ErrorCode (string) –

          The error code.

        • ErrorMessage (string) –

          The error message.

Exceptions