RCS Capabilities & Deeplinks

curl -s https://api.telnyx.com/v2/messaging/rcs/capabilities/{agent_id}/{phone_number} \
  -H "Authorization: Bearer YOUR_API_KEY"

import os
import requests

API_KEY = os.environ.get("TELNYX_API_KEY")
AGENT_ID = "your_agent_id"

headers = {"Authorization": f"Bearer {API_KEY}"}


def check_rcs_capabilities(phone_number: str) -> dict:
    """Check if a phone number supports RCS and which features."""
    response = requests.get(
        f"https://api.telnyx.com/v2/messaging/rcs/capabilities/{AGENT_ID}/{phone_number}",
        headers=headers,
    )
    data = response.json()["data"]
    return {
        "phone_number": data["phone_number"],
        "rcs_enabled": bool(data.get("features")),
        "features": data.get("features") or [],
        "supports_rich_cards": "RICHCARD_STANDALONE" in (data.get("features") or []),
        "supports_carousel": "RICHCARD_CAROUSEL" in (data.get("features") or []),
    }


result = check_rcs_capabilities("+15559876543")
print(f"RCS enabled: {result['rcs_enabled']}")
print(f"Features: {result['features']}")

const axios = require('axios');

const headers = {
  Authorization: `Bearer ${process.env.TELNYX_API_KEY}`,
};
const agentId = 'your_agent_id';

async function checkRcsCapabilities(phoneNumber) {
  const response = await axios.get(
    `https://api.telnyx.com/v2/messaging/rcs/capabilities/${agentId}/${phoneNumber}`,
    { headers }
  );
  const { data } = response.data;
  return {
    phoneNumber: data.phone_number,
    rcsEnabled: Boolean(data.features?.length),
    features: data.features || [],
    supportsRichCards: data.features?.includes('RICHCARD_STANDALONE') ?? false,
    supportsCarousel: data.features?.includes('RICHCARD_CAROUSEL') ?? false,
  };
}

const result = await checkRcsCapabilities('+15559876543');
console.log(`RCS enabled: ${result.rcsEnabled}`);
console.log(`Features: ${result.features.join(', ')}`);

require "net/http"
require "json"
require "uri"

api_key = ENV["TELNYX_API_KEY"]
agent_id = "your_agent_id"

def check_rcs(agent_id, phone_number, api_key)
  uri = URI("https://api.telnyx.com/v2/messaging/rcs/capabilities/#{agent_id}/#{phone_number}")
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true
  request = Net::HTTP::Get.new(uri)
  request["Authorization"] = "Bearer #{api_key}"
  response = http.request(request)
  data = JSON.parse(response.body)["data"]
  {
    rcs_enabled: !data["features"].nil? && !data["features"].empty?,
    features: data["features"] || []
  }
end

result = check_rcs(agent_id, "+15559876543", api_key)
puts "RCS enabled: #{result[:rcs_enabled]}"

package main

import (
  "encoding/json"
  "fmt"
  "net/http"
  "os"
)

func checkRCS(agentID, phoneNumber string) ([]string, error) {
  url := fmt.Sprintf("https://api.telnyx.com/v2/messaging/rcs/capabilities/%s/%s", agentID, phoneNumber)
  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("TELNYX_API_KEY"))

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    return nil, err
  }
  defer resp.Body.Close()

  var result struct {
    Data struct {
      Features []string `json:"features"`
    } `json:"data"`
  }
  json.NewDecoder(resp.Body).Decode(&result)
  return result.Data.Features, nil
}

func main() {
  features, _ := checkRCS("your_agent_id", "+15559876543")
  fmt.Printf("Features: %v\n", features)
}

<?php
$apiKey = getenv('TELNYX_API_KEY');
$agentId = 'your_agent_id';
$phoneNumber = '+15559876543';

$ch = curl_init("https://api.telnyx.com/v2/messaging/rcs/capabilities/{$agentId}/{$phoneNumber}");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer {$apiKey}"],
]);

$data = json_decode(curl_exec($ch), true)['data'];
curl_close($ch);

