API Local da Plataforma do WhatsApp Business

WhatsApp Business Platform > On-Premises API > Reference

A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.

Configurações

/v1/settings

Use o nó settings para configurar o cliente da WhatsApp Business API, grupos, seu perfil comercial, seu perfil, sua conta, bem como fazer backup e restaurar dados. As configurações ajustáveis incluem: configurações do app, do perfil, do perfil comercial, bem como backup e restauração e confirmação em duas etapas.

Bordas

As seguintes bordas estão relacionadas ao nó:

Borda	Descrição
`/application`	Use para atualizar, recuperar ou redefinir as configurações do app do cliente da WhatsApp Business API.
`/profile`	Use para atualizar ou recuperar as configurações do perfil.
`/business/profile`	Use para definir as seguintes configurações do perfil comercial: endereço, descrição, email de contato comercial, setor e site da empresa.
`/business/compliance_info`	Use para fornecer e obter informações sobre a conformidade do comércio eletrônico da empresa.
`/backup` e `/restore`	Use para fazer backup e restaurar informações, inclusive configurações do app e registro.
`/account/two-step`	Use a confirmação em duas etapas para adicionar uma camada extra de segurança ao cliente da WhatsApp Business API.

Antes de começar

É preciso usar a conta admin para acessar as configurações.

Chamadas de API

Chamada	Caso de uso	Retorno
`PATCH /v1/settings/application`	Atualizar diversas configurações do app.	Nenhum objeto `application` (carga).
`GET /v1/settings/application`	Obter todas as configurações do app.	Um objeto `application` com o nome e o valor de todas as configurações ajustáveis do app.
`DELETE /v1/settings/application`	Redefinir todas as configurações do app.	Nenhum objeto `application` (carga).
`POST /v1/settings/business/profile`	Atualizar perfil comercial.	Nenhum objeto de `profile` comercial (carga).
`GET /v1/settings/business/profile`	Obter configurações do perfil comercial.	Objeto de `profile` comercial com endereço, descrição, email, setor e sites.
`PATCH /v1/settings/profile/about`	Atualizar texto do perfil comercial (Sobre).	Nenhum objeto `about` do perfil (carga).
`GET /v1/settings/profile/about`	Obter texto do parâmetro `about` do perfil.	Objeto `about` que contém conteúdo de texto para o perfil (Sobre).
`POST /v1/settings/profile/photo`	Atualizar foto de perfil.	Nenhum objeto de carga.
`GET /v1/settings/profile/photo`	Obter foto de perfil.	Conteúdo binário de imagem.
`POST /v1/settings/account/two-step`	Habilitar a confirmação em duas etapas.	Nenhum objeto de carga.
`DELETE /v1/settings/account/two-step`	Desabilitar a confirmação em duas etapas.	Nenhum objeto de carga.
`POST /v1/settings/backup`	Exportar ou fazer backup de dados.	Um objeto `settings` com `data` de backup criptografado.
`POST /v1/settings/restore`	Importar ou restaurar dados.	Nenhum objeto de carga.
`GET /v1/settings/business/compliance_info`	Obter informações sobre a conformidade do comércio eletrônico da empresa.	Nenhum objeto de carga.
`POST /v1/settings/business/compliance_info`	Fornecer informações sobre a conformidade do comércio eletrônico de uma empresa.	Um objeto `legal_entity_details`.