Send from an SMS connection

curl --request POST \
  --url https://app.famulor.io/api/v1/sms/connectors/{id}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+14155550100",
  "body": "<string>",
  "idempotency_key": "<string>",
  "media_urls": [
    "<string>"
  ],
  "rich_content": {
    "type": "card",
    "title": "<string>",
    "body": "<string>",
    "media_url": "<string>",
    "buttons": [
      {
        "type": "url",
        "label": "<string>",
        "value": "<string>"
      }
    ]
  },
  "sms_fallback_body": "<string>"
}
'

import requests

url = "https://app.famulor.io/api/v1/sms/connectors/{id}/send"

payload = {
    "to": "+14155550100",
    "body": "<string>",
    "idempotency_key": "<string>",
    "media_urls": ["<string>"],
    "rich_content": {
        "type": "card",
        "title": "<string>",
        "body": "<string>",
        "media_url": "<string>",
        "buttons": [
            {
                "type": "url",
                "label": "<string>",
                "value": "<string>"
            }
        ]
    },
    "sms_fallback_body": "<string>"
}
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({
    to: '+14155550100',
    body: JSON.stringify('<string>'),
    idempotency_key: '<string>',
    media_urls: ['<string>'],
    rich_content: {
      type: 'card',
      title: '<string>',
      body: JSON.stringify('<string>'),
      media_url: '<string>',
      buttons: [{type: 'url', label: '<string>', value: '<string>'}]
    },
    sms_fallback_body: '<string>'
  })
};