$rcsEnabled = !empty($data['features']);
echo "RCS enabled: " . ($rcsEnabled ? 'yes' : 'no') . "\n";
echo "Features: " . implode(', ', $data['features'] ?? []) . "\n";

curl -X POST https://api.telnyx.com/v2/messaging/rcs/bulk_capabilities \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "agent_id": "your_agent_id",
    "phone_numbers": ["+15551234567", "+15559876543", "+15550001111"]
  }'

def bulk_check_rcs(phone_numbers: list[str]) -> dict:
    """Check RCS capabilities for up to 100 numbers."""
    response = requests.post(
        "https://api.telnyx.com/v2/messaging/rcs/bulk_capabilities",
        headers={**headers, "Content-Type": "application/json"},
        json={
            "agent_id": AGENT_ID,
            "phone_numbers": phone_numbers,
        },
    )

    results = {"rcs": [], "sms_fallback": []}
    for entry in response.json()["data"]:
        if entry.get("features"):
            results["rcs"].append(entry["phone_number"])
        else:
            results["sms_fallback"].append(entry["phone_number"])

    return results


# Segment audience
numbers = ["+15551234567", "+15559876543", "+15550001111"]
segments = bulk_check_rcs(numbers)
print(f"RCS capable: {len(segments['rcs'])}")
print(f"SMS fallback: {len(segments['sms_fallback'])}")

async function bulkCheckRcs(phoneNumbers) {
  const response = await axios.post(
    'https://api.telnyx.com/v2/messaging/rcs/bulk_capabilities',
    {
      agent_id: agentId,
      phone_numbers: phoneNumbers,
    },
    { headers: { ...headers, 'Content-Type': 'application/json' } }
  );

  const results = { rcs: [], smsFallback: [] };
  for (const entry of response.data.data) {
    if (entry.features?.length) {
      results.rcs.push(entry.phone_number);
    } else {
      results.smsFallback.push(entry.phone_number);
    }
  }
  return results;
}

const segments = await bulkCheckRcs(['+15551234567', '+15559876543']);
console.log(`RCS: ${segments.rcs.length}, SMS: ${segments.smsFallback.length}`);

# With fallback phone number and message body
curl -s 'https://api.telnyx.com/v2/messages/rcs/deeplinks/{agent_id}?phone_number=%2B15554443333&body=hello%20world' \
  -H "Authorization: Bearer YOUR_API_KEY"

# Without fallback (RCS only)
curl -s 'https://api.telnyx.com/v2/messages/rcs/deeplinks/{agent_id}' \
  -H "Authorization: Bearer YOUR_API_KEY"

import urllib.parse

def generate_deeplink(
    agent_id: str,
    fallback_phone: str = None,
    message_body: str = None,
) -> str:
    """Generate an RCS deeplink URL."""
    url = f"https://api.telnyx.com/v2/messages/rcs/deeplinks/{agent_id}"
    params = {}
    if fallback_phone:
        params["phone_number"] = fallback_phone
    if message_body:
        params["body"] = message_body

    if params:
        url += "?" + urllib.parse.urlencode(params)

    response = requests.get(url, headers=headers)
    return response.json()["data"]["url"]


# Generate deeplink with fallback
link = generate_deeplink(
    agent_id="your_agent_id",
    fallback_phone="+15554443333",
    message_body="Hi, I'd like to learn more!",
)
print(f"Deeplink: {link}")

async function generateDeeplink(agentId, fallbackPhone, messageBody) {
  const params = new URLSearchParams();
  if (fallbackPhone) params.set('phone_number', fallbackPhone);
  if (messageBody) params.set('body', messageBody);

  const url = `https://api.telnyx.com/v2/messages/rcs/deeplinks/${agentId}${
    params.toString() ? '?' + params.toString() : ''
  }`;

  const response = await axios.get(url, { headers });
  return response.data.data.url;
}

const link = await generateDeeplink('your_agent_id', '+15554443333', 'Hi!');
console.log(`Deeplink: ${link}`);