01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de mensagens.
IMPORTANTE
- A implementação das integrações via API deve ser realizada pelo cliente, que será responsável pelos custos e pelo desenvolvimento envolvidos.
02. ENDPOINT E PARÂMETROS DE ENTRADA
Endpoint da API que será utilizado para inserir e atualizar dados:
| URL base | Endpoint |
|---|---|
| https://api-centraldorecrutador.totvs.app/recruitment-integration | {URL base}/api/v1/job-application/{jobApplicationId}/messages |
2.1 - DADOS ENVIADOS
Parâmetro | Descrição | Obrigatório |
|---|---|---|
| jobApplicationId | Filtrar pelo identificador da candidatura (integrationId ou applicant.id) |  |
| page | Número da página que deseja obter os dados |  |
| pageSize | Quantidade de mensagens por páginas |
|
Retorno:
| Campo | Descrição | ||
|---|---|---|---|
| id | ID único da mensagem | ||
| jobApplicationId | Id do candidato na candidatura | ||
| subject | Assunto da mensagem | ||
| message | Texto da mensagem | ||
| sendDate | Data de envio da mensagem | ||
| recipientEmail | Destinatários da mensagem | ||
history | id | Id da mensagem | |
| senderEmail | Remetente do Email | ||
| senderName | Nome do remetente | ||
| message | Mensagem | ||
| sendDate | Data do envio do email | ||
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas