> ## Documentation Index
> Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Vobiz Ruby SDK: Messaging Method Reference

> Every Vobiz Messaging API operation - messages, numbers, coverage, conversations, opt-outs, webhooks, broadcasts, RCS senders and 10DLC - and the Ruby SDK method that calls it.

Every [Vobiz Messaging API](https://www.vobiz.ai/docs/sms/overview.md) operation and the Ruby SDK method that calls it. To install the SDK and create a client, see the [Ruby SDK](https://www.vobiz.ai/docs/integrations/ruby-sdk.md) page; to send your first message and handle errors, see [Messaging in the SDKs](https://www.vobiz.ai/docs/sms/sdks). Each operation links to its API reference page, which shows a complete example in every language.

## Messages

| Operation | Method |
| - | - |
| [Send a message](https://www.vobiz.ai/docs/sms/api/messages/send-message.md) | `client.sms.messages.send_message` |
| [List messages](https://www.vobiz.ai/docs/sms/api/messages/list-messages.md) | `client.sms.messages.list_messages` |
| [Preview message cost](https://www.vobiz.ai/docs/sms/api/messages/cost-preview.md) | `client.sms.messages.preview_message_cost` |
| [Check RCS reachability](https://www.vobiz.ai/docs/sms/api/messages/rcs-reachability.md) | `client.sms.messages.check_rcs_reachability` |
| [Retrieve a message](https://www.vobiz.ai/docs/sms/api/messages/get-message.md) | `client.sms.messages.get_message` |

## Numbers

| Operation | Method |
| - | - |
| [List your numbers](https://www.vobiz.ai/docs/sms/api/numbers/list-numbers.md) | `client.sms.numbers.list_numbers` |
| [List countries in stock](https://www.vobiz.ai/docs/sms/api/numbers/list-countries.md) | `client.sms.numbers.list_countries` |
| [Search available numbers](https://www.vobiz.ai/docs/sms/api/numbers/search-available-numbers.md) | `client.sms.numbers.search_available_numbers` |
| [Purchase a number](https://www.vobiz.ai/docs/sms/api/numbers/purchase-number.md) | `client.sms.numbers.purchase_number` |
| [List number purchases](https://www.vobiz.ai/docs/sms/api/numbers/list-purchases.md) | `client.sms.numbers.list_purchases` |
| [Release a number](https://www.vobiz.ai/docs/sms/api/numbers/release-number.md) | `client.sms.numbers.release_number` |

## Coverage

| Operation | Method |
| - | - |
| [List coverage](https://www.vobiz.ai/docs/sms/api/coverage/list-coverage.md) | `client.sms.coverage.list_coverage` |
| [Retrieve country coverage](https://www.vobiz.ai/docs/sms/api/coverage/get-coverage.md) | `client.sms.coverage.get_coverage` |

## Conversations

| Operation | Method |
| - | - |
| [List conversations](https://www.vobiz.ai/docs/sms/api/conversations/list-conversations.md) | `client.sms.conversations.list_conversations` |
| [Count unread messages](https://www.vobiz.ai/docs/sms/api/conversations/unread-count.md) | `client.sms.conversations.unread_count` |
| [Retrieve a conversation](https://www.vobiz.ai/docs/sms/api/conversations/get-conversation.md) | `client.sms.conversations.get_conversation` |
| [List conversation messages](https://www.vobiz.ai/docs/sms/api/conversations/list-conversation-messages.md) | `client.sms.conversations.list_conversation_messages` |
| [Mark a conversation read](https://www.vobiz.ai/docs/sms/api/conversations/mark-conversation-read.md) | `client.sms.conversations.mark_conversation_read` |

## Opt-outs

| Operation | Method |
| - | - |
| [Create an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/create-opt-out.md) | `client.sms.opt_outs.create_opt_out` |
| [List opt-outs](https://www.vobiz.ai/docs/sms/api/opt-outs/list-opt-outs.md) | `client.sms.opt_outs.list_opt_outs` |
| [Check an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/check-opt-out.md) | `client.sms.opt_outs.check_opt_out` |
| [Delete an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/delete-opt-out.md) | `client.sms.opt_outs.delete_opt_out` |

## Webhooks

| Operation | Method |
| - | - |
| [Create a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/create-webhook.md) | `client.sms.webhooks.create_webhook` |
| [List webhooks](https://www.vobiz.ai/docs/sms/api/webhooks/list-webhooks.md) | `client.sms.webhooks.list_webhooks` |
| [Retrieve a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/get-webhook.md) | `client.sms.webhooks.get_webhook` |
| [Update a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/update-webhook.md) | `client.sms.webhooks.update_webhook` |
| [Delete a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/delete-webhook.md) | `client.sms.webhooks.delete_webhook` |

## Broadcasts

| Operation | Method |
| - | - |
| [Create a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/create-broadcast.md) | `client.sms.broadcasts.create_broadcast` |
| [List broadcasts](https://www.vobiz.ai/docs/sms/api/broadcasts/list-broadcasts.md) | `client.sms.broadcasts.list_broadcasts` |
| [Retrieve a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/get-broadcast.md) | `client.sms.broadcasts.get_broadcast` |
| [Update a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/update-broadcast.md) | `client.sms.broadcasts.update_broadcast` |
| [Delete a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/delete-broadcast.md) | `client.sms.broadcasts.delete_broadcast` |
| [Upload recipients](https://www.vobiz.ai/docs/sms/api/broadcasts/upload-recipients.md) | `client.sms.broadcasts.upload_recipients` |
| [List recipients](https://www.vobiz.ai/docs/sms/api/broadcasts/list-recipients.md) | `client.sms.broadcasts.list_recipients` |
| [Preview a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/preview-broadcast.md) | `client.sms.broadcasts.preview_broadcast` |
| [Export results as CSV](https://www.vobiz.ai/docs/sms/api/broadcasts/export-broadcast.md) | `client.sms.broadcasts.export_broadcast` |
| [Launch a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/launch-broadcast.md) | `client.sms.broadcasts.launch_broadcast` |
| [Pause a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/pause-broadcast.md) | `client.sms.broadcasts.pause_broadcast` |
| [Resume a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/resume-broadcast.md) | `client.sms.broadcasts.resume_broadcast` |
| [Cancel a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/cancel-broadcast.md) | `client.sms.broadcasts.cancel_broadcast` |

## RCS Senders

| Operation | Method |
| - | - |
| [Create an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/create-sender.md) | `client.sms.rcs_senders.create_sender` |
| [List RCS senders](https://www.vobiz.ai/docs/sms/api/senders/list-senders.md) | `client.sms.rcs_senders.list_senders` |
| [Retrieve an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/get-sender.md) | `client.sms.rcs_senders.get_sender` |
| [Update an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/update-sender.md) | `client.sms.rcs_senders.update_sender` |
| [Refresh sender status](https://www.vobiz.ai/docs/sms/api/senders/get-sender-status.md) | `client.sms.rcs_senders.get_sender_status` |
| [Create a template](https://www.vobiz.ai/docs/sms/api/senders/create-template.md) | `client.sms.rcs_senders.create_template` |
| [List templates](https://www.vobiz.ai/docs/sms/api/senders/list-templates.md) | `client.sms.rcs_senders.list_templates` |
| [Retrieve a template](https://www.vobiz.ai/docs/sms/api/senders/get-template.md) | `client.sms.rcs_senders.get_template` |
| [Delete a template](https://www.vobiz.ai/docs/sms/api/senders/delete-template.md) | `client.sms.rcs_senders.delete_template` |
| [Refresh template status](https://www.vobiz.ai/docs/sms/api/senders/get-template-status.md) | `client.sms.rcs_senders.get_template_status` |

## 10DLC Brands

| Operation | Method |
| - | - |
| [Create a brand](https://www.vobiz.ai/docs/sms/api/10dlc/create-brand.md) | `client.sms.brands.create_brand` |
| [List brands](https://www.vobiz.ai/docs/sms/api/10dlc/list-brands.md) | `client.sms.brands.list_brands` |
| [Retrieve a brand](https://www.vobiz.ai/docs/sms/api/10dlc/get-brand.md) | `client.sms.brands.get_brand` |
| [Update a brand](https://www.vobiz.ai/docs/sms/api/10dlc/update-brand.md) | `client.sms.brands.update_brand` |
| [Delete a brand](https://www.vobiz.ai/docs/sms/api/10dlc/delete-brand.md) | `client.sms.brands.delete_brand` |
| [Register a brand](https://www.vobiz.ai/docs/sms/api/10dlc/register-brand.md) | `client.sms.brands.register_brand` |
| [List brand registrar statuses](https://www.vobiz.ai/docs/sms/api/10dlc/brand-registrar-statuses.md) | `client.sms.brands.brand_registrar_statuses` |
| [Request brand authentication](https://www.vobiz.ai/docs/sms/api/10dlc/brand-auth-verification.md) | `client.sms.brands.brand_auth_verification` |
| [Resend brand 2FA verification](https://www.vobiz.ai/docs/sms/api/10dlc/resend-2fa.md) | `client.sms.brands.resend2fa` |
| [Vet a brand](https://www.vobiz.ai/docs/sms/api/10dlc/vet-brand.md) | `client.sms.brands.vet_brand` |
| [List brand vets](https://www.vobiz.ai/docs/sms/api/10dlc/list-brand-vets.md) | `client.sms.brands.list_brand_vets` |

## 10DLC Campaigns

| Operation | Method |
| - | - |
| [Create a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/create-campaign.md) | `client.sms.campaigns.create_campaign` |
| [List campaigns](https://www.vobiz.ai/docs/sms/api/10dlc/list-campaigns.md) | `client.sms.campaigns.list_campaigns` |
| [Create a toll-free campaign](https://www.vobiz.ai/docs/sms/api/10dlc/create-toll-free-campaign.md) | `client.sms.campaigns.create_toll_free_campaign` |
| [List campaign priorities](https://www.vobiz.ai/docs/sms/api/10dlc/campaign-priorities.md) | `client.sms.campaigns.campaign_priorities` |
| [Retrieve a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/get-campaign.md) | `client.sms.campaigns.get_campaign` |
| [Update a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/update-campaign.md) | `client.sms.campaigns.update_campaign` |
| [Delete a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/delete-campaign.md) | `client.sms.campaigns.delete_campaign` |
| [Register a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/register-campaign.md) | `client.sms.campaigns.register_campaign` |
| [Deregister a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/deregister-campaign.md) | `client.sms.campaigns.deregister_campaign` |
| [Appeal a campaign rejection](https://www.vobiz.ai/docs/sms/api/10dlc/appeal-campaign.md) | `client.sms.campaigns.appeal_campaign` |
| [Update a campaign registration](https://www.vobiz.ai/docs/sms/api/10dlc/update-campaign-registration.md) | `client.sms.campaigns.update_campaign_registration` |
| [List campaign network statuses](https://www.vobiz.ai/docs/sms/api/10dlc/campaign-network-statuses.md) | `client.sms.campaigns.campaign_network_statuses` |
| [List campaign numbers](https://www.vobiz.ai/docs/sms/api/10dlc/list-campaign-numbers.md) | `client.sms.campaigns.list_campaign_numbers` |
| [Add numbers to a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/add-campaign-numbers.md) | `client.sms.campaigns.add_campaign_numbers` |
| [Remove numbers from a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/remove-campaign-numbers.md) | `client.sms.campaigns.remove_campaign_numbers` |
| [Upload a document](https://www.vobiz.ai/docs/sms/api/10dlc/upload-document.md) | `client.sms.campaigns.upload_document` |
| [Download a document](https://www.vobiz.ai/docs/sms/api/10dlc/get-document.md) | `client.sms.campaigns.get_document` |

## Other languages

The same reference for [Node.js](https://www.vobiz.ai/docs/sms/sdks/node.md), [Python](https://www.vobiz.ai/docs/sms/sdks/python.md), [Go](https://www.vobiz.ai/docs/sms/sdks/go.md), [Java](https://www.vobiz.ai/docs/sms/sdks/java.md), [C#](https://www.vobiz.ai/docs/sms/sdks/csharp.md), [PHP](https://www.vobiz.ai/docs/sms/sdks/php.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.