Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
Configuração

Configuração de provedor próprio para envio das mensagens de WhatsApp da aplicação ⚠️

⚠️ Utilizar somente sob orientação da Bry ⚠️ </br></br>Modifica o provedor de envio das mensagens de WhatsApp da aplicação. Caso algum ID do template não esteja configurado ou o template esteja com os parâmetros incorretos, a mensagem não será enviada.</br></br> Exemplo de template para UBOTS Link: </br>Olá <signerName>, informamos que a <clientName> disponibilizou um documento para sua assinatura: <collectionName>.</br>Para visualizar o documento, acesse: <link></br></br>Exemplo de template para UBOTS OTP:</br>Para completar o envelope <collectionName>, a sequência <otp> foi gerada.

put/api/service/config/v1/whats

Request body

provider'UBOTS' required

Define o provedor que será utilizado. Provedores disponíveis: [ UBOTS ]. UBOTS: A quantidade de parâmetros e suas chaves devem ser definidos de acordo com o exemplo.

clientIDstring required

Define o clientID do provedor UBOTS

clientSecretstring required

Define o clientSecret do provedor UBOTS

userNamestring required

Nome do usuário configurado para o provedor UBOTS

fromPhonestring required

Número do telefone configurado para o provedor UBOTS

Example request

{
  "provider": "UBOTS",
  "clientID": "valor-client-id",
  "clientSecret": "valor-client-secret",
  "userName": "valor-username",
  "fromPhone": "+5511999998888",
  "templates": {
    "idOtpPtBr": "id-otp-template-pt-br",
    "idOtpEnUs": "id-otp-template-en-us",
    "idOtpEsCl": "id-otp-template-es-cl",
    "idLinkPtBr": "id-link-template-pt-br",
    "idLinkEnUs": "id-link-template-en-us",
    "idLinkEsCl": "id-link-template-es-cl"
  }
}

Response

Sucesso na operação. Retorna apenas o código 204.