Updated: 31 January 2023

Enviar Imagem

ENDPOINT /V2/Ativo
METHOD POST
PARAMETERS TYPE DEMANDED NOTES
CarteiraId int Obrigatório
WalletCode string Opcional Poder ser enviado walletCode ou carteiraId, codigo externo da carteira
MessageText string Obrigatório base64 (data:image/png)
FileName
string Obrigátorio Indica o nome do arquivo com extessão    meuarquivo.jpg
AddicionalData json Opcional
MessageType int Obrigatório

Enviar valor 2

Caption string Opcional Texto com a descrição da imagem
ClientPhone string Obrigatório
ExternalId
string Opcional

Informar um código do cliente utilizado no sistema do contratante. Será retornado em Webhook.

SourceId int Opcional

Active = 1(default),   Client = 2,  Chat = 3,  Mailing = 4,  Bot = 6

Expires
date Opcional
formato mm-dd-yyyy hh:mm:ss
Schedule
date Opcional
formato mm-dd-yyyy hh:mm:ss
RETURN TYPE DEMANDED NOTES
success bool

message string

data json







(1) IDENTIFICAÇÃO DO CLIENTE: para identificar um cliente, é possível enviar apenas um dentre:

  • ClientPhone: string - que contenha o DDI (55 - para o Brasil), DDD e TELEFONE.
  • ClientId: int - que seja um cliente previamente criado na carteira. (corresponde univocamente a um telefone - se informado junto com o telefone, será priorizado o telefone).


SEND - EXAMPLE

{  
  "ClientPhone": "5519999999999",
  "CarteiraId": 278,
  "MessageType"; 2
  "MessageText": "data:image/png;base64,iVBORw0K...",  
  "SourceId":1,
  "Caption": "Mensagem descrição",
  "Expires":"01-30-2023 10:58:22",
  "Schedule":"01-28-2023 10:58:22" 
}


RECEIVE EXAMPLE

{
    "success": true,
    "message": "Ativo enviado para processamento!",
    "data": {  }
}


RECEIVE EXAMPLE

{
    "success": false,
    "message": "Carteira é obrigatório"
}