Metadados envio de comunicação
Aqui você irá encontrar um modelo dos parâmetros do customer, que deverão ser encaminhados à Zenvia para o envio das comunicações.
Customer é um objeto que representa o cliente dentro da plataforma.
{
"id": "111.111.111-11",
"name": "João da Silva",
"nickname": "JoaoSilva",
"personType": "natural",
"gender": "male",
"maritalStatus": "married",
"birthDate": "1980-07-15T03:00:00.000Z",
"emails": [
{
"address": "[email protected]",
"kind": "comercial"
}
],
"phones": [
{
"number": "5511999999999",
"kind": "cellphone"
}
],
"addresses": [
{
"street": "Rua João da Silva Filho Junior",
"number": "999",
"complement": "Complemento",
"neighborhood": "João da Silva Filho",
"city": "São Paulo",
"state": "SP",
"zipCode": "12345-000",
"country": {
"id": "76",
"name": "Brasil"
},
"kind": "residential",
"geocode": [
1200,
92929
]
}
],
"documents": {
"cpf": "111.111.111-11"
}
}
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 suportado (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 |
addresses.zipCode | Número do CEP |
addresses.country.id | Identificação do país de acordo com a ISO 3166-1. Deve-se utilizar números inteiros (sem zero à esquerda) |
addresses.country.name | Nome do país |
addresses.kind | Identifica o tipo do endereço. Os valores válidos são:
➢ residential
➢ comercial
➢ other |
addresses.geocode | Informação de geolocalização do cliente |
documents | Lista dos documentos do customer, formato suportado:
{“chave”: “valor”}
|
{
"type": "storage",
"mode": "Attachment", -> (Attachment e Link).
"isMain": true,
"filename": "fatura directone",
"description": "Fatura A",
"correlationId": "46299F1DF4C9C9CCEDB4D49DAE6C254",
"nodes": [
{
"name": "E-mail 2", -> Nome do canal.
"mode": "Attachment"
}
]
}
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 o valor Storage é suportado. Esse valor indica para a plataforma que o arquivo está armazenado em nosso Storage Service que é um serviço de gerenciamento de arquivos. |
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 é 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. |
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
"variables":{
"var_linkBoleto":"https://boletoonline.acme.gov.br/imprimir/",
"var_digital1":"012345678901234",
"var_digital2":"01234567890123401234567890134",
"var_primeiro_nome":"Transferência Boleto",
"var_proposta":"0123456",
"var_doc_total":"15,37",
"var_link":"https://lnk.acme.io/",
"var_vencimento":"1980-12-31T23:59:59.000Z",
"var_nomeVendedor":"Rua João da Silva Filho",
"var_cartao":"super cartao",
"var_celularVendedor":"551199999999"
}
CAMPO | DESCRIÇÃO |
variables | Campo responsável por enviar parâmetros que serão utilizados na composição dos templates. Formato suportado: {"chave": "valor"}.
Todas as variáveis, obrigatoriamente ,devem ter seu nome iniciado com o prefixo "var_". |
Last modified 7mo ago