Skip to main content
POST
/
api
/
conversation
Enviar Conversacion
curl --request POST \
  --url https://api.plazbot.com/api/conversation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "workspaceId": "<string>",
  "template": "<string>",
  "destination": "<string>",
  "reference1": "<string>",
  "reference2": "<string>",
  "reference3": "<string>",
  "variablesHeader": [
    {
      "variable": "<string>",
      "value": "<string>"
    }
  ],
  "variablesBody": [
    {
      "variable": "<string>",
      "value": "<string>"
    }
  ],
  "file": [
    {
      "fileUrl": "<string>",
      "fileName": "<string>"
    }
  ],
  "sendType": "<string>",
  "campaignName": "<string>"
}
'
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {
    "contactId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login

Headers

x-workspace-id
string
required

Identificador del workspace

Body

application/json
workspaceId
string
required

Identificador del workspace

template
string
required

Nombre de la plantilla a utilizar

destination
string
required

Numero de WhatsApp del destinatario (ej: 574787443997)

reference1
string | null

Valor de referencia 1. Campos adicionales para almacenar informacion relevante sobre el mensaje. Utiles para categorizar, filtrar o buscar mensajes. Tambien se pueden usar en el webhook de la plantilla cuando el cliente hace clic en un boton interactivo.

reference2
string | null

Valor de referencia 2

reference3
string | null

Valor de referencia 3

variablesHeader
object[]

Variables para el encabezado de la plantilla

variablesBody
object[]

Variables para el cuerpo de la plantilla

file
object[]

Archivos a enviar con la plantilla

sendType
string | null

Tipo de envio: 1=Campana, 2=Individual, 3=API. Por defecto: 3 (API)

campaignName
string | null

Nombre de la campana. Se puede enviar para tipo API y Campana.

Response

Conversacion enviada exitosamente

success
boolean
required

Indica si la operacion fue exitosa

code
integer
required

Codigo HTTP de la respuesta

errorCode
string | null
required

Codigo de error, null si no hay error

message
string
required

Mensaje descriptivo del resultado

data
object
required