Usuários | Desenvolvedores

Listar

get

Autorizações

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/agent

GET /core/v1/agent HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-11-06T22:34:41.864Z",
    "updatedAt": "2025-11-06T22:34:41.864Z",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "email": "text",
    "phoneNumber": "text",
    "phoneNumberFormatted": "text",
    "profile": "text",
    "isOwner": true,
    "departments": [
      {
        "agentId": "123e4567-e89b-12d3-a456-426614174000",
        "departmentId": "123e4567-e89b-12d3-a456-426614174000",
        "isAgent": true,
        "isSupervisor": true
      }
    ]
  }
]

Criar novo usuário

post

Autorizações

Corpo

namestring · mín: 1 · máx: 100Obrigatório

Nome do usuário

emailstring · email · mín: 1Obrigatório

Email do usuário

phoneNumberstring · mín: 1Obrigatório

Telefone do usuário

profilestring · enumObrigatório

Perfil do usuário

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

post

/v1/agent

POST /core/v1/agent HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "name": "text",
  "email": "[email protected]",
  "phoneNumber": "text",
  "profile": "Admin"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:34:41.864Z",
  "updatedAt": "2025-11-06T22:34:41.864Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "shortName": "text",
  "email": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "profile": "text",
  "isOwner": true,
  "departments": [
    {
      "agentId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "isAgent": true,
      "isSupervisor": true
    }
  ]
}

Obter detalhes de um usuário

get

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID do usuário

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/agent/{id}

GET /core/v1/agent/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:34:41.864Z",
  "updatedAt": "2025-11-06T22:34:41.864Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "shortName": "text",
  "email": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "profile": "text",
  "isOwner": true,
  "departments": [
    {
      "agentId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "isAgent": true,
      "isSupervisor": true
    }
  ]
}

Atualizar dados do usuário

put

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID do usuário

Corpo

DTO para atualização parcial de usuário

namestring | nuloOpcional

Nome do usuário

shortNamestring | nuloOpcional

Nome curto/apelido do usuário

emailstring | nuloOpcional

Email do usuário

phoneNumberstring | nuloOpcional

Número de telefone do usuário

profilestring · enumOpcional

Perfil do usuário

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

put

/v1/agent/{id}

PUT /core/v1/agent/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "text",
  "shortName": "text",
  "email": "text",
  "phoneNumber": "text",
  "profile": "Admin",
  "fields": [
    "Undefined"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:34:41.864Z",
  "updatedAt": "2025-11-06T22:34:41.864Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "shortName": "text",
  "email": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "profile": "text",
  "isOwner": true,
  "departments": [
    {
      "agentId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "isAgent": true,
      "isSupervisor": true
    }
  ]
}

Remover um usuário

delete

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID do usuário

Corpo

sessionResolutionstring · enum | nuloOpcionalValores possíveis:

transferUserIdstring · uuid | nuloOpcional

ID do usuário que receberá os atendimentos em andamento. Obrigatório quando o campo sessionResolution for igual a TRANSFER

Respostas

200

Success

Sem conteúdo

500

Server Error

application/json

delete

/v1/agent/{id}

DELETE /core/v1/agent/{id} HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "sessionResolution": "COMPLETE",
  "transferUserId": "123e4567-e89b-12d3-a456-426614174000"
}

Sem conteúdo

Atualizar equipes de um usuário

post

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID do usuário

Corpo

DTO para atualização de equipes do usuário

actionstring · enumObrigatório

Ação a ser executada: REPLACE_ALL, UPSERT ou REMOVE

Valores possíveis:

Respostas

200

Success

Sem conteúdo

500

Server Error

application/json

post

/v1/agent/{id}/departments

POST /core/v1/agent/{id}/departments HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "action": "ReplaceAll",
  "items": [
    {
      "departmentId": "text",
      "isAgent": true,
      "isSupervisor": true
    }
  ]
}

Sem conteúdo

Alterar status de um usuário

post

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID do usuário

Corpo

DTO para alteração de status do usuário

statusstring · enumObrigatório

Novo status do usuário

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

post

/v1/agent/{id}/status

POST /core/v1/agent/{id}/status HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "Undefined"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:34:41.864Z",
  "updatedAt": "2025-11-06T22:34:41.864Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "shortName": "text",
  "email": "text",
  "phoneNumber": "text",
  "phoneNumberFormatted": "text",
  "profile": "text",
  "isOwner": true,
  "departments": [
    {
      "agentId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "isAgent": true,
      "isSupervisor": true
    }
  ]
}

Fazer logout de um usuário em todos os dispositivos

post

Autorizações

Parâmetros de rota

idstring · uuidObrigatório

ID do usuário

Respostas

200

Success

Sem conteúdo

500

Server Error

application/json

post

/v1/agent/{id}/logout

POST /core/v1/agent/{id}/logout HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo