EndUserMessagingSocial / Client / get_linked_whatsapp_business_account_phone_number

get_linked_whatsapp_business_account_phone_number

EndUserMessagingSocial.Client.get_linked_whatsapp_business_account_phone_number(**kwargs)

Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.

See also: AWS API Documentation

Request Syntax

response = client.get_linked_whatsapp_business_account_phone_number(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The unique identifier of the phone number. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

Return type:

dict

Returns:

Response Syntax

{
    'phoneNumber': {
        'arn': 'string',
        'phoneNumber': 'string',
        'phoneNumberId': 'string',
        'metaPhoneNumberId': 'string',
        'displayPhoneNumberName': 'string',
        'displayPhoneNumber': 'string',
        'qualityRating': 'string',
        'dataLocalizationRegion': 'string'
    },
    'linkedWhatsAppBusinessAccountId': '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'
    }
}

Response Structure

• (dict) –

  • phoneNumber (dict) –

    The details of your WhatsApp phone number.

    • arn (string) –

      The ARN of the WhatsApp phone number.

    • phoneNumber (string) –

      The phone number for sending WhatsApp.

    • phoneNumberId (string) –

      The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.

    • metaPhoneNumberId (string) –

      The phone number ID from Meta.

    • displayPhoneNumberName (string) –

      The display name for this phone number.

    • displayPhoneNumber (string) –

      The phone number that appears in the recipients display.

    • qualityRating (string) –

      The quality rating of the phone number.

    • dataLocalizationRegion (string) –

      The geographic region where the WhatsApp phone number’s data is stored and processed.

  • linkedWhatsAppBusinessAccountId (string) –

    The WABA identifier linked to the phone number, formatted as waba-01234567890123456789012345678901.

  • callSettings (dict) –

    The calling settings configured for the phone number. This value is absent when calling is not configured.

    • callEnabled (boolean) –

      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) –

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

      • timezone (string) –

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

      • weeklyOperatingHours (list) –

        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) –

            The day of the week that the entry applies to.

          • openTime (dict) –

            The time of day when the business begins accepting calls.

            • hours (integer) –

              The hour of the day, from 0 to 23.

            • minutes (integer) –

              The minute of the hour, from 0 to 59.

          • closeTime (dict) –

            The time of day when the business stops accepting calls.

            • hours (integer) –

              The hour of the day, from 0 to 23.

            • minutes (integer) –

              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) –

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

          • startTime (dict) –

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

            • hours (integer) –

              The hour of the day, from 0 to 23.

            • minutes (integer) –

              The minute of the hour, from 0 to 59.

          • endTime (dict) –

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

            • hours (integer) –

              The hour of the day, from 0 to 23.

            • minutes (integer) –

              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.

Exceptions

• EndUserMessagingSocial.Client.exceptions.ValidationException

• EndUserMessagingSocial.Client.exceptions.AccessDeniedException

• EndUserMessagingSocial.Client.exceptions.InvalidParametersException

• EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException

• EndUserMessagingSocial.Client.exceptions.ThrottledRequestException

• EndUserMessagingSocial.Client.exceptions.InternalServiceException

• EndUserMessagingSocial.Client.exceptions.DependencyException