Channels
Read webchat installation and configuration
Use only for a discovered webchat channel. Returns the existing native public URL, installation snippet, widget configuration and setupState. The human installs the snippet on their website; no OAuth is needed. snippet_not_installed and firstSeenAt/lastSeenAt are installation evidence, not guest message delivery. Requires a current admin-owned credential to reuse the protected native setup reader. Requires channels:read.
GET
/
channels
/
{channelId}
/
webchat
Read webchat installation and configuration
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat', 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://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"channelId": "<string>",
"setupState": "<string>",
"availability": {
"available": true,
"tenantSlug": "<string>",
"reason": "<string>"
},
"settings": {
"themeColorHex": "<string>",
"launcherLabel": "<string>",
"headerTitle": "<string>",
"side": "<string>",
"sizePreset": "<string>",
"showLauncherLabel": true,
"showPoweredByBranding": true,
"bottomOffsetPx": 123,
"prechat": {
"enabledFields": {
"name": true,
"email": true,
"phone": true
},
"requirementMode": "<string>",
"validationPolicy": "<string>"
},
"starterPrompts": {
"mode": "<string>"
},
"launcherAction": {
"mode": "<string>",
"targetChannelId": "<string>",
"whatsappPrefillText": "<string>"
}
},
"brandingRemoval": {
"canHide": true,
"requiredTier": "<string>"
},
"launcherActionResolved": {
"type": "<string>",
"icon": "<string>",
"url": "<string>",
"fallbackReason": "<string>"
},
"publicUrl": "<string>",
"tenantSlug": "<string>",
"scriptUrl": "<string>",
"embedUrl": "<string>",
"installSnippet": "<string>",
"firstSeenAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}Autorizaciones
Server-side tenant-scoped credential created from Build > API Keys.
Parámetros de ruta
Stored channel.id from list_channels or get_channel. Provider page, phone, account and WABA IDs are not this ID.
Pattern:
^[a-fA-F0-9]{24}$Respuesta
Read webchat installation and configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Read webchat installation and configuration
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat', 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://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"channelId": "<string>",
"setupState": "<string>",
"availability": {
"available": true,
"tenantSlug": "<string>",
"reason": "<string>"
},
"settings": {
"themeColorHex": "<string>",
"launcherLabel": "<string>",
"headerTitle": "<string>",
"side": "<string>",
"sizePreset": "<string>",
"showLauncherLabel": true,
"showPoweredByBranding": true,
"bottomOffsetPx": 123,
"prechat": {
"enabledFields": {
"name": true,
"email": true,
"phone": true
},
"requirementMode": "<string>",
"validationPolicy": "<string>"
},
"starterPrompts": {
"mode": "<string>"
},
"launcherAction": {
"mode": "<string>",
"targetChannelId": "<string>",
"whatsappPrefillText": "<string>"
}
},
"brandingRemoval": {
"canHide": true,
"requiredTier": "<string>"
},
"launcherActionResolved": {
"type": "<string>",
"icon": "<string>",
"url": "<string>",
"fallbackReason": "<string>"
},
"publicUrl": "<string>",
"tenantSlug": "<string>",
"scriptUrl": "<string>",
"embedUrl": "<string>",
"installSnippet": "<string>",
"firstSeenAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "M2M_AUTH_INSUFFICIENT_SCOPE",
"message": "M2M credential does not have required scope.",
"details": {
"requiredScopes": [
"conversations:write"
],
"missingScopes": [
"conversations:write"
]
}
}
}