Create messaging connector
curl --request POST \
--url https://app.famulor.io/api/v1/messaging-connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bot_token": "<string>",
"bot_username": "<string>",
"signing_secret": "<string>",
"team_name": "<string>",
"page_access_token": "<string>",
"app_secret": "<string>",
"verify_token": "<string>",
"page_name": "<string>",
"phone_number_id": "<string>",
"access_token": "<string>",
"waba_id": "<string>",
"display_phone_number": "<string>",
"whatsapp_text_enabled": true,
"whatsapp_voice_enabled": true,
"whatsapp_outbound_voice_enabled": true,
"response_delay_sec": 15,
"inactivity_timeout_min": 720,
"allow_retrigger": true,
"conversation_ended_webhook_url": "<string>",
"linked_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ai_enabled": true
}
'import requests
url = "https://app.famulor.io/api/v1/messaging-connectors"
payload = {
"name": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bot_token": "<string>",
"bot_username": "<string>",
"signing_secret": "<string>",
"team_name": "<string>",
"page_access_token": "<string>",
"app_secret": "<string>",
"verify_token": "<string>",
"page_name": "<string>",
"phone_number_id": "<string>",
"access_token": "<string>",
"waba_id": "<string>",
"display_phone_number": "<string>",
"whatsapp_text_enabled": True,
"whatsapp_voice_enabled": True,
"whatsapp_outbound_voice_enabled": True,
"response_delay_sec": 15,
"inactivity_timeout_min": 720,
"allow_retrigger": True,
"conversation_ended_webhook_url": "<string>",
"linked_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ai_enabled": True
}
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({
name: '<string>',
assistant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bot_token: '<string>',
bot_username: '<string>',
signing_secret: '<string>',
team_name: '<string>',
page_access_token: '<string>',
app_secret: '<string>',
verify_token: '<string>',
page_name: '<string>',
phone_number_id: '<string>',
access_token: '<string>',
waba_id: '<string>',
display_phone_number: '<string>',
whatsapp_text_enabled: true,
whatsapp_voice_enabled: true,
whatsapp_outbound_voice_enabled: true,
response_delay_sec: 15,
inactivity_timeout_min: 720,
allow_retrigger: true,
conversation_ended_webhook_url: '<string>',
linked_phone_number_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ai_enabled: true
})
};
fetch('https://app.famulor.io/api/v1/messaging-connectors', 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://app.famulor.io/api/v1/messaging-connectors",
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([
'name' => '<string>',
'assistant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bot_token' => '<string>',
'bot_username' => '<string>',
'signing_secret' => '<string>',
'team_name' => '<string>',
'page_access_token' => '<string>',
'app_secret' => '<string>',
'verify_token' => '<string>',
'page_name' => '<string>',
'phone_number_id' => '<string>',
'access_token' => '<string>',
'waba_id' => '<string>',
'display_phone_number' => '<string>',
'whatsapp_text_enabled' => true,
'whatsapp_voice_enabled' => true,
'whatsapp_outbound_voice_enabled' => true,
'response_delay_sec' => 15,
'inactivity_timeout_min' => 720,
'allow_retrigger' => true,
'conversation_ended_webhook_url' => '<string>',
'linked_phone_number_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ai_enabled' => true
]),
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://app.famulor.io/api/v1/messaging-connectors"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bot_token\": \"<string>\",\n \"bot_username\": \"<string>\",\n \"signing_secret\": \"<string>\",\n \"team_name\": \"<string>\",\n \"page_access_token\": \"<string>\",\n \"app_secret\": \"<string>\",\n \"verify_token\": \"<string>\",\n \"page_name\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"access_token\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"display_phone_number\": \"<string>\",\n \"whatsapp_text_enabled\": true,\n \"whatsapp_voice_enabled\": true,\n \"whatsapp_outbound_voice_enabled\": true,\n \"response_delay_sec\": 15,\n \"inactivity_timeout_min\": 720,\n \"allow_retrigger\": true,\n \"conversation_ended_webhook_url\": \"<string>\",\n \"linked_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ai_enabled\": true\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://app.famulor.io/api/v1/messaging-connectors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bot_token\": \"<string>\",\n \"bot_username\": \"<string>\",\n \"signing_secret\": \"<string>\",\n \"team_name\": \"<string>\",\n \"page_access_token\": \"<string>\",\n \"app_secret\": \"<string>\",\n \"verify_token\": \"<string>\",\n \"page_name\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"access_token\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"display_phone_number\": \"<string>\",\n \"whatsapp_text_enabled\": true,\n \"whatsapp_voice_enabled\": true,\n \"whatsapp_outbound_voice_enabled\": true,\n \"response_delay_sec\": 15,\n \"inactivity_timeout_min\": 720,\n \"allow_retrigger\": true,\n \"conversation_ended_webhook_url\": \"<string>\",\n \"linked_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ai_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/messaging-connectors")
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 \"name\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bot_token\": \"<string>\",\n \"bot_username\": \"<string>\",\n \"signing_secret\": \"<string>\",\n \"team_name\": \"<string>\",\n \"page_access_token\": \"<string>\",\n \"app_secret\": \"<string>\",\n \"verify_token\": \"<string>\",\n \"page_name\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"access_token\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"display_phone_number\": \"<string>\",\n \"whatsapp_text_enabled\": true,\n \"whatsapp_voice_enabled\": true,\n \"whatsapp_outbound_voice_enabled\": true,\n \"response_delay_sec\": 15,\n \"inactivity_timeout_min\": 720,\n \"allow_retrigger\": true,\n \"conversation_ended_webhook_url\": \"<string>\",\n \"linked_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ai_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_name": "<string>",
"platform": "sms",
"name": "<string>",
"is_active": true,
"status": "pending",
"last_error": "<string>",
"webhook_url": "<string>",
"response_delay_sec": 5,
"inactivity_timeout_min": 30,
"allow_retrigger": false,
"conversation_ended_webhook_url": "<string>",
"reply_mode": "send",
"extra_actions_enabled": true,
"watch_scope": "inbox",
"watch_name": "<string>",
"watch_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"whatsapp_coexistence": true,
"linked_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ai_enabled": true
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Messaging
Create messaging connector
Connect an existing SMS-capable workspace number or a chat app. SMS requires linked_phone_number_id, uses the number’s configured carrier, and leaves automatic replies off by default. Chat apps require their platform-specific credentials. Help desk, mailbox, Instagram and Zulip channels are connected in the dashboard. Conversation settings control reply delay, inactivity, repeated end events and the optional conversation-ended webhook.
POST
/
messaging-connectors
Create messaging connector
curl --request POST \
--url https://app.famulor.io/api/v1/messaging-connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bot_token": "<string>",
"bot_username": "<string>",
"signing_secret": "<string>",
"team_name": "<string>",
"page_access_token": "<string>",
"app_secret": "<string>",
"verify_token": "<string>",
"page_name": "<string>",
"phone_number_id": "<string>",
"access_token": "<string>",
"waba_id": "<string>",
"display_phone_number": "<string>",
"whatsapp_text_enabled": true,
"whatsapp_voice_enabled": true,
"whatsapp_outbound_voice_enabled": true,
"response_delay_sec": 15,
"inactivity_timeout_min": 720,
"allow_retrigger": true,
"conversation_ended_webhook_url": "<string>",
"linked_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ai_enabled": true
}
'import requests
url = "https://app.famulor.io/api/v1/messaging-connectors"
payload = {
"name": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bot_token": "<string>",
"bot_username": "<string>",
"signing_secret": "<string>",
"team_name": "<string>",
"page_access_token": "<string>",
"app_secret": "<string>",
"verify_token": "<string>",
"page_name": "<string>",
"phone_number_id": "<string>",
"access_token": "<string>",
"waba_id": "<string>",
"display_phone_number": "<string>",
"whatsapp_text_enabled": True,
"whatsapp_voice_enabled": True,
"whatsapp_outbound_voice_enabled": True,
"response_delay_sec": 15,
"inactivity_timeout_min": 720,
"allow_retrigger": True,
"conversation_ended_webhook_url": "<string>",
"linked_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ai_enabled": True
}
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({
name: '<string>',
assistant_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bot_token: '<string>',
bot_username: '<string>',
signing_secret: '<string>',
team_name: '<string>',
page_access_token: '<string>',
app_secret: '<string>',
verify_token: '<string>',
page_name: '<string>',
phone_number_id: '<string>',
access_token: '<string>',
waba_id: '<string>',
display_phone_number: '<string>',
whatsapp_text_enabled: true,
whatsapp_voice_enabled: true,
whatsapp_outbound_voice_enabled: true,
response_delay_sec: 15,
inactivity_timeout_min: 720,
allow_retrigger: true,
conversation_ended_webhook_url: '<string>',
linked_phone_number_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ai_enabled: true
})
};
fetch('https://app.famulor.io/api/v1/messaging-connectors', 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://app.famulor.io/api/v1/messaging-connectors",
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([
'name' => '<string>',
'assistant_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bot_token' => '<string>',
'bot_username' => '<string>',
'signing_secret' => '<string>',
'team_name' => '<string>',
'page_access_token' => '<string>',
'app_secret' => '<string>',
'verify_token' => '<string>',
'page_name' => '<string>',
'phone_number_id' => '<string>',
'access_token' => '<string>',
'waba_id' => '<string>',
'display_phone_number' => '<string>',
'whatsapp_text_enabled' => true,
'whatsapp_voice_enabled' => true,
'whatsapp_outbound_voice_enabled' => true,
'response_delay_sec' => 15,
'inactivity_timeout_min' => 720,
'allow_retrigger' => true,
'conversation_ended_webhook_url' => '<string>',
'linked_phone_number_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ai_enabled' => true
]),
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://app.famulor.io/api/v1/messaging-connectors"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bot_token\": \"<string>\",\n \"bot_username\": \"<string>\",\n \"signing_secret\": \"<string>\",\n \"team_name\": \"<string>\",\n \"page_access_token\": \"<string>\",\n \"app_secret\": \"<string>\",\n \"verify_token\": \"<string>\",\n \"page_name\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"access_token\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"display_phone_number\": \"<string>\",\n \"whatsapp_text_enabled\": true,\n \"whatsapp_voice_enabled\": true,\n \"whatsapp_outbound_voice_enabled\": true,\n \"response_delay_sec\": 15,\n \"inactivity_timeout_min\": 720,\n \"allow_retrigger\": true,\n \"conversation_ended_webhook_url\": \"<string>\",\n \"linked_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ai_enabled\": true\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://app.famulor.io/api/v1/messaging-connectors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bot_token\": \"<string>\",\n \"bot_username\": \"<string>\",\n \"signing_secret\": \"<string>\",\n \"team_name\": \"<string>\",\n \"page_access_token\": \"<string>\",\n \"app_secret\": \"<string>\",\n \"verify_token\": \"<string>\",\n \"page_name\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"access_token\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"display_phone_number\": \"<string>\",\n \"whatsapp_text_enabled\": true,\n \"whatsapp_voice_enabled\": true,\n \"whatsapp_outbound_voice_enabled\": true,\n \"response_delay_sec\": 15,\n \"inactivity_timeout_min\": 720,\n \"allow_retrigger\": true,\n \"conversation_ended_webhook_url\": \"<string>\",\n \"linked_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ai_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/messaging-connectors")
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 \"name\": \"<string>\",\n \"assistant_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bot_token\": \"<string>\",\n \"bot_username\": \"<string>\",\n \"signing_secret\": \"<string>\",\n \"team_name\": \"<string>\",\n \"page_access_token\": \"<string>\",\n \"app_secret\": \"<string>\",\n \"verify_token\": \"<string>\",\n \"page_name\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"access_token\": \"<string>\",\n \"waba_id\": \"<string>\",\n \"display_phone_number\": \"<string>\",\n \"whatsapp_text_enabled\": true,\n \"whatsapp_voice_enabled\": true,\n \"whatsapp_outbound_voice_enabled\": true,\n \"response_delay_sec\": 15,\n \"inactivity_timeout_min\": 720,\n \"allow_retrigger\": true,\n \"conversation_ended_webhook_url\": \"<string>\",\n \"linked_phone_number_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ai_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_name": "<string>",
"platform": "sms",
"name": "<string>",
"is_active": true,
"status": "pending",
"last_error": "<string>",
"webhook_url": "<string>",
"response_delay_sec": 5,
"inactivity_timeout_min": 30,
"allow_retrigger": false,
"conversation_ended_webhook_url": "<string>",
"reply_mode": "send",
"extra_actions_enabled": true,
"watch_scope": "inbox",
"watch_name": "<string>",
"watch_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"whatsapp_coexistence": true,
"linked_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ai_enabled": true
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Body
application/json
SMS connects an existing SMS-capable workspace number. Chat apps connect with credentials; app channels use dashboard authorization.
Available options:
sms, telegram, slack, messenger, teams, discord, gchat, x, whatsapp Maximum string length:
120WhatsApp Cloud API phone number ID
WhatsApp permanent System User token
WhatsApp Business Account ID
Required range:
0 <= x <= 30Required range:
1 <= x <= 1440Required for SMS. UUID of the active SMS-capable phone number in this workspace. The channel keeps this number; credentials stay on the number.
Enable automatic replies. Defaults to false for SMS and true for other channels.
Response
Created connector (may include one-time webhook_secret for Telegram).
Show child attributes
Show child attributes