home / skills / openclaw / skills / telnyx-messaging-profiles-ruby

telnyx-messaging-profiles-ruby skill

safe

/skills/dotcom-squad/telnyx-toolkit/api/ruby/telnyx-messaging-profiles-ruby

This skill helps you manage Telnyx messaging profiles and short codes with Ruby SDK examples for quick integration.

npx playbooks add skill openclaw/skills --skill telnyx-messaging-profiles-ruby

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

4.3 KB

---
name: telnyx-messaging-profiles-ruby
description: >-
  Create and manage messaging profiles with number pools, sticky sender, and
  geomatch features. Configure short codes for high-volume messaging. This skill
  provides Ruby SDK examples.
metadata:
  author: telnyx
  product: messaging-profiles
  language: ruby
  generated_by: telnyx-ext-skills-generator
---

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

# Telnyx Messaging Profiles - Ruby

## Installation

```bash
gem install telnyx
```

## Setup

```ruby
require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)
```

All examples below assume `client` is already initialized as shown above.

## List messaging profiles

`GET /messaging_profiles`

```ruby
page = client.messaging_profiles.list

puts(page)
```

## Create a messaging profile

`POST /messaging_profiles` — Required: `name`, `whitelisted_destinations`

```ruby
messaging_profile = client.messaging_profiles.create(name: "My name", whitelisted_destinations: ["US"])

puts(messaging_profile)
```

## Retrieve a messaging profile

`GET /messaging_profiles/{id}`

```ruby
messaging_profile = client.messaging_profiles.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(messaging_profile)
```

## Update a messaging profile

`PATCH /messaging_profiles/{id}`

```ruby
messaging_profile = client.messaging_profiles.update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(messaging_profile)
```

## Delete a messaging profile

`DELETE /messaging_profiles/{id}`

```ruby
messaging_profile = client.messaging_profiles.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(messaging_profile)
```

## List phone numbers associated with a messaging profile

`GET /messaging_profiles/{id}/phone_numbers`

```ruby
page = client.messaging_profiles.list_phone_numbers("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
```

## List short codes associated with a messaging profile

`GET /messaging_profiles/{id}/short_codes`

```ruby
page = client.messaging_profiles.list_short_codes("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(page)
```

## List Auto-Response Settings

`GET /messaging_profiles/{profile_id}/autoresp_configs`

```ruby
autoresp_configs = client.messaging_profiles.autoresp_configs.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(autoresp_configs)
```

## Create auto-response setting

`POST /messaging_profiles/{profile_id}/autoresp_configs` — Required: `op`, `keywords`, `country_code`

```ruby
auto_resp_config_response = client.messaging_profiles.autoresp_configs.create(
  "profile_id",
  country_code: "US",
  keywords: ["keyword1", "keyword2"],
  op: :start
)

puts(auto_resp_config_response)
```

## Get Auto-Response Setting

`GET /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}`

```ruby
auto_resp_config_response = client.messaging_profiles.autoresp_configs.retrieve(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  profile_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(auto_resp_config_response)
```

## Update Auto-Response Setting

`PUT /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}` — Required: `op`, `keywords`, `country_code`

```ruby
auto_resp_config_response = client.messaging_profiles.autoresp_configs.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  profile_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  country_code: "US",
  keywords: ["keyword1", "keyword2"],
  op: :start
)

puts(auto_resp_config_response)
```

## Delete Auto-Response Setting

`DELETE /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}`

```ruby
autoresp_config = client.messaging_profiles.autoresp_configs.delete(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  profile_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(autoresp_config)
```

## List short codes

`GET /short_codes`

```ruby
page = client.short_codes.list

puts(page)
```

## Retrieve a short code

`GET /short_codes/{id}`

```ruby
short_code = client.short_codes.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(short_code)
```

## Update short code

Update the settings for a specific short code.

`PATCH /short_codes/{id}` — Required: `messaging_profile_id`

```ruby
short_code = client.short_codes.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  messaging_profile_id: "abc85f64-5717-4562-b3fc-2c9600000000"
)

puts(short_code)
```

Overview

This skill shows how to create and manage Telnyx messaging profiles using the Ruby SDK. It covers profile lifecycle operations, phone number and short code associations, and auto-response configuration for country and keyword-based automated replies. Examples focus on pragmatic calls for list, create, retrieve, update, and delete tasks.

How this skill works

Initialize the Telnyx Ruby client with your API key and call the messaging_profiles and short_codes endpoints through the SDK. Use provided methods to list profiles, attach phone numbers or short codes, and manage auto-response rules (create, retrieve, update, delete). The examples demonstrate required parameters and typical flows like setting whitelisted destinations and configuring geo-specific auto-responses.

When to use it

When you need to create or update messaging profiles for SMS/MMS campaigns.
When assigning pools of phone numbers or short codes to a messaging profile.
When implementing sticky sender or geo-match behavior for message routing.
When configuring automated keyword-based responses per country.
When auditing or listing all phone numbers and short codes tied to a profile.

Best practices

Store your TELNYX_API_KEY in environment variables and avoid hard-coding credentials.
Validate required fields (name, whitelisted_destinations) before calling create to reduce API errors.
Use descriptive profile names to map profiles to applications, regions, or use cases.
Limit auto-response rules to clear keyword and country combinations to avoid unintended replies.
Test changes in a staging account before updating production short codes or profile routing.

Example use cases

Create a regional messaging profile limited to US destinations and attach a pool of US numbers.
Enable sticky sender to keep users seeing the same number for a conversation thread.
Assign a high-throughput short code to a profile for large-scale marketing or notification traffic.
Add auto-response rules to handle opt-ins or keyword-based flows per country.
Audit all short codes linked to a profile before making updates to avoid downtime.

FAQ

Do I need a separate profile for short codes and phone numbers?

You can associate both numbers and short codes to the same messaging profile, but use separate profiles if you require distinct routing, throughput, or compliance settings.

What are required fields when creating a messaging profile?

At minimum provide a name and whitelisted_destinations (an array of country codes) when creating a profile via the SDK.