Skip to main content
POST
Inicia a conexão de um número da API oficial do WhatsApp.

Authorizations

X-API-Key
string
header
required

Body

application/json
funnelId
string

ID do funil. Informe junto com funnelStepId para garantir que a etapa pertence a esse funil.

Minimum string length: 1
funnelStepId
string

Etapa em que os contatos deste número entram. Omita para não vincular um funil.

Minimum string length: 1
coexistence
boolean

Quando verdadeiro, abre o fluxo de coexistência com o WhatsApp Business App. O padrão é o Embedded Signup da API oficial.

returnUrl
string

URL https para onde a pessoa volta depois de conectar o número.

Required string length: 1 - 2000

Response

Sessão criada. Abra url numa janela de topo para concluir a conexão.

sessionId
string
required
status
enum<string>
required
Available options:
pending
url
string<uri>
required
expiresAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$