Skip to main content
POST
Create messaging connector

Authorizations

Authorization
string
header
required

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
platform
enum<string>
required

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,
linear,
notion,
twitch,
mattermost,
webex,
lark,
line,
sendblue,
linq,
zernio
name
string
required
Maximum string length: 120
assistant_id
string<uuid>
required
bot_token
string
bot_username
string
signing_secret
string
team_name
string
page_access_token
string
app_secret
string
app_id
string

Lark or Feishu App ID (starts with cli_). Also accepts a Microsoft Teams app ID.

user_access_token
string

Optional Twitch user access token used for whispers.

refresh_token
string

Optional Twitch refresh token used to renew the whisper access token.

verify_token
string
page_name
string
phone_number_id
string

WhatsApp Cloud API phone number ID

access_token
string

WhatsApp permanent System User token

waba_id
string

WhatsApp Business Account ID

display_phone_number
string
api_key
string

Linear / Sendblue / Linq / Zernio API key.

api_secret
string

Sendblue API secret key.

from_number
string

Sendblue sender number in E.164 format.

webhook_secret
string

Webhook signing secret / token (Linear, Twitch, Mattermost, Webex, Sendblue, Zernio, or optional custom Telegram secret).

token
string

Notion internal integration token.

verification_token
string

Notion or Lark / Feishu webhook verification token.

client_id
string

Twitch Application Client ID or X OAuth client ID.

client_secret
string

Twitch Application Client Secret.

bot_user_id
string

Optional bot user / person ID (Slack, Twitch, Webex).

base_url
string<uri>

Mattermost HTTPS server URL.

encrypt_key
string

Optional Lark / Feishu event encryption key.

domain
enum<string>

Lark / Feishu platform domain (lark or feishu).

Available options:
lark,
feishu
channel_access_token
string

LINE Messaging API channel access token.

channel_secret
string

LINE Messaging API channel secret.

mode
enum<string>

Linear interaction mode (comments or agent-sessions).

Available options:
comments,
agent-sessions
whatsapp_text_enabled
boolean
whatsapp_voice_enabled
boolean
whatsapp_outbound_voice_enabled
boolean
response_delay_sec
integer
Required range: 0 <= x <= 30
inactivity_timeout_min
integer
Required range: 1 <= x <= 1440
allow_retrigger
boolean
conversation_ended_webhook_url
string<uri> | null
linked_phone_number_id
string<uuid>

Owned eligible SMS number. Needed for SMS delivery and fallback; optional for an activated company sender in RCS-only mode.

ai_enabled
boolean

Enable automatic replies. Defaults to false for SMS and true for other channels.

outbound_sms_enabled
boolean

SMS only. Save the linked number's outbound SMS permission atomically with the channel settings and assistant assignment. Omit to preserve the current permission.

sms_delivery_mode
enum<string>

Delivery selection within SMS. Omit to inherit the saved connection policy; SMS only prevents RCS upgrade.

Available options:
sms_only,
rcs_preferred,
rcs_only
rcs_sender_id
string<uuid> | null

Owned company sender ID for this SMS connection. Must be ready before RCS can be enabled.

rcs_default_connector
boolean
write-only

SMS only: true routes new incoming RCS contacts for the company sender to this connection. False releases this connection when it is the current default; another linked connection may be selected. Omit to preserve incoming routing. Read the sender default_connector_id for the authoritative selection.

Response

Created connector (may include one-time webhook_secret for Telegram).

data
object