API Đồ thị
Phiên bản API Đồ thị

WhatsApp Business Account

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

Để tìm ID của một Tài khoản WhatsApp Business, hãy chuyển đến Trình quản lý kinh doanh > Cài đặt cho doanh nghiệp > Tài khoản > Tài khoản WhatsApp Business. Tìm tài khoản bạn muốn dùng rồi nhấp vào tài khoản đó. Một bảng điều khiển sẽ mở ra có chứa thông tin về tài khoản, bao gồm cả 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}

Đọc

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

Thông số

Điểm cuối này không có bất kỳ thông số nào.

Trường

Trường thông tinMô tả
analytics
WABAAnalytics

Used to designate which analytics metrics you want returned. See Analytics.

business_verification_status
enum

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

Mặc định
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

Mặc định
name
string

User-friendly name to differentiate WhatsApp Business Accounts

Mặc định
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

Mặc định

Đường viền

CạnhMô tả
conversation_analytics
Edge<WABAConversationAnalytics>

Analytics data of the WhatsApp Business Account with conversation based pricing

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

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

Mã lỗi

LỗiMô tả
100Invalid parameter
200008WhatsApp Business Account has no linked phone numbers.
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
2500Error parsing graph query
200005Template Insights are not available yet for this WhatsApp Business account
190Invalid OAuth 2.0 Access Token

Tạo

Bạn không thể thực hiện thao tác này trên điểm cuối này.

Cập nhật

Bạn có thể cập nhật a WhatsAppBusinessAccount bằng cách thực hiện yêu cầu POST đến /{whats_app_business_account_id}/assigned_users.

Thông số

Thông sốMô tả
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

Bắt buộc
user
UID

Business user ID

Bắt buộc

Kiểu trả về

Điểm cuối này hỗ trợ đọc sau khi ghi và sẽ đọc nút mà bạn đã đăng vào đó.
Struct {
success: bool,
}

Mã lỗi

LỗiMô tả
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.

Xóa

Bạn có thể hủy liên kết a WhatsAppBusinessAccount khỏi a WhatsAppBusinessAccount bằng cách thực hiện yêu cầu DELETE đến /{whats_app_business_account_id}/assigned_users.

Thông số

Thông sốMô tả
user
UID

Business user ID

Bắt buộc

Kiểu trả về

Struct {
success: bool,
}

Mã lỗi

LỗiMô tả
200Permissions error
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.