Versão 1.2.0 · RESTful + SOAP
API A.R. on-line Livemail
Envie e monitore e-mails em massa com rastreabilidade completa de entrega, abertura e leitura.
← Voltar para Desenvolvedores
Introdução
Especificações para integração com o serviço de A.R. on-line (Livemail) da GTI Digital. Ideal para envios em massa de boletos, duplicatas, avisos de recebimento, notificações e documentos em geral com monitoramento completo.
Endpoints
Web API – RESTful
Endpoint URL
Webservice – SOAP
Endpoint URL
Estrutura da Requisição
| Propriedade | Tipo | Tam. | Obrig. | Descrição |
|---|---|---|---|---|
| apitoken | Texto | 64 | Sim | Token de validação gerado pela GTI Digital. |
| user | Texto | 150 | Sim | E-mail do usuário da conta na plataforma. |
| subject | Texto | 64 | Sim | Assunto do e-mail. |
| body | Texto | 2048 | Sim | Corpo do e-mail. |
| from.name | Texto | 150 | Sim | Nome do remetente. |
| from.email | Texto | 150 | Sim | E-mail do remetente. |
| tos | Lista | - | Sim | Lista de Destinatários. |
| ccs | Lista | - | Não | Lista de destinatários em cópia (CC). |
| ccos | Lista | - | Não | Lista de destinatários em cópia oculta (BCC). |
| attachments | Lista | - | Sim | Lista de anexos do e-mail. |
JSON de Requisição
{ "apitoken": "string", "user": "string", "subject": "string", "body": "string", "from": { "name": "string", "email": "string" }, "tos": [ { "name": "string", "email": "string" } ], "ccs": [ { "name": "string", "email": "string" } ], "ccos": [ { "name": "string", "email": "string" } ], "attachments": [ { "name": "string", "content": "string" } ] }
Resposta da API
| Propriedade | Tipo | Descrição |
|---|---|---|
| success | Booleano | Indica se o retorno foi bem sucedido. |
| message | Texto | Descrição dos erros. |
| msgid | Texto | Id do e-mail enviado pela plataforma GTI Digital. |
{ "success": true, "message": "string", "msgid": "string" }
| Mensagem | Sucesso |
|---|---|
| Sucesso - E-mail enviado com sucesso. | true |
| Falha - API Token incorreto. | false |
| Falha - Dados enviados incorretamente. | false |
| Falha - E-mail do Remetente inválido. | false |
| Falha - E-mail não possui destinatários. | false |