EndUserMessagingSocial / Client / update_linked_whatsapp_business_account_phone_number

update_linked_whatsapp_business_account_phone_number

EndUserMessagingSocial.Client.update_linked_whatsapp_business_account_phone_number(**kwargs)

Updates the calling settings for a linked WhatsApp business phone number, such as whether calling is enabled and the hours during which the business accepts calls.

See also: AWS API Documentation

Request Syntax

response = client.update_linked_whatsapp_business_account_phone_number(
    id='string',
    callSettings={
        'callEnabled': True|False,
        'callHours': {
            'enabled': True|False,
            'timezone': 'string',
            'weeklyOperatingHours': [
                {
                    'dayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
                    'openTime': {
                        'hours': 123,
                        'minutes': 123
                    },
                    'closeTime': {
                        'hours': 123,
                        'minutes': 123
                    }
                },
            ],
            'holidaySchedule': [
                {
                    'date': 'string',
                    'startTime': {
                        'hours': 123,
                        'minutes': 123
                    },
                    'endTime': {
                        'hours': 123,
                        'minutes': 123
                    }
                },
            ]
        },
        'callIconVisibility': 'string',
        'callbackPermissionStatus': 'string'
    }
)
Parameters:

  • id (string) –

    [REQUIRED]

    The unique identifier of the phone number to update. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.

  • callSettings (dict) –

    [REQUIRED]

    The calling settings to apply to the phone number.

    • callEnabled (boolean) – [REQUIRED]

      Specifies whether calling is enabled for the phone number.

    • callHours (dict) –

      The hours during which the business accepts calls on the phone number.

      • enabled (boolean) – [REQUIRED]

        Specifies whether call hours are enforced. When disabled, the business accepts calls at any time.

      • timezone (string) – [REQUIRED]

        The IANA time zone in which the operating hours are interpreted, such as America/New_York.

      • weeklyOperatingHours (list) – [REQUIRED]

        The weekly schedule of hours during which the business accepts calls.

        • (dict) –

          A single entry in a weekly calling schedule, defining the open and close times for one day of the week.

          • dayOfWeek (string) – [REQUIRED]

            The day of the week that the entry applies to.

          • openTime (dict) – [REQUIRED]

            The time of day when the business begins accepting calls.

            • hours (integer) – [REQUIRED]

              The hour of the day, from 0 to 23.

            • minutes (integer) – [REQUIRED]

              The minute of the hour, from 0 to 59.

          • closeTime (dict) – [REQUIRED]

            The time of day when the business stops accepting calls.

            • hours (integer) – [REQUIRED]

              The hour of the day, from 0 to 23.

            • minutes (integer) – [REQUIRED]

              The minute of the hour, from 0 to 59.

      • holidaySchedule (list) –

        Date-specific overrides to the weekly operating hours, such as holidays.

        • (dict) –

          A date-specific override to the weekly operating hours, such as a holiday.

          • date (string) – [REQUIRED]

            The date that the override applies to, in ISO 8601 format ( YYYY-MM-DD).

          • startTime (dict) – [REQUIRED]

            The time of day when the business begins accepting calls on the override date.

            • hours (integer) – [REQUIRED]

              The hour of the day, from 0 to 23.

            • minutes (integer) – [REQUIRED]

              The minute of the hour, from 0 to 59.

          • endTime (dict) – [REQUIRED]

            The time of day when the business stops accepting calls on the override date.

            • hours (integer) – [REQUIRED]

              The hour of the day, from 0 to 23.

            • minutes (integer) – [REQUIRED]

              The minute of the hour, from 0 to 59.

    • callIconVisibility (string) –

      The visibility setting for the call icon shown to end users in WhatsApp.

    • callbackPermissionStatus (string) –

      The callback permission status for the phone number.

Return type:

dict

Returns:

Response Syntax

{
    'phoneNumberId': 'string'
}

Response Structure

  • (dict) –

    • phoneNumberId (string) –

      The unique identifier of the phone number that was updated.

Exceptions