Configurar telefone

POST

/v1/flows/{flowId}/phone-config

Cadastra o telefone do WhatsApp Business que será utilizado para o envio das mensagens automáticas configuradas nas fases do flow.

Essa configuração é um pré-requisito obrigatório: deve ser realizada antes de criar a configuração de mensageria (messaging-config) de qualquer fase do flow. Sem um telefone cadastrado, uma regra de mensageria que utilize o canal WhatsApp falha ao ser criada, pois a API não localiza o número informado em channels[].setup.phoneId.

O cadastro de telefone é vinculado à empresa (tenant), e não a um flow individualmente — uma empresa que já possui telefone configurado em outro flow compartilha automaticamente esse cadastro. Por esse motivo, a chamada é idempotente: se o telefone já estiver cadastrado para a empresa, a API responde com sucesso indicando que o registro já existia, sem retornar erro. É seguro reexecutar esta chamada mais de uma vez.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Telefone configurado

application/json

O telefone foi configurado com sucesso para a empresa, ou já estava cadastrado anteriormente.

Bodyapplication/json

🟠403Permissão ausente

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//phone-config' \
--header 'Content-Type: application/json' \
--data '{
    "phones": [
        {
            "numberId": "string",
            "token": "string"
        }
    ]
}'

Response Example

200 - Exemplo 1

{
    "alreadyExists": true,
    "phones": [
        {
            "numberId": "string",
            "token": "string"
        }
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Mensageria — Visão Geral

Próxima página

Consultar configuração de mensageria