Webchat
Abrir (ou retomar) sessão de visitante
Abre a sessão de um visitante do seu sistema. Com externalId (o id do usuário no seu sistema), a mesma pessoa volta sempre para a mesma sessão e o mesmo contato — inclusive depois de encerrada.
visitor preenche os dados iniciais (nome, telefone, e-mail, CPF, empresa); params segue o mapeamento de parâmetros do webchat (utm, gclid, campos personalizados). Dado inválido não é gravado e volta em invalidFields.
A resposta traz um visitorToken: com ele o seu front pode conectar no tempo real (/webchat, Socket.IO, auth: { token }) sem expor o token da API.
POST
/
webchat
/
{slug}
/
sessions
Abrir (ou retomar) sessão de visitante
curl --request POST \
--url https://api.connectadesk.com/api/v1/webchat/{slug}/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "usuario-1029",
"visitor": {
"name": "Maria Souza",
"email": "maria@email.com"
},
"params": {
"utm_source": "google",
"utm_campaign": "black-friday"
}
}
'import requests
url = "https://api.connectadesk.com/api/v1/webchat/{slug}/sessions"
payload = {
"externalId": "usuario-1029",
"visitor": {
"name": "Maria Souza",
"email": "maria@email.com"
},
"params": {
"utm_source": "google",
"utm_campaign": "black-friday"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: 'usuario-1029',
visitor: {name: 'Maria Souza', email: 'maria@email.com'},
params: {utm_source: 'google', utm_campaign: 'black-friday'}
})
};
fetch('https://api.connectadesk.com/api/v1/webchat/{slug}/sessions', 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.connectadesk.com/api/v1/webchat/{slug}/sessions",
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([
'externalId' => 'usuario-1029',
'visitor' => [
'name' => 'Maria Souza',
'email' => 'maria@email.com'
],
'params' => [
'utm_source' => 'google',
'utm_campaign' => 'black-friday'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.connectadesk.com/api/v1/webchat/{slug}/sessions"
payload := strings.NewReader("{\n \"externalId\": \"usuario-1029\",\n \"visitor\": {\n \"name\": \"Maria Souza\",\n \"email\": \"maria@email.com\"\n },\n \"params\": {\n \"utm_source\": \"google\",\n \"utm_campaign\": \"black-friday\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.connectadesk.com/api/v1/webchat/{slug}/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"usuario-1029\",\n \"visitor\": {\n \"name\": \"Maria Souza\",\n \"email\": \"maria@email.com\"\n },\n \"params\": {\n \"utm_source\": \"google\",\n \"utm_campaign\": \"black-friday\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/webchat/{slug}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"usuario-1029\",\n \"visitor\": {\n \"name\": \"Maria Souza\",\n \"email\": \"maria@email.com\"\n },\n \"params\": {\n \"utm_source\": \"google\",\n \"utm_campaign\": \"black-friday\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"session": {
"id": "1b0f9a52-3c8e-4f0e-9d1c-6a1c0e7b2f44",
"status": "open",
"ticketId": 5120,
"contactId": 842,
"visitor": {
"name": "Maria Souza"
},
"askFields": [],
"requiredFields": []
},
"visitorToken": "<string>",
"visitorTokenExpiresAt": "2023-11-07T05:31:56Z",
"invalidFields": [
"<string>"
]
}
}{
"error": {
"code": "ERR_API_UNAUTHORIZED",
"message": "Token de API ausente ou inválido."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois."
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}Autorizações
Token da API no formato sk_live_….
Parâmetros de caminho
Corpo
application/json
Resposta
Criada ou retomada
Show child attributes
Show child attributes
⌘I
Abrir (ou retomar) sessão de visitante
curl --request POST \
--url https://api.connectadesk.com/api/v1/webchat/{slug}/sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "usuario-1029",
"visitor": {
"name": "Maria Souza",
"email": "maria@email.com"
},
"params": {
"utm_source": "google",
"utm_campaign": "black-friday"
}
}
'import requests
url = "https://api.connectadesk.com/api/v1/webchat/{slug}/sessions"
payload = {
"externalId": "usuario-1029",
"visitor": {
"name": "Maria Souza",
"email": "maria@email.com"
},
"params": {
"utm_source": "google",
"utm_campaign": "black-friday"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: 'usuario-1029',
visitor: {name: 'Maria Souza', email: 'maria@email.com'},
params: {utm_source: 'google', utm_campaign: 'black-friday'}
})
};
fetch('https://api.connectadesk.com/api/v1/webchat/{slug}/sessions', 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.connectadesk.com/api/v1/webchat/{slug}/sessions",
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([
'externalId' => 'usuario-1029',
'visitor' => [
'name' => 'Maria Souza',
'email' => 'maria@email.com'
],
'params' => [
'utm_source' => 'google',
'utm_campaign' => 'black-friday'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.connectadesk.com/api/v1/webchat/{slug}/sessions"
payload := strings.NewReader("{\n \"externalId\": \"usuario-1029\",\n \"visitor\": {\n \"name\": \"Maria Souza\",\n \"email\": \"maria@email.com\"\n },\n \"params\": {\n \"utm_source\": \"google\",\n \"utm_campaign\": \"black-friday\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.connectadesk.com/api/v1/webchat/{slug}/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"usuario-1029\",\n \"visitor\": {\n \"name\": \"Maria Souza\",\n \"email\": \"maria@email.com\"\n },\n \"params\": {\n \"utm_source\": \"google\",\n \"utm_campaign\": \"black-friday\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/webchat/{slug}/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"usuario-1029\",\n \"visitor\": {\n \"name\": \"Maria Souza\",\n \"email\": \"maria@email.com\"\n },\n \"params\": {\n \"utm_source\": \"google\",\n \"utm_campaign\": \"black-friday\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"session": {
"id": "1b0f9a52-3c8e-4f0e-9d1c-6a1c0e7b2f44",
"status": "open",
"ticketId": 5120,
"contactId": 842,
"visitor": {
"name": "Maria Souza"
},
"askFields": [],
"requiredFields": []
},
"visitorToken": "<string>",
"visitorTokenExpiresAt": "2023-11-07T05:31:56Z",
"invalidFields": [
"<string>"
]
}
}{
"error": {
"code": "ERR_API_UNAUTHORIZED",
"message": "Token de API ausente ou inválido."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois."
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}
