Envio de comunicação

API para envio de comunicação por integração

Para realizar um disparo por integração é necessário que a API esteja autenticada. Também é necessário que uma jornada esteja corretamente configurada e ativa na plataforma.

Send

POST URL: https://apicore.d1.cx/journey/v1/send

Utilize estes parâmetros para envio de comunicações em ambiente de produção.

Headers

Name	Type	Description
Content-Type*	string	application/json
Authorization*	string	Bearer <OAUTH2-AUTHENTICATION-ACCESS_TOKEN>
TenantId*	string	<TENANT-ID> - Identifica a qual conta previamente cadastrada na aplicação deve ser utilizada. Essa informação é fornecida pela D1.

Name

Type

Description

Content-Type*

string

application/json

Authorization*

string

Bearer <OAUTH2-AUTHENTICATION-ACCESS_TOKEN>

TenantId*

string

<TENANT-ID> - Identifica a qual conta previamente cadastrada na aplicação deve ser utilizada. Essa informação é fornecida pela D1.

Request Body

Name	Type	Description
journeyId *	number	O objetivo desse campo é identificar para qual jornada serão enviadas as mensagens
customer*	string	Dados do cliente. Consulte o metadados
variables	string	Nomes e valores dos dados variáveis que compõem o conteúdo da comunicação. Os valores informados neste campo devem ser coerente com os valores configurados na plataforma
correlationId*	string	Seu comportamento é identificar de forma única um disparo
files	string	O objetivo desse campo é informar para a plataforma como serão enviados os arquivos de uma determinada comunicação
moviment	string	date: data filename: nome do arquivo lot: lote
documents	string	Campo para inserir informações para Geração de Documentos OnDemand correlationId: número do documento que será referenciado no retorno. maskid: nome da máscara utilizada para gerar o documento, esse valor é fornecido pela D1. Passe essa propriedade nula ou vazia para utilizar o ID da máscara configurado dentro da caixinha de documentos da jornada. sign: campo booleano que diz se o documento deve ser gerado assinado. passwordProtect: campo booleano que diz se o documento deve ser gerado com proteção por senha. Para o funcionamento desse campo combine o desenvolvimento do documento com a D1. fields: lista de valores utilizados para gerar o documento, esses campos são combinados com a D1 para gerar o documento e deve ser respeitado conforme implantação do projeto filename: define o nome do PDF a ser gerado. description: define a descrição do documento. documentNumber: define o número do documento. referenceDate: define a data de referência do documento. digitableLine: define a linha digitável do documento. total: define o total do documento. tags: define as tags do documento.
documents*	enum	mode: Link ou Attachment. Define o tipo de envio de documento.
documents*	datetime	dueDate: define a data do documento.
documents*	object	nodes: define as associações do documento aos nós da jornada.

Name

Type

Description

journeyId *

number

O objetivo desse campo é identificar para qual jornada serão enviadas as mensagens

customer*

string

Dados do cliente. Consulte o metadados

variables

string

Nomes e valores dos dados variáveis que compõem o conteúdo da comunicação. Os valores informados neste campo devem ser coerente com os valores configurados na plataforma

correlationId*

string

Seu comportamento é identificar de forma única um disparo

files

string

O objetivo desse campo é informar para a plataforma como serão enviados os arquivos de uma determinada comunicação

moviment

string

date: data filename: nome do arquivo lot: lote

documents

string

Campo para inserir informações para Geração de Documentos OnDemand

correlationId: número do documento que será referenciado no retorno.

maskid: nome da máscara utilizada para gerar o documento, esse valor é fornecido pela D1. Passe essa propriedade nula ou vazia para utilizar o ID da máscara configurado dentro da caixinha de documentos da jornada.

sign: campo booleano que diz se o documento deve ser gerado assinado. passwordProtect: campo booleano que diz se o documento deve ser gerado com proteção por senha. Para o funcionamento desse campo combine o desenvolvimento do documento com a D1. fields: lista de valores utilizados para gerar o documento, esses campos são combinados com a D1 para gerar o documento e deve ser respeitado conforme implantação do projeto

