图谱 API
图谱 API 版

WhatsApp Business Account

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

如要获取 WhatsApp Business 商业帐号的编号，请前往商务管理平台 > 商业设置 > 帐号 > WhatsApp Business 商业帐号。找到您要使用的帐号，然后点击该帐号。系统随后将开启一个窗口，其中包含该帐号的编号等相关信息。

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

默认
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

默认

连线

连线描述
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

错误代码

错误描述
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

创建

你无法在此端点执行该操作。

更新

你可以向 /{whats_app_business_account_id}/assigned_users 发出 POST 请求，以更新 a WhatsAppBusinessAccount 。

参数

参数描述
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

必填

返回类型

这个端点支持先写后读，并会读取接收你的 POST 请求的节点。
Struct {
success: bool,
}

错误代码

错误描述
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.

删除

你可以向 /{whats_app_business_account_id}/assigned_users 发出 DELETE 请求，将 a WhatsAppBusinessAccount 与 a WhatsAppBusinessAccount 取消关联。

参数

参数描述
user
UID

Business user ID

必填

返回类型

Struct {
success: bool,
}

错误代码

错误描述
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.