Settings Typebot

Change Session Status

curl --request POST \
  --url https://{server-url}/typebot/settings/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "expire": "<string>",
  "keywordFinish": "<string>",
  "delayMessage": "<string>",
  "unknownMessage": "<string>",
  "listeningFromMe": "<string>",
  "stopBotFromMe": "<string>",
  "keepOpen": "<string>",
  "debounceTime": "<string>",
  "ignoreJids": "<string>",
  "typebotIdFallback": "<string>"
}
'

import requests

url = "https://{server-url}/typebot/settings/{instance}"

payload = {
    "expire": "<string>",
    "keywordFinish": "<string>",
    "delayMessage": "<string>",
    "unknownMessage": "<string>",
    "listeningFromMe": "<string>",
    "stopBotFromMe": "<string>",
    "keepOpen": "<string>",
    "debounceTime": "<string>",
    "ignoreJids": "<string>",
    "typebotIdFallback": "<string>"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expire: '<string>',
    keywordFinish: '<string>',
    delayMessage: '<string>',
    unknownMessage: '<string>',
    listeningFromMe: '<string>',
    stopBotFromMe: '<string>',
    keepOpen: '<string>',
    debounceTime: '<string>',
    ignoreJids: '<string>',
    typebotIdFallback: '<string>'
  })
};

fetch('https://{server-url}/typebot/settings/{instance}', 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://{server-url}/typebot/settings/{instance}",
  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([
    'expire' => '<string>',
    'keywordFinish' => '<string>',
    'delayMessage' => '<string>',
    'unknownMessage' => '<string>',
    'listeningFromMe' => '<string>',
    'stopBotFromMe' => '<string>',
    'keepOpen' => '<string>',
    'debounceTime' => '<string>',
    'ignoreJids' => '<string>',
    'typebotIdFallback' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$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://{server-url}/typebot/settings/{instance}"

	payload := strings.NewReader("{\n  \"expire\": \"<string>\",\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": \"<string>\",\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": \"<string>\",\n  \"stopBotFromMe\": \"<string>\",\n  \"keepOpen\": \"<string>\",\n  \"debounceTime\": \"<string>\",\n  \"ignoreJids\": \"<string>\",\n  \"typebotIdFallback\": \"<string>\"\n}")

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

	req.Header.Add("apikey", "<api-key>")
	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://{server-url}/typebot/settings/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expire\": \"<string>\",\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": \"<string>\",\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": \"<string>\",\n  \"stopBotFromMe\": \"<string>\",\n  \"keepOpen\": \"<string>\",\n  \"debounceTime\": \"<string>\",\n  \"ignoreJids\": \"<string>\",\n  \"typebotIdFallback\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/typebot/settings/{instance}")

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

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expire\": \"<string>\",\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": \"<string>\",\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": \"<string>\",\n  \"stopBotFromMe\": \"<string>\",\n  \"keepOpen\": \"<string>\",\n  \"debounceTime\": \"<string>\",\n  \"ignoreJids\": \"<string>\",\n  \"typebotIdFallback\": \"<string>\"\n}"

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

This response has no body data.

POST

typebot

settings

{instance}

Change Session Status

curl --request POST \
  --url https://{server-url}/typebot/settings/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "expire": "<string>",
  "keywordFinish": "<string>",
  "delayMessage": "<string>",
  "unknownMessage": "<string>",
  "listeningFromMe": "<string>",
  "stopBotFromMe": "<string>",
  "keepOpen": "<string>",
  "debounceTime": "<string>",
  "ignoreJids": "<string>",
  "typebotIdFallback": "<string>"
}
'

import requests

url = "https://{server-url}/typebot/settings/{instance}"

payload = {
    "expire": "<string>",
    "keywordFinish": "<string>",
    "delayMessage": "<string>",
    "unknownMessage": "<string>",
    "listeningFromMe": "<string>",
    "stopBotFromMe": "<string>",
    "keepOpen": "<string>",
    "debounceTime": "<string>",
    "ignoreJids": "<string>",
    "typebotIdFallback": "<string>"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expire: '<string>',
    keywordFinish: '<string>',
    delayMessage: '<string>',
    unknownMessage: '<string>',
    listeningFromMe: '<string>',
    stopBotFromMe: '<string>',
    keepOpen: '<string>',
    debounceTime: '<string>',
    ignoreJids: '<string>',
    typebotIdFallback: '<string>'
  })
};

fetch('https://{server-url}/typebot/settings/{instance}', 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://{server-url}/typebot/settings/{instance}",
  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([
    'expire' => '<string>',
    'keywordFinish' => '<string>',
    'delayMessage' => '<string>',
    'unknownMessage' => '<string>',
    'listeningFromMe' => '<string>',
    'stopBotFromMe' => '<string>',
    'keepOpen' => '<string>',
    'debounceTime' => '<string>',
    'ignoreJids' => '<string>',
    'typebotIdFallback' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$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://{server-url}/typebot/settings/{instance}"

	payload := strings.NewReader("{\n  \"expire\": \"<string>\",\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": \"<string>\",\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": \"<string>\",\n  \"stopBotFromMe\": \"<string>\",\n  \"keepOpen\": \"<string>\",\n  \"debounceTime\": \"<string>\",\n  \"ignoreJids\": \"<string>\",\n  \"typebotIdFallback\": \"<string>\"\n}")

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

	req.Header.Add("apikey", "<api-key>")
	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://{server-url}/typebot/settings/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expire\": \"<string>\",\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": \"<string>\",\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": \"<string>\",\n  \"stopBotFromMe\": \"<string>\",\n  \"keepOpen\": \"<string>\",\n  \"debounceTime\": \"<string>\",\n  \"ignoreJids\": \"<string>\",\n  \"typebotIdFallback\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/typebot/settings/{instance}")

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

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expire\": \"<string>\",\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": \"<string>\",\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": \"<string>\",\n  \"stopBotFromMe\": \"<string>\",\n  \"keepOpen\": \"<string>\",\n  \"debounceTime\": \"<string>\",\n  \"ignoreJids\": \"<string>\",\n  \"typebotIdFallback\": \"<string>\"\n}"

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

This response has no body data.

Authorizations

apikey

string

header

required

Your authorization key header

Path Parameters

instance

string

required

Name of the instance

Body

application/json

expire

string

required

Time to expire session bot

keywordFinish

string

required

Keyword to finished session

delayMessage

string

required

Delay when the bot send message

unknownMessage

string

required

Unrecognized message

listeningFromMe

string

required

stopBotFromMe

string

required

Stop bot when I send message

keepOpen

string

required

Keep session open

debounceTime

string

required

Time

ignoreJids

string

required

Jids ignore from bot

typebotIdFallback

string

required

Id fallback

Response

200

Início

Instances

Webhook

Settings

Send Message

Chat Controller

Profile Settings

Group Controller

Typebot

OpenAI

Evolution Bot

Dify

n8n

EvoAI

Flowise

Chatwoot

Websocket

SQS

RabbitMQ

Authorizations

Path Parameters

Body

Response