get-linked-whatsapp-business-account-phone-number¶

Description¶

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

Synopsis¶

  get-linked-whatsapp-business-account-phone-number
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--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.

Constraints:

min: 1

max: 115

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

phoneNumber -> (structure)

The details of your WhatsApp phone number.

arn -> (string) [required]

The ARN of the WhatsApp phone number.

Constraints:

min: 0

max: 2048

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

phoneNumber -> (string) [required]

The phone number for sending WhatsApp.

Constraints:

min: 1

max: 20

phoneNumberId -> (string) [required]

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

Constraints:

min: 1

max: 115

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

metaPhoneNumberId -> (string) [required]

The phone number ID from Meta.

Constraints:

min: 1

max: 100

displayPhoneNumberName -> (string) [required]

The display name for this phone number.

Constraints:

min: 0

max: 200

displayPhoneNumber -> (string) [required]

The phone number that appears in the recipients display.

Constraints:

min: 0

max: 20

qualityRating -> (string) [required]

The quality rating of the phone number.

Constraints:

min: 0

max: 10

dataLocalizationRegion -> (string)

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

Constraints:

pattern: [A-Z]{2}

linkedWhatsAppBusinessAccountId -> (string)

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

Constraints:

min: 1

max: 115

pattern: .*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*

callSettings -> (structure)

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

callEnabled -> (boolean) [required]

Specifies whether calling is enabled for the phone number.

callHours -> (structure)

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 .

Constraints:

min: 1

max: 100

weeklyOperatingHours -> (list) [required]

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

Constraints:

min: 0

max: 14

(structure)

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.

Possible values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

openTime -> (structure) [required]

The time of day when the business begins accepting calls.

hours -> (integer) [required]

The hour of the day, from 0 to 23.

Constraints:

min: 0

max: 23

minutes -> (integer) [required]

The minute of the hour, from 0 to 59.

Constraints:

min: 0

max: 59

closeTime -> (structure) [required]

The time of day when the business stops accepting calls.

hours -> (integer) [required]

The hour of the day, from 0 to 23.

Constraints:

min: 0

max: 23

minutes -> (integer) [required]

The minute of the hour, from 0 to 59.

Constraints:

min: 0

max: 59

holidaySchedule -> (list)

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

Constraints:

min: 0

max: 20

(structure)

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

Constraints:

min: 10

max: 10

pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}

startTime -> (structure) [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.

Constraints:

min: 0

max: 23

minutes -> (integer) [required]

The minute of the hour, from 0 to 59.

Constraints:

min: 0

max: 59

endTime -> (structure) [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.

Constraints:

min: 0

max: 23

minutes -> (integer) [required]

The minute of the hour, from 0 to 59.

Constraints:

min: 0

max: 59

callIconVisibility -> (string)

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

Constraints:

min: 1

max: 50

callbackPermissionStatus -> (string)

The callback permission status for the phone number.

Constraints:

min: 1

max: 50

Table of Contents

Feedback

User Guide