Graph API-Version

WhatsApp Business Account

Represents a specific WhatsApp Business Account (WABA). Make the API call to the WABA ID.

Die ID eines WhatsApp Business-Kontos findest du unter Business Manager > Unternehmenseinstellungen > Konten > WhatsApp Business-Konten. Suche dort nach dem Konto, das zu verwenden möchtest, und klicke darauf. Es wird eine Ansicht mit Informationen zum Konto angezeigt, einschließlich der ID.

For more information on how to use the API, see WhatsApp Business Management API.

The following API calls are subject to Business Use Case Rate Limits:

GET, POST, and DELETE calls to /{whats-app-business-account-id}/assigned_users
GET calls to /{whats-app-business-account-id}

Wird gelesen

Returns the account information of a WhatsApp Business Account

Example

Requirements

whatsapp_business_management permission
whatsapp_business_messaging permission
public_profile permission
WhatsApp Business Account (WABA) ID
USER ACCESS TOKEN

Request

curl -i -X GET \
 "https://graph.facebook.com/LATEST-VERSION/WHATSAPP-BUSINESS-ACCOUNT-ID?access_token=USER-ACCESS-TOKEN"

GraphRequest request = GraphRequest.newGraphPathRequest(
  accessToken,
  "/WHATSAPP-BUSINESS-ACCOUNT-ID",
  new GraphRequest.Callback() {
    @Override
    public void onCompleted(GraphResponse response) {
      // Insert your code here
    }
});

request.executeAsync();

FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
    initWithGraphPath:@"/WHATSAPP-BUSINESS-ACCOUNT-ID"
           parameters:nil
           HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection, id result, NSError *error) {
    // Insert your code here
}];

Response

{
  "id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
  "name": "Test WhatsApp Business Account",
  "timezone_id": "1",
  "message_template_namespace": "MESSAGE-TEMPLATE-NAMESPACE"
}

Parameter

Dieser Endpunkt hat keine Parameter.

Felder

Feld	Beschreibung
`analytics` WABAAnalytics	Used to designate which analytics metrics you want returned. See Analytics.
`business_verification_status` enum {expired, failed, ineligible, not_verified, pending, pending_need_more_info, pending_submission, rejected, revoked, verified}	Current status of business verification of Meta Business Account which owns this WhatsApp Business Account
`country` string	country of the WhatsApp Business Account's owning Meta Business account
`currency` string	The currency in which the payment transactions for the WhatsApp Business Account will be processed Standard
`is_enabled_for_insights` bool	If `true`, indicates the WhatsApp Business Account enabled template analytics. See Analytics.
`message_template_namespace` string	Namespace string for the message templates that belong to the WhatsApp Business Account Standard
`name` string	User-friendly name to differentiate WhatsApp Business Accounts Standard
`on_behalf_of_business_info` WABAOnBehalfOfComputedInfo	The "on behalf of" information for the WhatsApp Business Account
`ownership_type` enum	Ownership type of the WhatsApp Business Account
`primary_funding_id` numeric string	Primary funding ID for the WhatsApp Business Account paid service
`purchase_order_number` string	The purchase order number supplied by the business for payment management purposes
`timezone_id` string	The timezone of the WhatsApp Business Account Standard

Edges

Edge	Beschreibung
`activities` Edge<WhatsAppBusinessActivityHistory>	activities
`call_analytics` Edge<WABACallAnalytics>	Analytics data of the WhatsApp Business Account for calling
`conversation_analytics` Edge<WABAConversationAnalytics>	Analytics data of the WhatsApp Business Account with conversation based pricing
`dataset` Edge<Dataset>	ID of the dataset
`dcc_config` Edge<WhatsAppBusinessDirectConnectionExternalConfig>	Returns a list of DCC configs
`message_template_previews` Edge<WhatsAppBusinessAccountMessageTemplatePreview>	Retrieves a preview of a message template based on the provided configuration
`message_templates` Edge<WhatsAppBusinessHSM>	Message templates that belong to the WhatsApp Business Account
`payment_configuration` Edge<WhatsAppBusinessAccountPaymentConfiguration>	Fetch payment configuration attached to the WhatsApp Business Account.
`payment_configurations` Edge<WhatsAppBusinessAccountPaymentConfigurations>	Fetch all payment configurations attached to the WhatsApp Business Account.
`phone_numbers` Edge<WhatsAppBusinessAccountToNumberCurrentStatus>	The phone numbers that belong to the WhatsApp Business Account
`product_catalogs` Edge<ProductCatalog>	product_catalogs
`solutions` Edge<WhatsAppBusinessSolution>	Partner solutions that this WhatsApp Business Account is linked to
`subscribed_apps` Edge<WhatsAppApplication>	List of apps that are subscribed to webhooks updates for this WABA
`template_performance_metrics` Edge<WhatsAppBusinessHSMWhatsAppBusinessPerformanceMetrics>	template_performance_metrics

Error Codes

Fehler	Beschreibung
200008	WhatsApp Business Account has no linked phone numbers.
100	Invalid parameter
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.
200	Permissions error
200005	Template Insights are not available yet for this WhatsApp Business account
190	Invalid OAuth 2.0 Access Token
2500	Error parsing graph query

Wird erstellt

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.

Wird aktualisiert

You can update a WhatsAppBusinessAccount by making a POST request to /{whats_app_business_account_id}/assigned_users.

Parameter

Parameter Beschreibung

Parameter	Beschreibung
`tasks` array<enum {MANAGE, DEVELOP, MANAGE_TEMPLATES, MANAGE_PHONE, VIEW_COST, MANAGE_EXTENSIONS, VIEW_PHONE_ASSETS, MANAGE_PHONE_ASSETS, VIEW_TEMPLATES, MESSAGING}>	Permissions on WhatsApp Business Account erforderlich
`user` UID	Business user ID erforderlich

tasks

array<enum {MANAGE, DEVELOP, MANAGE_TEMPLATES, MANAGE_PHONE, VIEW_COST, MANAGE_EXTENSIONS, VIEW_PHONE_ASSETS, MANAGE_PHONE_ASSETS, VIEW_TEMPLATES, MESSAGING}>

Permissions on WhatsApp Business Account

erforderlich

user

UID

Business user ID

erforderlich

Rückgabetyp

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

success: bool,

}

Error Codes

Fehler	Beschreibung
100	Invalid parameter
200	Permissions error
80008	There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.

Wird gelöscht

You can dissociate a WhatsAppBusinessAccount from a WhatsAppBusinessAccount by making a DELETE request to /{whats_app_business_account_id}/assigned_users.

Parameter

Parameter Beschreibung

Parameter	Beschreibung
`user` UID	Business user ID erforderlich

user

UID

Business user ID

erforderlich

Rückgabetyp

Struct {

success: bool,

}

Error Codes

Fehler	Beschreibung
100	Invalid parameter

WhatsApp Business Account

Wird gelesen

Example

Parameter

Felder

Edges

Error Codes

Wird erstellt

Wird aktualisiert

Parameter

Rückgabetyp

Error Codes

Wird gelöscht

Parameter

Rückgabetyp

Error Codes

Supported values

Currencies

Time Zones