GetLinkedWhatsAppBusinessAccountCommand

Get the details of your linked WhatsApp Business Account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SocialMessagingClient, GetLinkedWhatsAppBusinessAccountCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
// const { SocialMessagingClient, GetLinkedWhatsAppBusinessAccountCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
const client = new SocialMessagingClient(config);
const input = { // GetLinkedWhatsAppBusinessAccountInput
  id: "STRING_VALUE", // required
};
const command = new GetLinkedWhatsAppBusinessAccountCommand(input);
const response = await client.send(command);
// { // GetLinkedWhatsAppBusinessAccountOutput
//   account: { // LinkedWhatsAppBusinessAccount
//     arn: "STRING_VALUE", // required
//     id: "STRING_VALUE", // required
//     wabaId: "STRING_VALUE", // required
//     registrationStatus: "COMPLETE" || "INCOMPLETE", // required
//     linkDate: new Date("TIMESTAMP"), // required
//     wabaName: "STRING_VALUE", // required
//     eventDestinations: [ // WhatsAppBusinessAccountEventDestinations // required
//       { // WhatsAppBusinessAccountEventDestination
//         eventDestinationArn: "STRING_VALUE", // required
//         roleArn: "STRING_VALUE",
//       },
//     ],
//     phoneNumbers: [ // WhatsAppPhoneNumberSummaryList // required
//       { // WhatsAppPhoneNumberSummary
//         arn: "STRING_VALUE", // required
//         phoneNumber: "STRING_VALUE", // required
//         phoneNumberId: "STRING_VALUE", // required
//         metaPhoneNumberId: "STRING_VALUE", // required
//         displayPhoneNumberName: "STRING_VALUE", // required
//         displayPhoneNumber: "STRING_VALUE", // required
//         qualityRating: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

GetLinkedWhatsAppBusinessAccountCommand Input

Parameter
Type
Description
id
Required
string | undefined

The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts  to list all WABAs and their details.

GetLinkedWhatsAppBusinessAccountCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
account
LinkedWhatsAppBusinessAccount | undefined

The details of the linked WhatsApp Business Account.

Throws

Name
Fault
Details
DependencyException
server

Thrown when performing an action because a dependency would be broken.

InternalServiceException
server

The request processing has failed because of an unknown error, exception, or failure.

InvalidParametersException
client

One or more parameters provided to the action are not valid.

ResourceNotFoundException
client

The resource was not found.

ThrottledRequestException
client

The request was denied due to request throttling.

AccessDeniedException
client

You do not have sufficient access to perform this action.

ValidationException
client

The request contains an invalid parameter value.

SocialMessagingServiceException
Base exception class for all service exceptions from SocialMessaging service.