WhatsAppPhoneNumberSummary

The details of a linked phone number.

arn

The full Amazon Resource Name (ARN) for the phone number.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:.*:phone-number-id/[0-9a-zA-Z]+

Required: Yes

displayPhoneNumber

The phone number that appears in the recipients display.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 20.

Required: Yes

displayPhoneNumberName

The display name for this phone number.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: Yes

metaPhoneNumberId

The phone number ID from Meta.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

phoneNumber

The phone number associated with the Linked WhatsApp Business Account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Required: Yes

phoneNumberId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 115.

Pattern: .*(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$).*

Required: Yes

qualityRating

The quality rating of the phone number. This is from Meta.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10.

Required: Yes

dataLocalizationRegion

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

Type: String

Pattern: [A-Z]{2}

Required: No

Contents