Update-Application-Settings

PATCH

/settings/application

Application

If a field is not present in the request, no change is made to that setting. For example, if on_call_pager is not sent with the request, the existing configuration for on_call_pager is unchanged.

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH 'http:///settings/application' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhooks": {
        "url": "<Webhook URL, https>"
    }
}'

响应示例

{
  "errors": [
    {
      "code": 1234,
      "details": "optional-detailed-error-message",
      "title": "error-code-title"
    }
  ],
  "meta": {
    "api_status": "deprecated",
    "version": "whatsapp-business-api-client-version"
  }
}

请求参数

Body 参数application/json

callback_backoff_delay_ms

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.

默认值:

3000

callback_persist

boolean

可选

Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.

默认值:

true

heartbeat_interval

integer

可选

Multiconnect: Interval of the Master node monitoring of Coreapp nodes in seconds

默认值:

max_callback_backoff_delay_ms

string

可选

Maximum delay for a failed callback in milliseconds

默认值:

900000

media

object (Media)

可选

示例值:

{"auto_download":["image","document","audio"]}

auto_download

array[string]

必需

An array specifying which types of media to automatically download.

枚举值:

audiodocumentvoicevideoimage.

on_call_pager

string

可选

Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.

pass_through

boolean

可选

When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted.
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. Restart required.

默认值:

true

sent_status

boolean

可选

Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification.

默认值:

false

unhealthy_interval

integer

可选

Multiconnect: 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.

默认值:

webhooks

object (Webhooks)

可选

示例值:

{"max_concurrent_requests":12,"url":"<Webhook URL, https>"}

max_concurrent_requests

enum<integer> <int32>

可选

Configures the maximum number of inflight callback requests that are sent out. Can be set to 6 (default), 12, 18, or 24.

枚举值:

6121824

默认值:

url

string

可选

Inbound and outbound notifications are routed to this URL. A HTTPS-based endpoint is required; HTTP will not work.

示例

返回响应

🟢200成功

application/json

Body

errors

array[object (Error) {4}]

可选

Only returned with a failed request. Contains an array of error objects that are present when there is an error.

code

integer <int32>

可选

See the https://developers.facebook.com/docs/whatsapp/api/errors for more information.

details

string

可选

error detail

href

string

可选

location for error detail

title

string

可选

error title