filename: define o nome do PDF a ser gerado. description: define a descrição do documento.

documentNumber: define o número do documento.

referenceDate: define a data de referência do documento.

digitableLine: define a linha digitável do documento.

total: define o total do documento. tags: define as tags do documento.

documents*

enum

mode: Link ou Attachment. Define o tipo de envio de documento.

documents*

datetime

dueDate: define a data do documento.

documents*

object

nodes: define as associações do documento aos nós da jornada.

Atributos:

trackingId: identificação do disparo dentro da plataforma.

correlationId: valor informado para o campo correlationId durante o request.

{ 
    "trackingId": "354AA76D7FF852D28A569754775EE58E27B53D54142D026981B8351FDC2B7503", 
    "correlationId": "cb526980-8f35-4a06-9c8f-c9f332765f0a" 
}

Atributos:

type: sempre será “about:blank”

title: sempre será “BadRequest”

status: sempre será 400

detail: conterá informações detalhadas sobre o erro

{ 
    "type": "about:blank", 
    "title": "BadRequest" 
    "status": 400 
    "detail": "detalhes sobre o erro" 
    "instance": "/v1/send" 
}

Body de exemplo

{
   "journeyId":"6005ea19c8405099a65ac58b",
   "customer":{
      "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":"journey@d1.cx",
            "kind":"comercial"
         }
      ],
      "phones":[
         {
            "number":"551199999999",
            "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":"492.087.278-07"
      }
   },
   "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"
   },
   "movement":{
      "date":"1980-07-15T03:00:00.000Z",
      "filename":"1",
      "lot":"1"
   },
   "correlationId":"46299F1DF4C9C9CCEDB4D49DAE6C254",
   "files":[
      {
         "type":"Storage",
         "mode":"Link",
         "isMain":true,
         "storagePath":"/meudiretorio",
         "filename":"fatura_directone.pdf",
         "description":"Boleto",
         "correlationId":"46299F1DF4C9C9CCEDB4D49DAE6C254",
         "dueDate":"1980-07-15T03:00:00.000Z",
         "documentNumber":"122545455",
         "tags":[
            "BOLETO",
            "1VIA"
         ]
      },
      {
         "type":"storage",
         "mode":"link",
         "isMain":false,
         "filename":"carteirinha_directone.pdf",
         "description":"Carteirinha",
         "correlationId":"46299F1DF4C9C9CCEDB4D49DAE6C254"
      }
   ],
   "documents":[
      {
         "correlationId":"345OIGDF98345T",
         "maskId":"fatura_reportmodelo",
         "sign":true,
         "passwordProtect":false,
         "fields":{
            "linkBoleto":"https://boletoonline.acme.gov.br/imprimir/",
            "digital1":"012345678901234",
            "digital2":"01234567890123401234567890134",
            "primeiro_nome":"Transferência Boleto",
            "proposta":"0123456",
            "doc_total":"15,37",
            "link":"https://lnk.acme.io/",
            "vencimento":"1980-12-31T23:59:59.000Z",
            "nomeVendedor":"Rua João da Silva Filho",
            "cartao":"super cartao",
            "celularVendedor":"551199999999"
         "filename":"Zenvia123",
         "mode": "https://docs.jornadas.d1.cx/apis",
         "description":"Boleto",
         "documentNumber":"59599595",
         "referenceDate":"03/2023",
         "digitableLine""01234567890123401234567890134",
         "dueDate":""1980-12-31T23:59:59.000Z",
         "Total":"5",
         "tag": [
         "NOME DA TAG"
         ],
         "nodes" : [
         {
         "name": "E-mail 1",
         "mode": "Attachment"
         },
         {
         "name": "SMS 2",
         "mode": "Link"
         }
      }
   ],
   "properties": {
        "chave1": "valor chave 1",
        "chave2": "valor chave 2"
    }
}

PreviousOAuth2 Authentication NextAPI Reenvio de Documento

Last updated 1 year ago