앱 설정

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

에지

업데이트

앱 설정을 업데이트하려면 설정할 필드 이름과 값이 포함된 JSON 개체가 있는 /v1/settings/application 엔드포인트로 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가 포함됩니다.

오류가 발생하면 오류 및 상태 메시지를 참조하세요.