Notas de Implementação:
Enviar e-mail conforme parâmetros enviados.
Informações de Envio:
Cabeçalhos de Envio:
| Parâmetro | Valor | Descrição | Tipo de parâmetro | Tipo de dados |
|---|---|---|---|---|
| Authorization | Bearer | Hash gerado no login | Header | String |
Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar
Modelo:
Dados do e-mail em formato de DTO.
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Para |
Destinatário do e-email. |
string |
Obrigatório |
| Assunto |
Assunto do e-email. |
string |
Opcional |
| Texto |
Texto definido no corpo do e-email. |
string |
Opcional |
| Cc |
Destinatários adicionados em cópia do e-mail, separados por ponto e vírgula. |
string |
Opcional |
| Cco |
Destinatários adicionados em cópia oculta do e-mail, separados por ponto e vírgula. |
string |
Opcional |
| Anexos |
Informa os caminhos dos arquivos anexados ao e-mail, separados por vírgula. |
string |
Opcional |
| ArquivoCorpoEmailHtml |
Informa o caminho dos arquivo HTML para utilizar como modelo de envio de e-mail. |
string |
Opcional |
| ReceberConfirmacaoLeitura |
Define se o remetente recebe confirmação de leitura. |
boolean |
Opcional |
| NaoEnviarCopiaParaRemetente |
Define se o remetente não recebe cópia após envio. |
boolean |
Opcional |
| LinkHtml |
Link html na assinatura do e-mail. |
string |
Opcional |
| LinkGerenciadorDoc |
Link gerenciador de documentos. |
string |
Opcional |
| TextoGerenciadorDoc |
Texto gerenciador de documentos. |
string |
Opcional |
Formato de Envio:
application/json, text/json
{
"Para": "string 1",
"Assunto": "string 2",
"Texto": "string 3",
"Cc": "string 4",
"Cco": "string 5",
"Anexos": "string 6",
"ArquivoCorpoEmailHtml": "string 7",
"ReceberConfirmacaoLeitura": true,
"NaoEnviarCopiaParaRemetente": true,
"LinkHtml": "string 10",
"LinkGerenciadorDoc": "string 11",
"TextoGerenciadorDoc": "string 12"
}
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
Retorno de sucesso ou falha na tentativa de email.
| Código de status HTTP | Descrição | Modelo de resposta |
|---|---|---|
| 200 | OK |
application/json, text/json
Exemplo:
{
"success": true,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 400 | Requisição inválida |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 401 | Não autorizado |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 500 | Requisição falhou |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 502 | Falha de comunicação |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|