fetch('https://app.famulor.io/api/v1/sms/connectors/{id}/send', 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/sms/connectors/{id}/send",
  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([
    'to' => '+14155550100',
    'body' => '<string>',
    'idempotency_key' => '<string>',
    'media_urls' => [
        '<string>'
    ],
    'rich_content' => [
        'type' => 'card',
        'title' => '<string>',
        'body' => '<string>',
        'media_url' => '<string>',
        'buttons' => [
                [
                                'type' => 'url',
                                'label' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'sms_fallback_body' => '<string>'
  ]),
  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/sms/connectors/{id}/send"

	payload := strings.NewReader("{\n  \"to\": \"+14155550100\",\n  \"body\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"media_urls\": [\n    \"<string>\"\n  ],\n  \"rich_content\": {\n    \"type\": \"card\",\n    \"title\": \"<string>\",\n    \"body\": \"<string>\",\n    \"media_url\": \"<string>\",\n    \"buttons\": [\n      {\n        \"type\": \"url\",\n        \"label\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"sms_fallback_body\": \"<string>\"\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/sms/connectors/{id}/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155550100\",\n  \"body\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"media_urls\": [\n    \"<string>\"\n  ],\n  \"rich_content\": {\n    \"type\": \"card\",\n    \"title\": \"<string>\",\n    \"body\": \"<string>\",\n    \"media_url\": \"<string>\",\n    \"buttons\": [\n      {\n        \"type\": \"url\",\n        \"label\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"sms_fallback_body\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.famulor.io/api/v1/sms/connectors/{id}/send")

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  \"to\": \"+14155550100\",\n  \"body\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"media_urls\": [\n    \"<string>\"\n  ],\n  \"rich_content\": {\n    \"type\": \"card\",\n    \"title\": \"<string>\",\n    \"body\": \"<string>\",\n    \"media_url\": \"<string>\",\n    \"buttons\": [\n      {\n        \"type\": \"url\",\n        \"label\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"sms_fallback_body\": \"<string>\"\n}"

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

{
  "data": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "credits": 123,
    "transport": "sms",
    "fallback_used": true
  }
}

POST

sms

connectors

{id}

send

Send from an SMS connection

curl --request POST \
  --url https://app.famulor.io/api/v1/sms/connectors/{id}/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+14155550100",
  "body": "<string>",
  "idempotency_key": "<string>",
  "media_urls": [
    "<string>"
  ],
  "rich_content": {
    "type": "card",
    "title": "<string>",
    "body": "<string>",
    "media_url": "<string>",
    "buttons": [
      {
        "type": "url",
        "label": "<string>",
        "value": "<string>"
      }
    ]
  },
  "sms_fallback_body": "<string>"
}
'

import requests

url = "https://app.famulor.io/api/v1/sms/connectors/{id}/send"

payload = {
    "to": "+14155550100",
    "body": "<string>",
    "idempotency_key": "<string>",
    "media_urls": ["<string>"],
    "rich_content": {
        "type": "card",
        "title": "<string>",
        "body": "<string>",
        "media_url": "<string>",
        "buttons": [
            {
                "type": "url",
                "label": "<string>",
                "value": "<string>"
            }
        ]
    },
    "sms_fallback_body": "<string>"
}
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({
    to: '+14155550100',
    body: JSON.stringify('<string>'),
    idempotency_key: '<string>',
    media_urls: ['<string>'],
    rich_content: {
      type: 'card',
      title: '<string>',
      body: JSON.stringify('<string>'),
      media_url: '<string>',
      buttons: [{type: 'url', label: '<string>', value: '<string>'}]
    },
    sms_fallback_body: '<string>'
  })
};

fetch('https://app.famulor.io/api/v1/sms/connectors/{id}/send', 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/sms/connectors/{id}/send",
  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([
    'to' => '+14155550100',
    'body' => '<string>',
    'idempotency_key' => '<string>',
    'media_urls' => [
        '<string>'
    ],
    'rich_content' => [
        'type' => 'card',
        'title' => '<string>',
        'body' => '<string>',
        'media_url' => '<string>',
        'buttons' => [
                [
                                'type' => 'url',
                                'label' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'sms_fallback_body' => '<string>'
  ]),
  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/sms/connectors/{id}/send"

	payload := strings.NewReader("{\n  \"to\": \"+14155550100\",\n  \"body\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"media_urls\": [\n    \"<string>\"\n  ],\n  \"rich_content\": {\n    \"type\": \"card\",\n    \"title\": \"<string>\",\n    \"body\": \"<string>\",\n    \"media_url\": \"<string>\",\n    \"buttons\": [\n      {\n        \"type\": \"url\",\n        \"label\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"sms_fallback_body\": \"<string>\"\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/sms/connectors/{id}/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155550100\",\n  \"body\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"media_urls\": [\n    \"<string>\"\n  ],\n  \"rich_content\": {\n    \"type\": \"card\",\n    \"title\": \"<string>\",\n    \"body\": \"<string>\",\n    \"media_url\": \"<string>\",\n    \"buttons\": [\n      {\n        \"type\": \"url\",\n        \"label\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"sms_fallback_body\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.famulor.io/api/v1/sms/connectors/{id}/send")

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  \"to\": \"+14155550100\",\n  \"body\": \"<string>\",\n  \"idempotency_key\": \"<string>\",\n  \"media_urls\": [\n    \"<string>\"\n  ],\n  \"rich_content\": {\n    \"type\": \"card\",\n    \"title\": \"<string>\",\n    \"body\": \"<string>\",\n    \"media_url\": \"<string>\",\n    \"buttons\": [\n      {\n        \"type\": \"url\",\n        \"label\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"sms_fallback_body\": \"<string>\"\n}"

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

{
  "data": {
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "credits": 123,
    "transport": "sms",
    "fallback_used": true
  }
}

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.

Path Parameters

string<uuid>

required

Owned SMS connection ID.

Body

application/json

The SMS connection is selected by its path ID; do not provide a second sender in the request body.

string

required

Recipient in E.164 format.

Example:

"+14155550100"

body

string

required

Message body. RCS allows up to 1,600 Unicode characters. SMS-only sends retain the 1,600 UTF-16-unit limit; channel replies may have a stricter segment limit.

Required string length: 1 - 1600

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

idempotency_key

string

Unique request key for one intended send. Reusing it never dispatches again.

Required string length: 1 - 128

media_urls

string<uri>[]

One customer-authorized public HTTPS media URL for RCS. Choose media or rich content.

Maximum array length: 1

Maximum string length: 2048

Pattern: ^https://

rich_content

object

RCS card or carousel. With SMS fallback, supply an explicit text alternative.

Option 1
Option 2

Show child attributes

sms_fallback_body

string

Explicit plain-text SMS alternative required for rich/media content with SMS fallback. For plain-text sends, omit this field or repeat body exactly; a different alternative is rejected. SMS segment counts determine fallback cost (maximum 1,600 UTF-16 units).

Required string length: 1 - 1600

Response

SMS accepted.

data

object

required

Show child attributes