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>"
}
'
import requests

url = "https://api.plazbot.com/api/conversation"

payload = {
    "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>"
}
headers = {
    "x-workspace-id": "<x-workspace-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-workspace-id': '<x-workspace-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'
  })
};

fetch('https://api.plazbot.com/api/conversation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.plazbot.com/api/conversation",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plazbot.com/api/conversation"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"template\": \"<string>\",\n  \"destination\": \"<string>\",\n  \"reference1\": \"<string>\",\n  \"reference2\": \"<string>\",\n  \"reference3\": \"<string>\",\n  \"variablesHeader\": [\n    {\n      \"variable\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"variablesBody\": [\n    {\n      \"variable\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"file\": [\n    {\n      \"fileUrl\": \"<string>\",\n      \"fileName\": \"<string>\"\n    }\n  ],\n  \"sendType\": \"<string>\",\n  \"campaignName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-workspace-id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.plazbot.com/api/conversation")
  .header("x-workspace-id", "<x-workspace-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"template\": \"<string>\",\n  \"destination\": \"<string>\",\n  \"reference1\": \"<string>\",\n  \"reference2\": \"<string>\",\n  \"reference3\": \"<string>\",\n  \"variablesHeader\": [\n    {\n      \"variable\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"variablesBody\": [\n    {\n      \"variable\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"file\": [\n    {\n      \"fileUrl\": \"<string>\",\n      \"fileName\": \"<string>\"\n    }\n  ],\n  \"sendType\": \"<string>\",\n  \"campaignName\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.plazbot.com/api/conversation")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"template\": \"<string>\",\n  \"destination\": \"<string>\",\n  \"reference1\": \"<string>\",\n  \"reference2\": \"<string>\",\n  \"reference3\": \"<string>\",\n  \"variablesHeader\": [\n    {\n      \"variable\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"variablesBody\": [\n    {\n      \"variable\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"file\": [\n    {\n      \"fileUrl\": \"<string>\",\n      \"fileName\": \"<string>\"\n    }\n  ],\n  \"sendType\": \"<string>\",\n  \"campaignName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {
    "contactId": "<string>"
  }
}
{
  "success": true,
  "code": 123,
  "message": "<string>",
  "errorCode": "<string>"
}
{
  "success": true,
  "code": 123,
  "message": "<string>",
  "errorCode": "<string>"
}
{
  "success": true,
  "code": 123,
  "message": "<string>",
  "errorCode": "<string>"
}
{
  "success": true,
  "code": 123,
  "message": "<string>",
  "errorCode": "<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