Modelos de Mensagem

Listar

get

Listagem paginada de modelos de mensagem.

Autorizações
Parâmetros de consulta
ArchivedbooleanOpcional

Filtro por modelos de mensagem arquivados.

NamestringOpcional

Filtro por nome do modelo de mensagem.

SearchableTextstringOpcional

Filtro por conteúdo do modelo de mensagem.

ChannelIdstring · uuidOpcional

Filtro por id do canal.

ApprovedOnlybooleanOpcional

Filtro por status do modelo de mensagem.

Typestring · enumOpcional

Filtro por tipo do modelo de mensagem.

Valores possíveis:
CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1
PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15
OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:
Respostas
200

Success

application/json
get
/v1/template
GET /chat/v1/template HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:37:49.231Z",
      "updatedAt": "2025-11-06T22:37:49.231Z",
      "active": true,
      "archived": true,
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "text": "text",
      "footerText": "text",
      "status": "Draft",
      "channelType": "GUPSHUP_WHATSAPP",
      "type": [
        "UNDEFINED"
      ],
      "params": [
        {
          "name": "text",
          "templateId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "internalName": "text",
      "fileType": "UNDEFINED",
      "quickReplyAlias": "text",
      "rejectedDescription": "text",
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "categoryName": "text"
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Enviar OTP

post

Este endpoint permite enviar uma senha OTP para um contato no WhatsApp. O campo Code é opcional, se não for informado será gerado um código de 5 dígitos aleatórios; O campo IntegrationId pode ser usado para um controle do seu sistema;

Autorizações
Corpo
fromstring | nuloOpcional

Número do canal cadastrado na conta.

tostring | nuloOpcional

Número de telefone do destinatário.

codestring | nuloOpcional

Código a ser enviado. Caso não seja informado, um código aleatório será gerado.

integrationIdstring | nuloOpcional

ID de integração para que você possa identificar durante a busca

templateIdstring | nuloOpcional

ID do modelo de mensagem do tipo Autenticação

Respostas
200

Success

application/json
post
/v1/template/otp/send
POST /chat/v1/template/otp/send HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "from": "text",
  "to": "text",
  "code": "text",
  "integrationId": "text",
  "templateId": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:37:49.231Z",
  "updatedAt": "2025-11-06T22:37:49.231Z",
  "code": "text",
  "status": "UNDEFINED",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "integrationId": "text",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-11-06T22:37:49.231Z",
  "receivedAt": "2025-11-06T22:37:49.231Z",
  "contactPhoneNumber": "text",
  "statusUrl": "text",
  "failedReason": "text"
}

Consulta OTP

get

Consulta o status atual de uma mensagem OTP enviada anteriormente.

Autorizações
Parâmetros de rota
messageIdstringObrigatório

ID da mensagem ou IntegrationId para consultar o status.

Respostas
200

Success

application/json
get
/v1/template/otp/{messageId}/status
GET /chat/v1/template/otp/{messageId}/status HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-11-06T22:37:49.231Z",
  "receivedAt": "2025-11-06T22:37:49.231Z",
  "contactPhoneNumber": "text",
  "status": "UNDEFINED",
  "failedReason": "text"
}

Atualizado