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)#
Use your WhatsApp phone number id to get the WABA account id and phone number details.
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' }, 'linkedWhatsAppBusinessAccountId': '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.
linkedWhatsAppBusinessAccountId (string) –
The WABA identifier linked to the phone number, formatted as
waba-01234567890123456789012345678901
.
Exceptions
EndUserMessagingSocial.Client.exceptions.ValidationException
EndUserMessagingSocial.Client.exceptions.AccessDeniedException
EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException
EndUserMessagingSocial.Client.exceptions.InvalidParametersException
EndUserMessagingSocial.Client.exceptions.ThrottledRequestException
EndUserMessagingSocial.Client.exceptions.InternalServiceException
EndUserMessagingSocial.Client.exceptions.DependencyException