オンプレミスAPIを終了します。詳細と次世代クラウドAPIへの移行方法については、オンプレミスAPIの終了のドキュメントを参照してください。

設定

/v1/settings

settingsノードを使用して、WhatsApp Business APIクライアント、ビジネスプロフィール、プロフィール、グループ、アカウントの設定を行ったり、データのバックアップや復元を行ったりします。次のものを設定可能: アプリ設定プロフィール設定ビジネスプロフィール設定バックアップと復元2段階認証

エッジ

このノードには次のエッジが接続されています。

エッジ説明

/application

WhatsApp Business APIクライアントのアプリ設定を更新、取得、またはリセットします。

/profile

プロフィール設定を更新または取得します。

/business/profile

ビジネスの住所、ビジネスの説明、ビジネスの連絡先メールアドレス、ビジネスの業種、ビジネスのウェブサイトなどの、ビジネスプロフィールを設定します。

/business/compliance_info

ビジネスのEコマースコンプライアンス情報を提供したり取得したりします。

/backup/restore

アプリ設定や登録などの情報をバックアップしたり復元したりします。

/account/two-step

2段階認証を使用することで、WhatsApp Business APIクライアントのセキュリティがさらに強化されます。

開始する前に

設定にアクセスするには、必ずadminアカウントを使用します。

API呼び出し

呼び出し先使用目的戻り値

PATCH /v1/settings/application

複数のアプリ設定をアップデートする。

application(ペイロード)オブジェクトなし。

GET /v1/settings/application

すべてのアプリ設定を取得する。

すべての設定可能なアプリ設定の名前と値が含まれるapplicationオブジェクト。

DELETE /v1/settings/application

すべてのアプリ設定をリセットする。

application(ペイロード)オブジェクトなし。

POST /v1/settings/business/profile

ビジネスプロフィールをアップデートする。

ビジネスprofile(ペイロード)オブジェクトなし。

GET /v1/settings/business/profile

ビジネスプロフィール設定を取得する。

住所、説明、メールアドレス、業種、ウェブサイトを含むビジネスprofileオブジェクト。

PATCH /v1/settings/profile/about

ビジネスプロフィール(基本データ)のテキストをアップデートする。

プロフィールabout(ペイロード)オブジェクトなし。

GET /v1/settings/profile/about

プロフィールaboutパラメーターのテキストを取得する。

プロフィール:基本データのテキストコンテンツを含むプロフィールaboutオブジェクト。

POST /v1/settings/profile/photo

プロフィール写真をアップデートする。

ペイロードオブジェクトなし。

GET /v1/settings/profile/photo

プロフィール写真を取得する。

バイナリ画像コンテンツ。

POST /v1/settings/account/two-step

2段階認証をオンにする。

ペイロードオブジェクトなし。

DELETE /v1/settings/account/two-step

2段階認証をオフにする。

ペイロードオブジェクトなし。

POST /v1/settings/backup

データをエクスポートまたはバックアップする。

暗号化されたバックアップdataを含むsettingsオブジェクト。

POST /v1/settings/restore

データをインポートまたは復元する。

ペイロードオブジェクトなし。

GET /v1/settings/business/compliance_info

ビジネスのEコマースコンプライアンス情報を取得する。

ペイロードオブジェクトなし。

POST /v1/settings/business/compliance_info

ビジネスのEコマースコンプライアンス情報を提供する。

legal_entity_detailsオブジェクト。