إصدار ‏‎Graph API‎‏

WhatsApp Business Account

Represents a specific WhatsApp Business Account (WABA). Make the API call to the WABA 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}

قراءة

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"
}

المعلمات

لا تحتوي نقطة النهاية هذه على أي معلمات.

الحقول

الحقلالوصف
analytics

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

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

name
string

User-friendly name to differentiate WhatsApp Business Accounts

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

عناصر الربط

حد الشبكة الخلويةالوصف
Edge<WhatsAppBusinessActivityHistory>

activities

Edge<WABACallAnalytics>

Analytics data of the WhatsApp Business Account for calling

Edge<WABAConversationAnalytics>

Analytics data of the WhatsApp Business Account with conversation based pricing

Edge<Dataset>

ID of the dataset

Edge<WhatsAppBusinessDirectConnectionExternalConfig>

Returns a list of DCC configs

Edge<WhatsAppBusinessAccountMessageTemplatePreview>

Retrieves a preview of a message template based on the provided configuration

Edge<WhatsAppBusinessHSM>

Message templates that belong to the WhatsApp Business Account

Edge<WhatsAppBusinessAccountPaymentConfiguration>

Fetch payment configuration attached to the WhatsApp Business Account.

Edge<WhatsAppBusinessAccountPaymentConfigurations>

Fetch all payment configurations attached to the WhatsApp Business Account.

Edge<WhatsAppBusinessAccountToNumberCurrentStatus>

The phone numbers that belong to the WhatsApp Business Account

Edge<ProductCatalog>

product_catalogs

Edge<WhatsAppBusinessSolution>

Partner solutions that this WhatsApp Business Account is linked to

Edge<WhatsAppApplication>

List of apps that are subscribed to webhooks updates for this WABA

Edge<WhatsAppBusinessHSMWhatsAppBusinessPerformanceMetrics>

template_performance_metrics

‎Error Codes‎

خطأالوصف
200008WhatsApp Business Account has no linked phone numbers.
100Invalid parameter
80008There 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.
200Permissions error
200005Template Insights are not available yet for this WhatsApp Business account
190Invalid OAuth 2.0 Access Token
2500Error parsing graph query

إنشاء

لا يمكنك تنفيذ هذه العملية في نقطة النهاية هذه.

جارٍ التحديث

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

المعلمات

معلمةالوصف
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

مطلوب
user
UID

Business user ID

مطلوب

‎Return Type‎

‎This endpoint supports ‎read-after-write‎ and will read the node to which you POSTed.‎
Struct {
success: bool,
}

‎Error Codes‎

خطأالوصف
100Invalid parameter
200Permissions error
80008There 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.

جارٍ الحذف

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

المعلمات

معلمةالوصف
user
UID

Business user ID

مطلوب

‎Return Type‎

Struct {
success: bool,
}

‎Error Codes‎

خطأالوصف
100Invalid parameter

Supported values

Currencies

Supported values for currency codes can be found in currencies.

Time Zones

Supported values for time zones can be found in timezone ids.