CodeChat API Go Pro

Envia PIX

Pro

POSThttp://localhost:8084/instance/{instance}/send/pix

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header: Authorization
Exemplo: Bearer <INSTANCE_TOKEN>

Parâmetros

instancepathobrigatório

string

Nome público da instância

minLength 1

Request body

obrigatório

bodyoneOf

numberstring

Telefone ou JID do destinatário

chatstring

Alias de destinatário

recipientstring

Alias de destinatário

pixMessageobjectobrigatório

presentationobjectobrigatório

titlestringmaxLength: 1024

descriptionstringobrigatóriominLength: 1 · maxLength: 4096

footerstringmaxLength: 1024

keyTypeenum<CPF | CNPJ | EVP | EMAIL | PHONE>obrigatório

keystringobrigatóriominLength: 1 · maxLength: 4096

merchantNamestringobrigatóriominLength: 1 · maxLength: 255

referenceIdstringmaxLength: 255

mediaUploadIdintegermín: 1

optionsobject

delayintegermín: 0 · máx: 120000

presenceenum<composing | recording | paused>

quotedMessageIdstring

quotedMessageobject

externalAttributesobject

mentionAllbooleanpadrão: false

opção 1any

opção 2any

opção 3any

Exemplo JSONgerado do schema

"string"

Respostas

application/json

200

PIX enviado

response 200object

idintegerobrigatório

keyIdstringobrigatório

keyRemoteJidstring | nullobrigatório

keyLidstring | nullobrigatório

keyFromMebooleanobrigatório

keyParticipantstring | nullobrigatório

keyParticipantLidstring | nullobrigatório

pushNamestring | nullobrigatório

messageTypestringobrigatório

contentanyobrigatório

messageTimestampintegerobrigatório

deviceenum<ios | android | web | unknown | desktop>obrigatório

isGroupboolean | nullobrigatório

instanceIdintegerobrigatório

metadataany

externalAttributesobject

Exemplo 200gerado do schema

{
  "id": 1,
  "keyId": "string",
  "keyRemoteJid": "[email protected]",
  "keyLid": "string",
  "keyFromMe": true,
  "keyParticipant": "string",
  "keyParticipantLid": "string",
  "pushName": "CodeChat",
  "messageType": "Olá! Esta é uma mensagem de exemplo da CodeChat.",
  "content": "string",
  "messageTimestamp": 1,
  "device": "ios",
  "isGroup": true,
  "instanceId": 1,
  "metadata": "string",
  "externalAttributes": {}
}