Jornadas
Searchā€¦
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