> ## 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 Node.js SDK: Messaging Method Reference

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

Every [Vobiz Messaging API](https://www.vobiz.ai/docs/sms/overview.md) operation and the Node.js SDK method that calls it. To install the SDK and create a client, see the [Node.js SDK](https://www.vobiz.ai/docs/integrations/node-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.sendMessage` |
| [List messages](https://www.vobiz.ai/docs/sms/api/messages/list-messages.md) | `client.sms.messages.listMessages` |
| [Preview message cost](https://www.vobiz.ai/docs/sms/api/messages/cost-preview.md) | `client.sms.messages.previewMessageCost` |
| [Check RCS reachability](https://www.vobiz.ai/docs/sms/api/messages/rcs-reachability.md) | `client.sms.messages.checkRcsReachability` |
| [Retrieve a message](https://www.vobiz.ai/docs/sms/api/messages/get-message.md) | `client.sms.messages.getMessage` |

## Numbers

| Operation | Method |
| - | - |
| [List your numbers](https://www.vobiz.ai/docs/sms/api/numbers/list-numbers.md) | `client.sms.numbers.listNumbers` |
| [List countries in stock](https://www.vobiz.ai/docs/sms/api/numbers/list-countries.md) | `client.sms.numbers.listCountries` |
| [Search available numbers](https://www.vobiz.ai/docs/sms/api/numbers/search-available-numbers.md) | `client.sms.numbers.searchAvailableNumbers` |
| [Purchase a number](https://www.vobiz.ai/docs/sms/api/numbers/purchase-number.md) | `client.sms.numbers.purchaseNumber` |
| [List number purchases](https://www.vobiz.ai/docs/sms/api/numbers/list-purchases.md) | `client.sms.numbers.listPurchases` |
| [Release a number](https://www.vobiz.ai/docs/sms/api/numbers/release-number.md) | `client.sms.numbers.releaseNumber` |

## Coverage

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

## Conversations

| Operation | Method |
| - | - |
| [List conversations](https://www.vobiz.ai/docs/sms/api/conversations/list-conversations.md) | `client.sms.conversations.listConversations` |
| [Count unread messages](https://www.vobiz.ai/docs/sms/api/conversations/unread-count.md) | `client.sms.conversations.unreadCount` |
| [Retrieve a conversation](https://www.vobiz.ai/docs/sms/api/conversations/get-conversation.md) | `client.sms.conversations.getConversation` |
| [List conversation messages](https://www.vobiz.ai/docs/sms/api/conversations/list-conversation-messages.md) | `client.sms.conversations.listConversationMessages` |
| [Mark a conversation read](https://www.vobiz.ai/docs/sms/api/conversations/mark-conversation-read.md) | `client.sms.conversations.markConversationRead` |

## Opt-outs

| Operation | Method |
| - | - |
| [Create an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/create-opt-out.md) | `client.sms.optOuts.createOptOut` |
| [List opt-outs](https://www.vobiz.ai/docs/sms/api/opt-outs/list-opt-outs.md) | `client.sms.optOuts.listOptOuts` |
| [Check an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/check-opt-out.md) | `client.sms.optOuts.checkOptOut` |
| [Delete an opt-out](https://www.vobiz.ai/docs/sms/api/opt-outs/delete-opt-out.md) | `client.sms.optOuts.deleteOptOut` |

## Webhooks

| Operation | Method |
| - | - |
| [Create a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/create-webhook.md) | `client.sms.webhooks.createWebhook` |
| [List webhooks](https://www.vobiz.ai/docs/sms/api/webhooks/list-webhooks.md) | `client.sms.webhooks.listWebhooks` |
| [Retrieve a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/get-webhook.md) | `client.sms.webhooks.getWebhook` |
| [Update a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/update-webhook.md) | `client.sms.webhooks.updateWebhook` |
| [Delete a webhook](https://www.vobiz.ai/docs/sms/api/webhooks/delete-webhook.md) | `client.sms.webhooks.deleteWebhook` |

## Broadcasts

| Operation | Method |
| - | - |
| [Create a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/create-broadcast.md) | `client.sms.broadcasts.createBroadcast` |
| [List broadcasts](https://www.vobiz.ai/docs/sms/api/broadcasts/list-broadcasts.md) | `client.sms.broadcasts.listBroadcasts` |
| [Retrieve a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/get-broadcast.md) | `client.sms.broadcasts.getBroadcast` |
| [Update a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/update-broadcast.md) | `client.sms.broadcasts.updateBroadcast` |
| [Delete a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/delete-broadcast.md) | `client.sms.broadcasts.deleteBroadcast` |
| [Upload recipients](https://www.vobiz.ai/docs/sms/api/broadcasts/upload-recipients.md) | `client.sms.broadcasts.uploadRecipients` |
| [List recipients](https://www.vobiz.ai/docs/sms/api/broadcasts/list-recipients.md) | `client.sms.broadcasts.listRecipients` |
| [Preview a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/preview-broadcast.md) | `client.sms.broadcasts.previewBroadcast` |
| [Export results as CSV](https://www.vobiz.ai/docs/sms/api/broadcasts/export-broadcast.md) | `client.sms.broadcasts.exportBroadcast` |
| [Launch a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/launch-broadcast.md) | `client.sms.broadcasts.launchBroadcast` |
| [Pause a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/pause-broadcast.md) | `client.sms.broadcasts.pauseBroadcast` |
| [Resume a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/resume-broadcast.md) | `client.sms.broadcasts.resumeBroadcast` |
| [Cancel a broadcast](https://www.vobiz.ai/docs/sms/api/broadcasts/cancel-broadcast.md) | `client.sms.broadcasts.cancelBroadcast` |

## RCS Senders

| Operation | Method |
| - | - |
| [Create an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/create-sender.md) | `client.sms.rcsSenders.createSender` |
| [List RCS senders](https://www.vobiz.ai/docs/sms/api/senders/list-senders.md) | `client.sms.rcsSenders.listSenders` |
| [Retrieve an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/get-sender.md) | `client.sms.rcsSenders.getSender` |
| [Update an RCS sender](https://www.vobiz.ai/docs/sms/api/senders/update-sender.md) | `client.sms.rcsSenders.updateSender` |
| [Refresh sender status](https://www.vobiz.ai/docs/sms/api/senders/get-sender-status.md) | `client.sms.rcsSenders.getSenderStatus` |
| [Create a template](https://www.vobiz.ai/docs/sms/api/senders/create-template.md) | `client.sms.rcsSenders.createTemplate` |
| [List templates](https://www.vobiz.ai/docs/sms/api/senders/list-templates.md) | `client.sms.rcsSenders.listTemplates` |
| [Retrieve a template](https://www.vobiz.ai/docs/sms/api/senders/get-template.md) | `client.sms.rcsSenders.getTemplate` |
| [Delete a template](https://www.vobiz.ai/docs/sms/api/senders/delete-template.md) | `client.sms.rcsSenders.deleteTemplate` |
| [Refresh template status](https://www.vobiz.ai/docs/sms/api/senders/get-template-status.md) | `client.sms.rcsSenders.getTemplateStatus` |

## 10DLC Brands

| Operation | Method |
| - | - |
| [Create a brand](https://www.vobiz.ai/docs/sms/api/10dlc/create-brand.md) | `client.sms.brands.createBrand` |
| [List brands](https://www.vobiz.ai/docs/sms/api/10dlc/list-brands.md) | `client.sms.brands.listBrands` |
| [Retrieve a brand](https://www.vobiz.ai/docs/sms/api/10dlc/get-brand.md) | `client.sms.brands.getBrand` |
| [Update a brand](https://www.vobiz.ai/docs/sms/api/10dlc/update-brand.md) | `client.sms.brands.updateBrand` |
| [Delete a brand](https://www.vobiz.ai/docs/sms/api/10dlc/delete-brand.md) | `client.sms.brands.deleteBrand` |
| [Register a brand](https://www.vobiz.ai/docs/sms/api/10dlc/register-brand.md) | `client.sms.brands.registerBrand` |
| [List brand registrar statuses](https://www.vobiz.ai/docs/sms/api/10dlc/brand-registrar-statuses.md) | `client.sms.brands.brandRegistrarStatuses` |
| [Request brand authentication](https://www.vobiz.ai/docs/sms/api/10dlc/brand-auth-verification.md) | `client.sms.brands.brandAuthVerification` |
| [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.vetBrand` |
| [List brand vets](https://www.vobiz.ai/docs/sms/api/10dlc/list-brand-vets.md) | `client.sms.brands.listBrandVets` |

## 10DLC Campaigns

| Operation | Method |
| - | - |
| [Create a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/create-campaign.md) | `client.sms.campaigns.createCampaign` |
| [List campaigns](https://www.vobiz.ai/docs/sms/api/10dlc/list-campaigns.md) | `client.sms.campaigns.listCampaigns` |
| [Create a toll-free campaign](https://www.vobiz.ai/docs/sms/api/10dlc/create-toll-free-campaign.md) | `client.sms.campaigns.createTollFreeCampaign` |
| [List campaign priorities](https://www.vobiz.ai/docs/sms/api/10dlc/campaign-priorities.md) | `client.sms.campaigns.campaignPriorities` |
| [Retrieve a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/get-campaign.md) | `client.sms.campaigns.getCampaign` |
| [Update a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/update-campaign.md) | `client.sms.campaigns.updateCampaign` |
| [Delete a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/delete-campaign.md) | `client.sms.campaigns.deleteCampaign` |
| [Register a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/register-campaign.md) | `client.sms.campaigns.registerCampaign` |
| [Deregister a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/deregister-campaign.md) | `client.sms.campaigns.deregisterCampaign` |
| [Appeal a campaign rejection](https://www.vobiz.ai/docs/sms/api/10dlc/appeal-campaign.md) | `client.sms.campaigns.appealCampaign` |
| [Update a campaign registration](https://www.vobiz.ai/docs/sms/api/10dlc/update-campaign-registration.md) | `client.sms.campaigns.updateCampaignRegistration` |
| [List campaign network statuses](https://www.vobiz.ai/docs/sms/api/10dlc/campaign-network-statuses.md) | `client.sms.campaigns.campaignNetworkStatuses` |
| [List campaign numbers](https://www.vobiz.ai/docs/sms/api/10dlc/list-campaign-numbers.md) | `client.sms.campaigns.listCampaignNumbers` |
| [Add numbers to a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/add-campaign-numbers.md) | `client.sms.campaigns.addCampaignNumbers` |
| [Remove numbers from a campaign](https://www.vobiz.ai/docs/sms/api/10dlc/remove-campaign-numbers.md) | `client.sms.campaigns.removeCampaignNumbers` |
| [Upload a document](https://www.vobiz.ai/docs/sms/api/10dlc/upload-document.md) | `client.sms.campaigns.uploadDocument` |
| [Download a document](https://www.vobiz.ai/docs/sms/api/10dlc/get-document.md) | `client.sms.campaigns.getDocument` |

## Other languages

The same reference for [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), [Ruby](https://www.vobiz.ai/docs/sms/sdks/ruby.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.