Sequências

Listar

get

Listagem paginada de sequências.

Autorizações
Parâmetros de consulta
NamestringOpcional
ContactIdstring · uuidOpcional
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/sequence
GET /chat/v1/sequence 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",
      "active": true,
      "createdAt": "2025-11-06T22:30:06.690Z",
      "updatedAt": "2025-11-06T22:30:06.690Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "enabled": true,
      "contactExecutingCount": 1
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Listar contatos

get
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da sequência.

Respostas
200

Success

application/json
get
/v1/sequence/{id}/contact
GET /chat/v1/sequence/{id}/contact 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",
      "active": true,
      "createdAt": "2025-11-06T22:30:06.690Z",
      "updatedAt": "2025-11-06T22:30:06.690Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "sequenceId": "123e4567-e89b-12d3-a456-426614174000",
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "contactName": "text",
      "origin": "USER_SINGLE",
      "addedByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "addedByChatbotId": "123e4567-e89b-12d3-a456-426614174000",
      "lastAddedAt": "2025-11-06T22:30:06.690Z",
      "contactDetails": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "phonenumber": "text",
        "phonenumberFormatted": "text",
        "instagram": "text",
        "email": "text",
        "pictureUrl": "text"
      }
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Adicionar contato

post

Adicione um contato em uma sequência.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da sequência.

Corpo
contactIdstring · uuid | nuloOpcional

ID do contato.

phoneNumberstring | nuloOpcional

Telefone do contato.

Respostas
200

Success

application/json
post
/v1/sequence/{id}/contact
POST /chat/v1/sequence/{id}/contact HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "phoneNumber": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "active": true,
  "createdAt": "2025-11-06T22:30:06.690Z",
  "updatedAt": "2025-11-06T22:30:06.690Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "sequenceId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "contactName": "text",
  "origin": "USER_SINGLE",
  "addedByUserId": "123e4567-e89b-12d3-a456-426614174000",
  "addedByChatbotId": "123e4567-e89b-12d3-a456-426614174000",
  "lastAddedAt": "2025-11-06T22:30:06.690Z",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "phonenumber": "text",
    "phonenumberFormatted": "text",
    "instagram": "text",
    "email": "text",
    "pictureUrl": "text"
  }
}

Remover contato

delete

Remova um contato de uma sequência.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da sequência.

Corpo
contactIdstring · uuid | nuloOpcional

ID do contato.

phoneNumberstring | nuloOpcional

Telefone do contato.

Respostas
200

Success

Sem conteúdo
delete
/v1/sequence/{id}/contact
DELETE /chat/v1/sequence/{id}/contact HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "phoneNumber": "text"
}
Sem conteúdo

Adicionar contatos

post

Adicione contatos em uma sequência adicionando um filtro.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da sequência.

Corpo
contactIdsstring · uuid[] | nuloOpcional

Filtro por ids.

phoneNumbersstring[] | nuloOpcional

Filtro por números de telefones. Caso o contato não exista ele será criado

Respostas
200

Success

application/json
post
/v1/sequence/{id}/contact/batch
POST /chat/v1/sequence/{id}/contact/batch HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "contactIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "phoneNumbers": [
    "text"
  ]
}
{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "active": true,
      "createdAt": "2025-11-06T22:30:06.690Z",
      "updatedAt": "2025-11-06T22:30:06.690Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "sequenceId": "123e4567-e89b-12d3-a456-426614174000",
      "contactId": "123e4567-e89b-12d3-a456-426614174000",
      "contactName": "text",
      "origin": "USER_SINGLE",
      "addedByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "addedByChatbotId": "123e4567-e89b-12d3-a456-426614174000",
      "lastAddedAt": "2025-11-06T22:30:06.690Z",
      "contactDetails": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "phonenumber": "text",
        "phonenumberFormatted": "text",
        "instagram": "text",
        "email": "text",
        "pictureUrl": "text"
      }
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Remover contatos

delete

Remova contatos de uma sequência adicionando um filtro.

Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID da sequência.

Corpo
contactIdsstring · uuid[] | nuloOpcional

Filtro por ids.

phoneNumbersstring[] | nuloOpcional

Filtro por números de telefones. Caso o contato não exista ele será criado

Respostas
200

Success

Sem conteúdo
delete
/v1/sequence/{id}/contact/batch
DELETE /chat/v1/sequence/{id}/contact/batch HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "contactIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "phoneNumbers": [
    "text"
  ]
}
Sem conteúdo

Atualizado