Metadados Base64

Aqui você irá encontrar um modelo dos parâmetros do customer, que deverão ser encaminhados à D1 para o envio das comunicações com arquivo, em Base64
Customer é um objeto que representa o cliente dentro da plataforma.
Body de exemplo
1
{
2
   "id":"111.111.111-11",
3
   "name":"João da Silva",
4
   "nickname":"JoaoSilva",
5
   "personType":"natural",
6
   "gender":"male",
7
   "maritalStatus":"married",
8
   "birthDate":"1980-07-15T03:00:00.000Z",
9
   "emails":[
10
      {
11
         "address":"[email protected]",
12
         "kind":"comercial"
13
      }
14
   ],
15
   "phones":[
16
      {
17
         "number":"5511999999999",
18
         "kind":"cellphone"
19
      }
20
   ],
21
   "addresses":[
22
      {
23
         "street":"Rua João da Silva Filho Junior",
24
         "number":"999",
25
         "complement":"Complemento",
26
         "neighborhood":"João da Silva Filho",
27
         "city":"São Paulo",
28
         "state":"SP",
29
         "zipCode":"12345-000",
30
         "country":{
31
            "id":"76",
32
            "name":"Brasil"
33
         },
34
         "kind":"residential",
35
         "geocode":[1200, 92929]
36
      }
37
   ],
38
   "documents":{
39
      "cpf":"111.111.111-11"
40
   }
41
}
42
​
Copied!
Atributos
CAMPO 
DESCRIÇÃO
id
Deve ser a chave única para identificação do customer e que será utilizada para updates futuros. Normalmente utilizado com dados de CPF ou CNPJ. 
Caso um mesmo customer seja informado com outro valor neste campo, o customer será DUPLICADO. Obrigatório
name 
(nome) Obrigatório
nickname 
(apelido) nome curto e fácil de recordar, pelo qual uma pessoa se identifica 
personType 
(Tipo pessoa). Dados suportados: natural/legal
gender 
(Sexo) Dados suportados: male/female
maritalStatus 
(Estado Civil) Dados suportados: married/divorced/widowed/single/clmarried/other
birthDate 
(Data Aniversário) formato suportado: 
yyyy-MM-ddThh:mm:ss.dddZ
emails
Lista dos e-mails do customer 
➢ address: deve estar como lower case. Obrigatório 
➢ kind: deve seguir o modelo tipo de contato. Obrigatório
emails.kind 
Identifica o tipo do e-mail. Os valores válidos são: 
➢ residential 
➢ comercial 
➢ other
emails.address
É o endereço de e-mail do destinatário da comunicação.
phones
Lista dos telefones do customer 
➢ number: deve estar no formato 551199999999. Obrigatório 
➢ Kind: deve seguir o modelo tipo de contato. Obrigatório
phones.kind 
Identifica o tipo do telefone. Os valores válidos são: 
➢ residential 
➢ comercial 
➢ cellphone 
➢ other
phones.address
É o número do telefone do destinatário. Para envio de comunicação esse número deve ser um celular.
addresses 
Lista dos endereços do customer 
➢ street, number, complement, neighborhood, city, devem estar previamente formatados corretamente. 
➢ state: deve possuir o valor da UF. 
➢ zipCode: deve estar no formato: 0000-000. 
➢ country.id: deve estar de acordo com a ISO 3166-1. Deve-se utilizar números inteiros (sem zero à esquerda). Obrigatório 
➢ country.name: nome do país. 
➢ kind: deve seguir o modelo tipo de contato. Obrigatório 
➢ geocode: deve ser latitude e longitude. 
addresses.street
Descrição do endereço (rua, Av, etc)
addresses.number
Número do endereço
addresses.complement
Complemento do endereço
addresses.neighborhood
Bairro
addresses.state
Sigla do estado
Campo files
O objetivo desse campo é informar para a plataforma como serão enviados os arquivos de uma determinada comunicação. Esse campo une informações dos campos Kit, Documents e Attachments
1
...
2
"files": [
3
           {
4
            "type": "storage",
5
            "mode": "Link",
6
            "isMain": true,
7
            "storagePath": "/meudiretorio",
8
            "filename": "fatura_directone.pdf",
9
            "description": "Boleto",
10
            "correlationId": "46299F1DF4C9C9CCEDB4D49DAE6C254",
11
            "dueDate": "1980-07-15T03:00:00.000Z",
12
            "documentNumber": "122545455",
13
            "tags": ["BOLETO", "1VIA"],
14
            "base64File": {
15
            "content": null,
16
            "contentType": null
17
            }
18
},
19
            {
20
            "type": "Base64",
21
            "mode": "link",
22
            "isMain": false,
23
            "filename": " test.txt",
24
            "description": "Carteirinha",
25
            "correlationId": "46299F1DF4C9C9CCEDB4D49DAE6C254",
26
            "base64File": {
27
            "content": "VGhpcyBpcyB5b3VyIGF0dGFjaGVkIGZpbGUhISEK",
28
            "contentType": "text/plain"
29
            }
30
}
Copied!
Atributos
​
CAMPO 
DESCRIÇÃO
type 
Indica a localização do arquivo, ou seja, onde ele está armazenado. Seu objetivo é permitir que a plataforma consiga enviar arquivos armazenados em qualquer fonte externa, como por exemplo um storage do cliente.
​
Nesta versão apenas os valores Storage e Base64 são suportados. O valor Storage indica para a plataforma que o arquivo está armazenado em nosso Storage Service que é um serviço de gerenciamento de arquivos. O valor Base64 indica que será utilizado o arquivo enviado em formato Base64 na requisição. 
mode
Indica a forma como o arquivo será disponibilizado dentro da comunicação. 
​

Attachment: o arquivo será anexado a comunicação caso o canal permita (e-mail, WhatsApp, RCS, etc) 
​

Link: O arquivo será enviado no corpo da comunicação como um URL. 
​

Info: Utilizando apenas para o serviço Customer.
isMain 
Indica que o arquivo é o arquivo principal dentro do conjunto de arquivos enviados, caso exista mais de um. 
​
Essa informação é importante para que a plataforma consiga identificar qual dos arquivos deverá ser enviado como link quando utilizamos a variável ${link_documento}
storagePath
É o caminho onde o documento está armazenado no storage. Esse campo deve ser informado apenas para quando o tipo for ‘Storage’ (type = ‘Storage’)
filename 
É o nome do arquivo. Esse nome será exibido no e-mail quando for um anexo ou será o nome que os navegadores utilizarão para salvá-lo em disco em caso de download.
description 
É uma descrição para o arquivo. Será utilizada para a feature de loop de documentos.
correlationId 
É uma chave de identificação única do arquivo e é utilizada para a realização do download
nodes 
Esse campo é opcional 
Deve ser utilizado quando houver necessidade de especificar para qual nó de canal o arquivo deve ser tratado e enviado.
 
Por exemplo: é possível parametrizar que um arquivo deve ser enviado para o canal de e-mail e outro para o canal de WhatsApp. 
Caso não seja informado, todos os arquivos serão anexados em todos os canais.
nodes.name
Indica em qual nó de canal o arquivo será disponibilizado. 
​
Exemplo: E-mail 2 (deve ser idêntico ao nome dado à comunicação dentro da jornada).
​

Attachment: O arquivo será anexado a comunicação caso o canal permita (e-mail, whatsapp, rcs, etc) 
Link: O arquivo será enviado no corpo da comunicação como um URL.
Campos tipo Base64File
CAMPO
DESCRIÇÃO
content
Arquivo em formato Base64. Obrigatório quando Type igual a base64.
contentType
ContentType do arquivo. Obrigatório quando Type igual a base64.
Campos tipo Date
É importante que todos os campos do tipo date sejam enviados utilizando o formato ISO-86001. 
O controle do fuso horário assim como o horário de verão é de responsabilidade de quem está chamando a API. 
Exemplo: 1980-07-15T03:00:00.000Z
Base64. Envio de comunicação com arquivo
Geração de documentos
Last modified 4mo ago
Copy link
Contents
Campos tipo Base64File
Campos tipo Date