Skip to main content
POST
/
api
/
conversation
Send Conversation
curl --request POST \
  --url https://api.plazbot.com/api/conversation \
  --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",
  "variablesBody": [
    {
      "variable": "string",
      "value": "string"
    }
  ],
  "variablesHeader": [
    {
      "variable": "string",
      "value": "string"
    }
  ],
  "file": {
    "fileUrl": "https://storage-files.....image.png",
    "fileName": "Imagen_ventas_1.png"
  }
}
'
{
  "success": true,
  "message": "Conversation sent successfully.",
  "code": 200,
  "data": {
    "contactId": "string"
  }
}

Headers

​
x-workspace-id
string
required

Body

application/json
​
workspaceId
string
required

Workspace ID

​
template
string
required

Nombre de la plantilla a usar.

​
destination
string
required

Numero de Whatsapp del cliente.

​
reference1
string

Valor de referencia 1. Los valores de referencia son campos adicionales que puedes utilizar para almacenar información relevante sobre el mensaje o la conversación. Estos campos pueden ser útiles para categorizar, filtrar o buscar mensajes en función de ciertos criterios. Estos campos los puedes usar tambien en el webhook de la plantilla cuando el cliente haga clic en algun botón interactivo.

​
reference2
string

Valor de referencia 2.

​
reference3
string

Valor de referencia 3.

​
variablesHeader
object[]
​
variablesBody
object[]
​
file
object[]
​
sendType
string | null

1: Campaign | 2: Individual | 3: API. Por default: 3 API

​
campaignName
string | null

Se puede enviar en caso sea API y Campaign.

Response

200 - application/json

OK

​
success
boolean
required
​
message
string
required
​
code
integer
required
​
data
object
required