グラフAPI
グラフAPIバージョン

Whats App Business Account Assigned Users

Represents users assigned to a specific WhatsApp Business Account (WABA).

WhatsApp BusinessアカウントのIDは、[ビジネスマネージャ] > [ビジネス設定] > [アカウント] > [WhatsApp Businessアカウント]で確認できます。使用するアカウントを見つけてクリックします。パネルが開き、IDなどのアカウント情報を確認できます。

読み取り

Returns the WhatsApp Business Account's assigned users.

Example

Requirements

  • whatsapp_business_management permission

  • whatsapp_business_messaging permission

  • public_profile permission

  • BUSINESS ID (also referred to as BUSINESS MANAGER ID in Business Settings)

  • WhatsApp Business Account (WABA) ID

  • USER ACCESS TOKEN

Request

curl -i -X GET \
 "https://graph.facebook.com/LATEST-VERSION/WHATSAPP-BUSINESS-ACCOUNT-ID/assigned_users?
        business=BUSINESS-ID&
        access_token=USER-ACCESS-TOKEN"
GraphRequest request = GraphRequest.newGraphPathRequest(
  accessToken,
  "/WHATSAPP-BUSINESS-ACCOUNT-ID/assigned_users",
  new GraphRequest.Callback() {
    @Override
    public void onCompleted(GraphResponse response) {
      // Insert your code here
    }
});

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

Response

{
  "data": [
    {
      "id": "ASSIGNED-USER-ID",
      "name": " ",
      "tasks": [
        "MANAGE"
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "BEFORE-CURSOR",
      "after": "AFTER-CURSOR"
    }
  }
}

パラメーター

パラメーター説明
business
numeric string

business

必須

項目

このエッジからの読み込むではJSONフォーマットの結果が返されます:

{
    "data": [],
    "paging": {},
    "summary": {}
}

data

AssignedUserノードの一覧です。

各ノードに以下のフィールドが追加されます:

フィールド説明
tasks
list<string>

Tasks the user has on the WABA

デフォルト

paging

ページネ―ションについて詳しくは、グラフAPIガイドをご覧ください。

summary

エッジの集計情報(数値など)。サマリーパラメータで取得するフィールドを指定します(サマリー=total_countなど)。

フィールド説明
total_count
unsigned int32

Total count

エラーコード

エラー詳細
100Invalid parameter

作成

このエンドポイントではこの操作を実行できません。

更新中…

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

必須

戻り値の型

This endpoint supports read-after-write and will read the node to which you POSTed.
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.

削除中です

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

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
100Invalid parameter