Start Preview Chat

curl --request POST \
  --url https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat

const options = {method: 'POST'};

fetch('https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat', 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://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "typebot": {
    "id": "<string>",
    "theme": "<any>",
    "settings": "<any>"
  },
  "messages": [
    {
      "id": "<string>",
      "type": "<string>",
      "content": "<any>"
    }
  ],
  "input": {
    "id": "<string>",
    "outgoingEdgeId": "<string>",
    "type": "<string>",
    "options": "<string>"
  }
}

POST

api

typebots

{sessionId}

preview

startChat

Start Preview Chat

curl --request POST \
  --url https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat

const options = {method: 'POST'};

fetch('https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat', 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://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://bots-viewer.toolzz.ai/api/v1/typebots/{sessionId}/preview/startChat")

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

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "typebot": {
    "id": "<string>",
    "theme": "<any>",
    "settings": "<any>"
  },
  "messages": [
    {
      "id": "<string>",
      "type": "<string>",
      "content": "<any>"
    }
  ],
  "input": {
    "id": "<string>",
    "outgoingEdgeId": "<string>",
    "type": "<string>",
    "options": "<string>"
  }
}

Parameters

string

typebotId: The public ID of the bot to start a preview chat for.

Response Description

Below you will see the description of the function start preview chat.

string

required

Unique identifier of the preview session.

object

required

The Bot information setted.

Show typebot properties

string

required

Unique identifier for bot.

any

The visual appearance information of the bot.

any

The pre settings information of the bot.

object[]

required

The messages content and information in the bot session.

Show messages properties

string

required

Unique identifier for the messages of the session.

string

The format of the message sent.

any

The content of the message sent.

object{}

required

The bot input informations.

Show input properties

string

required

Unique identifier for the inputs of the session.

string

Unique identifier of the edge that leads out from a specific input block in your bot flow.

string

The type of content sent.

string

The type of content sent.

Show options properties

object

The unique identifier of the variable that will store the user’s selection from those options.

​Parameters

​Response Description

Parameters

Response Description