アプリケーション設定

WhatsApp Businessオンプレミスクライアントのためのアプリケーション設定。

要件

• リクエストではadminアカウントを使うことが必要です
• すべての応答に200 OK HTTPSを含めることが必要です

読み取り

WhatsApp Businessオンプレミスクライアントのための現在のアプリケーション設定を取得します

例

現在のアプリ設定を取得するには、/v1/settings/applicationエンドポイントに対してGETリクエストを送信します。

GET /v1/settings/application

成功した場合、応答には、200 OKと、現在のすべてのアプリ設定とその値のリストを示すapplicationオブジェクトを含むJSONペイロードが含まれます。

応答の例

{
    "settings": {
        "application": {
            "callback_backoff_delay_ms": 3000,
            "callback_persist": true,
            "garbagecollector_enable": {
                "media": false,
                "messages": true
            },
            "heartbeat_interval": 5,
            "max_callback_backoff_delay_ms": 900000,
            "media": {
                "auto_download": [
                    "image",
                    "video",
                    "voice",
                    "sticker",
                    "audio",
                    "document"
                ]
            },
            "notify_user_change_number": true,
            "show_security_notifications": true,
            "unhealthy_interval": 30,
            "wa_id": "16315551019",
            "webhooks": {
               	"url": "<Webhook URL, https>",
               	"max_concurrent_requests": max-concurrent-requests,
               	"message": { // Available for v2.41.2 and above
                  	"sent": true,
                  	"delivered": true,
                  	"read": false
                 },
             },
             "verbose_logging": false,
             "log_level" : "info"
         },
    },
    "meta": {
        "api_status": "stable",
        "version": "3.0.1"
    }
}

エッジ

更新

アプリ設定を更新するには、/v1/settings/applicationエンドポイントに対して、設定するフィールドの名前と値が含まれるJSONオブジェクトを指定したPATCHリクエストを送信します。

リクエストの例

PATCH /v1/settings/application
{
    "callback_persist": true | false,
    "max_callback_backoff_delay_ms": max-delay-in-ms,
    "media": {
        "auto_download": ["audio", "document", "voice", "video", "image", "sticker"]
    }
    "callback_backoff_delay_ms": "delay-in-ms",
    "heartbeat_interval": heartbeat-interval-in-secs,
    "unhealthy_interval": unhealthy-interval-in-secs,
    "webhooks": { 
        # See the Webhooks Parameters table below for more information
        "max_concurrent_requests": max-concurrent-requests,
        "url": "<Webhook URL, https>",
        "message": {              // Available on v2.41.2 and above
                "sent": false,
                "delivered": true,
                "read": false
           },
    },
    "axolotl_context_striping_disabled": false | true,
    "notify_user_change_number": false | true,
    "show_security_notifications": false | true,
    # Available on v2.49.1 and above
    "garbagecollector_enable": {
        "messages": true | false,
        "media": true | false
    }
    "skip_referral_media_download": true | false,
    "webhook_payload_conversation_pricingmodel_disabled": false | true
    # Available on v2.51.1 and above
    "verbose_logging": false | true,
    "log_level" : log-level-str,
}

成功した場合の応答には、nullまたはJSONオブジェクトを伴う200 OKが含まれます。

エラーが発生した場合は、エラーメッセージとステータスメッセージをご覧ください。

パラメーター

Webhooksパラメーター

メディアのパラメーター

ゴミ収集機能のパラメーター

デフォルトの設定にリセットする

アプリのすべての設定をデフォルト値にリセットするには、/v1/settings/applicationエンドポイントに対してDELETEリクエストを送信します。

リクエストの例

DELETE /v1/settings/application

成功した場合、応答にはnullまたは{}を伴う200 OKが含まれます。

エラーが発生した場合は、エラーメッセージとステータスメッセージをご覧ください。