Como podemos ajudar?

  1. Página inicial
  2. Voltar para a pesquisa
  3. Outros Produtos Zenvia
  4. 11. Docs
  5. 04. APIs
05. Base64: Envio de comunicação com arquivo
11 min
Criado por MT em 15/02/2023 14:25
Atualizado por Leonora Alves em 01/04/2024 16:08

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. Esta é a API para envio de comunicação com arquivo em Base64.

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

Envio de comunicação com arquivo em Base64

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

Parameters


Header

Content-Type string application/json
Authorization string Bearer [OAUTH2-AUTHENTICATION-AC]
TenantId string [TENANT-ID] - Identifica a qual conta previamente cadastrada na aplicação deve ser utilizada. Essa informação é fornecida pela D1.

 

Body

journeyId string Identifica para qual jornada será enviado as mensagens
customer string Dados do cliente. Consulte o metadados​.
variables string Lista das variáveis
correlationId string Identifica de forma única um disparo
moviment string ➢ date: data
➢ filename: nome do arquivo
➢ lot: lote


Responses

🟢 204: No Content  Solicitação bem sucedida

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"
}

 

Responses

🟠 400: Bad  Request Erro

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/sendFile"
}


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"
       }
     }
  ],
  "properties": {
    "chave1": "valor chave 1",
    "chave2": "valor chave 2"
   }
 }