Get Settings
GET {{URL}}/v1/settings/application
Gets the application settings of the WhatsApp Business API client.
You must use the
adminaccount to access the application settings.
Response Parameters
| Name | Description |
|---|---|
callback_persist
type: Boolean |
Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Messages and callbacks are both stored in a local database to ensure that they are delivered successfully before being removed from the local database. This protects the callbacks in the event the WhatsApp Business API client or server goes down.
Values:
true
(default),
false
Coreapp restart required. |
max_callback_backoff_delay_ms
type: String |
Maximum delay for a failed callback in milliseconds. For more information, read the description for
callback_backoff_delay_ms
below.
Default: 900000 |
media
type: Array | List of media to auto-download. For more information, see Auto-download Media Settings . |
callback_backoff_delay_ms
type: String |
Backoff delay for a failed callback in milliseconds.
This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a
HTTPS 200 OK
response. The backoff delay is capped by the
max_callback_backoff_delay_ms
setting. For example, if a callback fails the first time, it will try again in 3000ms (3 sec). A second failure will result in a 6000ms (6 sec) delay before retry. This continues until the callback is successful or the delay reaches 900000ms (15 min) after which the callback will continue to be retried but the delay will not increase.
Default : 3000 |
pass_through
type: Boolean |
Starting with
v2.35
, you can no longer re-enable the pass
through setting for WhatsApp Business API Clients.
Allows for individual messages to be deleted or stored to a local database after they've been delivered or read. When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message **`pass through
** or not.<ul><li>When **
true
**, it removes messages from the local database after they are delivered to or read by the recipient.</li><li>When **
false
**, it saves all messages on local storage until they are automatically deleted (i.e., **
db
garbagecollector
enable
** is **
true
**) or explicitly deleted (i.e., **
db
garbagecollector
enable
** is **
false
**). For more information, see the [Services documentation](https://developers.facebook.com/docs/whatsapp/api/services).</li></ul><br/><br/>We recommend you disable **
pass_through
** so the status callback can function as expected.<br/><br/>**Values**: **
true
**, **
false`
(default)
Coreapp restart required.** |
sent_status
type: Boolean |
Deprecated
: Receive a notification that a message was sent to the server.
Values :
true
(default),
false
Starting in
v2.45
, this parameter will be deprecated in favor of the Webhooks Message Object Component.
|
webhooks
type: Webhooks Object |
The Webhook URL. For example:
https://spotless-process.glitch.me/webhook
.
If the Webhook URL is not set, callbacks are dropped. Callbacks are an important channel to deliver both timely notifications as well as out-of-band errors, and it is thus highly recommended you configure the Webhook URL endpoint. For details on the Webhook fields, see the
Webhooks
Field table below.
|
unhealthy_interval
type: Integer |
Maximum amount of seconds a Master node waits for a Coreapp node to respond to a heartbeat before considering it unhealthy and starting the failover process.
Default : 30 Applies to Multiconnect setups . |
heartbeat_interval
type: Integer |
Interval of the Master node monitoring of Coreapp nodes in seconds.
Default : 5 Applies to Multiconnect setups . |
axolotl_context_striping_disabled
type: Boolean |
Affects database connection limits.
Outbound and inbound performance improved with
v2.25
. This optimization relies on creating additional database connections. For some deployments, this can cause database connection limits to be reached. In that case, set the
axolotl_context_striping_disabled
configuration to
true
to disable this performance improvement feature. There is no other effect on any functionalities of the Coreapp.
Values :
true
,
false
(default)
Coreapp restart required . |
notify_user_change_number
type: Boolean |
Affects the user
changed
number system notification.
Values :
true
,
false
(default)
|
show_security_notifications
type: Boolean |
If enabled, you will receive a
user_identity_changed
Webhook notification when the WhatsApp Business API client detects a user you are in a conversation with has potentially changed. When this happens, all outgoing messages to this user are blocked until you have acknowledged the identity change for this user using the
identity
endpoint.
Values :
true
,
false
(default)
|
db_garbagecollector_enable
type: Boolean |
Enables automatic garbage collection of the messages database to assist in database management.
This parameter is
false
for users who had
pass_through
set to
false
before
v2.29
. We recommend you enable this setting to ensure your database operates with stability. If you would like to disable this setting, we recommend you consider using the
/services/message/gc
endpoint to manage the database.
Values :
true
(default),
false
Coreapp restart required . |
skip_referral_media_download
type: Boolean |
If set to
true
, the image or video that the user clicked on an ad that Clicks to WhatsApp is not downloaded.
Values :
true
,
false
(default)
|
webhook_payload_conversation_pricingmodel_disabled
type: Boolean |
Deprecated as of
v2.39
release
.
Controls the inclusion of conversation and pricing information payloads in message status notifications. This field was introduced with the WhatsApp API
v2.33
.
Values :
true
,
false
(default)
Coreapp restart is not required . |
Webhooks Fields
The following table describes fields in the
webhooks
object in more detail:
| Name | Description |
|---|---|
url
Type: String |
Inbound and outbound notifications are routed to this URL. For more information, see the Webhooks documentation.
An HTTPS-based endpoint is required; HTTP will not work. Example:
https://spotless-process.glitch.me/webhook
|
max_concurrent_requests
Type: Integer |
Configures the maximum number of inflight callback requests that are sent out.
Values:
6
(Default),
12
,
18
, or
24
Coreapp restart required . |
Auto-download Media Parameters
The following table describes the
media
object in more detail:
| Name | Description |
|---|---|
auto_download
Type: Array |
Specifies which types of media to automatically download.
Values:
audio
,
document
,
voice
,
video
.
image
,
sticker
|
HEADERS
| Key | Datatype | Required | Description |
| Authorization | string | | |
RESPONSES
status: OK
{"settings":{"application":{"callback_backoff_delay_ms":3000,"callback_persist":true,"garbagecollector_enable":{"messages":true,"media":false},"heartbeat_interval":5,"max_callback_backoff_delay_ms":900000,"media":{"auto_download":["image","video","voice","sticker","audio","document"]},"notify_user_change_number":true,"sent_status":true,"show_security_notifications":true,"unhealthy_interval":30,"wa_id":"16315551019","webhooks":{"max_concurrent_requests":12,"url":"https://10.254.254.254:8000"}}},"meta":{"api_status":"stable","version":"v2.51.1"}}