client.sms. The same client you use for voice sends SMS, MMS and RCS, so there is nothing extra to install or configure.
Node.js
Install and set up
Python
Install and set up
Go
Install and set up
Java
Install and set up
Ruby
Install and set up
C#
Install and set up
PHP
Install and set up
How the SDKs map to the API
- One namespace. Messaging lives under
client.sms, grouped by resource:messages,numbers,coverage,conversations,optOuts,webhooks,broadcasts,rcsSenders,brandsandcampaigns(snake_case or PascalCase in languages that use it). - One method per endpoint. Each method is named after the operation, for example
sendMessage/send_messagefor Send a message. The full list is in the method reference below. - Same credentials. The client sends your Auth ID and Auth Token as
X-Auth-IDandX-Auth-Tokenon every request. - Phone numbers in paths. Pass E.164 numbers such as
+14155550123as-is. The SDKs URL-encode them for you. - Typed responses. Responses are returned as typed objects, so field names follow each language’s conventions (
idempotencyKeyin JSON isidempotency_keyin Python and Ruby).
Send a message
import { VobizClient } from "@vobiz/sdk";
const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" });
await client.sms.messages.sendMessage({
from: "+14155550100",
to: ["+14155550123"],
channel: "sms",
text: "Your verification code is 482913",
idempotencyKey: "otp-482913-user-77"
})
from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.messages.send_message(
from_="+14155550100",
to=[
"+14155550123"
],
channel="sms",
text="Your verification code is 482913",
idempotency_key="otp-482913-user-77",
)
import (
"context"
vobiz "github.com/vobiz-ai/Vobiz-Go-SDK"
"github.com/vobiz-ai/Vobiz-Go-SDK/client"
"github.com/vobiz-ai/Vobiz-Go-SDK/option"
"github.com/vobiz-ai/Vobiz-Go-SDK/sms"
)
c := client.NewClient(
option.WithAPIKey("MA_XXXXXXXX"),
option.WithAuthToken("YOUR_AUTH_TOKEN"),
)
request := &sms.SendMessageRequest{
From: "+14155550100",
To: []string{
"+14155550123",
},
Channel: sms.SendMessageRequestChannelSms,
Text: vobiz.String(
"Your verification code is 482913",
),
IdempotencyKey: vobiz.String(
"otp-482913-user-77",
),
}
c.Sms.Messages.SendMessage(
context.TODO(),
request,
)
import com.vobiz.api.VobizApiClient;
VobizApiClient client = VobizApiClient
.builder()
.apiKey("MA_XXXXXXXX")
.authToken("YOUR_AUTH_TOKEN")
.build();
client.sms().messages().sendMessage(
SendMessageRequest
.builder()
.from("+14155550100")
.channel(SendMessageRequestChannel.SMS)
.to(
Arrays.asList("+14155550123")
)
.text("Your verification code is 482913")
.idempotencyKey("otp-482913-user-77")
.build()
);
require 'vobiz'
client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN')
client.sms.messages.send_message(
from: "+14155550100",
to: ["+14155550123"],
channel: "sms",
text: "Your verification code is 482913",
idempotency_key: "otp-482913-user-77"
)
using Vobiz;
using Vobiz.Sms;
var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX");
await client.Sms.Messages.SendMessageAsync(
new SendMessageRequest
{
From = "+14155550100",
To = new List<string>() { "+14155550123" },
Channel = SendMessageRequestChannel.Sms,
Text = "Your verification code is 482913",
IdempotencyKey = "otp-482913-user-77",
}
);
<?php
require 'vendor/autoload.php';
use Vobiz\VobizClient;
$client = new VobizClient(apiKey: 'MA_XXXXXXXX', authToken: 'YOUR_AUTH_TOKEN');
$client->sms->messages->sendMessage(
new SendMessageRequest([
'from' => '+14155550100',
'to' => [
'+14155550123',
],
'channel' => SendMessageRequestChannel::Sms->value,
'text' => 'Your verification code is 482913',
'idempotencyKey' => 'otp-482913-user-77',
]),
);
Sending, buying numbers and launching broadcasts move money and reach real people. Run these calls with your own credentials and numbers.
Handle errors
Every non-2xx response raises a typed error named after its status, carrying the status code and the API’s{"error": "..."} body. The Messaging errors are BadRequestError (400), UnauthorizedError (401), PaymentRequiredError (402), NotFoundError (404), ConflictError (409), ContentTooLargeError (413), UnprocessableEntityError (422), InternalServerError (500), BadGatewayError (502) and ServiceUnavailableError (503). See Errors for when each one is returned.
import { Vobiz, VobizError } from "@vobiz/sdk";
try {
await client.sms.messages.sendMessage({
from: "+14155550100",
to: ["+14155550123"],
channel: "sms",
text: "Your verification code is 482913",
idempotencyKey: "otp-482913-user-77",
});
} catch (err) {
if (err instanceof Vobiz.sms.UnprocessableEntityError) {
// The recipient has opted out. Remove them from your list.
} else if (err instanceof VobizError) {
console.error(err.statusCode, err.body); // { error: "..." }
} else {
throw err;
}
}
from vobiz.core.api_error import ApiError
from vobiz.sms.errors import UnprocessableEntityError
try:
client.sms.messages.send_message(
from_="+14155550100",
to=["+14155550123"],
channel="sms",
text="Your verification code is 482913",
idempotency_key="otp-482913-user-77",
)
except UnprocessableEntityError:
pass # The recipient has opted out. Remove them from your list.
except ApiError as err:
print(err.status_code, err.body) # {'error': '...'}
A
502 on send means nothing was recorded. Retry with the same idempotencyKey; a key that already sent returns the original message instead of sending twice.Method reference
Every Messaging API operation and the SDK method that calls it. Each operation links to its API reference page, which shows a complete example in every language.- Node.js
- Python
- Go
- Java
- Ruby
- C#
- PHP
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | client.sms.messages.sendMessage |
| List messages | client.sms.messages.listMessages |
| Preview message cost | client.sms.messages.previewMessageCost |
| Check RCS reachability | client.sms.messages.checkRcsReachability |
| Retrieve a message | client.sms.messages.getMessage |
| Operation | Method |
|---|---|
| List your numbers | client.sms.numbers.listNumbers |
| List countries in stock | client.sms.numbers.listCountries |
| Search available numbers | client.sms.numbers.searchAvailableNumbers |
| Purchase a number | client.sms.numbers.purchaseNumber |
| List number purchases | client.sms.numbers.listPurchases |
| Release a number | client.sms.numbers.releaseNumber |
| Operation | Method |
|---|---|
| List coverage | client.sms.coverage.listCoverage |
| Retrieve country coverage | client.sms.coverage.getCoverage |
| Operation | Method |
|---|---|
| List conversations | client.sms.conversations.listConversations |
| Count unread messages | client.sms.conversations.unreadCount |
| Retrieve a conversation | client.sms.conversations.getConversation |
| List conversation messages | client.sms.conversations.listConversationMessages |
| Mark a conversation read | client.sms.conversations.markConversationRead |
| Operation | Method |
|---|---|
| Create an opt-out | client.sms.optOuts.createOptOut |
| List opt-outs | client.sms.optOuts.listOptOuts |
| Check an opt-out | client.sms.optOuts.checkOptOut |
| Delete an opt-out | client.sms.optOuts.deleteOptOut |
| Operation | Method |
|---|---|
| Create a webhook | client.sms.webhooks.createWebhook |
| List webhooks | client.sms.webhooks.listWebhooks |
| Retrieve a webhook | client.sms.webhooks.getWebhook |
| Update a webhook | client.sms.webhooks.updateWebhook |
| Delete a webhook | client.sms.webhooks.deleteWebhook |
| Operation | Method |
|---|---|
| Create a broadcast | client.sms.broadcasts.createBroadcast |
| List broadcasts | client.sms.broadcasts.listBroadcasts |
| Retrieve a broadcast | client.sms.broadcasts.getBroadcast |
| Update a broadcast | client.sms.broadcasts.updateBroadcast |
| Delete a broadcast | client.sms.broadcasts.deleteBroadcast |
| Upload recipients | client.sms.broadcasts.uploadRecipients |
| List recipients | client.sms.broadcasts.listRecipients |
| Preview a broadcast | client.sms.broadcasts.previewBroadcast |
| Export results as CSV | client.sms.broadcasts.exportBroadcast |
| Launch a broadcast | client.sms.broadcasts.launchBroadcast |
| Pause a broadcast | client.sms.broadcasts.pauseBroadcast |
| Resume a broadcast | client.sms.broadcasts.resumeBroadcast |
| Cancel a broadcast | client.sms.broadcasts.cancelBroadcast |
| Operation | Method |
|---|---|
| Create an RCS sender | client.sms.rcsSenders.createSender |
| List RCS senders | client.sms.rcsSenders.listSenders |
| Retrieve an RCS sender | client.sms.rcsSenders.getSender |
| Update an RCS sender | client.sms.rcsSenders.updateSender |
| Refresh sender status | client.sms.rcsSenders.getSenderStatus |
| Create a template | client.sms.rcsSenders.createTemplate |
| List templates | client.sms.rcsSenders.listTemplates |
| Retrieve a template | client.sms.rcsSenders.getTemplate |
| Delete a template | client.sms.rcsSenders.deleteTemplate |
| Refresh template status | client.sms.rcsSenders.getTemplateStatus |
| Operation | Method |
|---|---|
| Create a brand | client.sms.brands.createBrand |
| List brands | client.sms.brands.listBrands |
| Retrieve a brand | client.sms.brands.getBrand |
| Update a brand | client.sms.brands.updateBrand |
| Delete a brand | client.sms.brands.deleteBrand |
| Register a brand | client.sms.brands.registerBrand |
| List brand registrar statuses | client.sms.brands.brandRegistrarStatuses |
| Request brand authentication | client.sms.brands.brandAuthVerification |
| Resend brand 2FA verification | client.sms.brands.resend2Fa |
| Vet a brand | client.sms.brands.vetBrand |
| List brand vets | client.sms.brands.listBrandVets |
| Operation | Method |
|---|---|
| Create a campaign | client.sms.campaigns.createCampaign |
| List campaigns | client.sms.campaigns.listCampaigns |
| Create a toll-free campaign | client.sms.campaigns.createTollFreeCampaign |
| List campaign priorities | client.sms.campaigns.campaignPriorities |
| Retrieve a campaign | client.sms.campaigns.getCampaign |
| Update a campaign | client.sms.campaigns.updateCampaign |
| Delete a campaign | client.sms.campaigns.deleteCampaign |
| Register a campaign | client.sms.campaigns.registerCampaign |
| Deregister a campaign | client.sms.campaigns.deregisterCampaign |
| Appeal a campaign rejection | client.sms.campaigns.appealCampaign |
| Update a campaign registration | client.sms.campaigns.updateCampaignRegistration |
| List campaign network statuses | client.sms.campaigns.campaignNetworkStatuses |
| List campaign numbers | client.sms.campaigns.listCampaignNumbers |
| Add numbers to a campaign | client.sms.campaigns.addCampaignNumbers |
| Remove numbers from a campaign | client.sms.campaigns.removeCampaignNumbers |
| Upload a document | client.sms.campaigns.uploadDocument |
| Download a document | client.sms.campaigns.getDocument |
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | client.sms.messages.send_message |
| List messages | client.sms.messages.list_messages |
| Preview message cost | client.sms.messages.preview_message_cost |
| Check RCS reachability | client.sms.messages.check_rcs_reachability |
| Retrieve a message | client.sms.messages.get_message |
| Operation | Method |
|---|---|
| List your numbers | client.sms.numbers.list_numbers |
| List countries in stock | client.sms.numbers.list_countries |
| Search available numbers | client.sms.numbers.search_available_numbers |
| Purchase a number | client.sms.numbers.purchase_number |
| List number purchases | client.sms.numbers.list_purchases |
| Release a number | client.sms.numbers.release_number |
| Operation | Method |
|---|---|
| List coverage | client.sms.coverage.list_coverage |
| Retrieve country coverage | client.sms.coverage.get_coverage |
| Operation | Method |
|---|---|
| List conversations | client.sms.conversations.list_conversations |
| Count unread messages | client.sms.conversations.unread_count |
| Retrieve a conversation | client.sms.conversations.get_conversation |
| List conversation messages | client.sms.conversations.list_conversation_messages |
| Mark a conversation read | client.sms.conversations.mark_conversation_read |
| Operation | Method |
|---|---|
| Create an opt-out | client.sms.opt_outs.create_opt_out |
| List opt-outs | client.sms.opt_outs.list_opt_outs |
| Check an opt-out | client.sms.opt_outs.check_opt_out |
| Delete an opt-out | client.sms.opt_outs.delete_opt_out |
| Operation | Method |
|---|---|
| Create a webhook | client.sms.webhooks.create_webhook |
| List webhooks | client.sms.webhooks.list_webhooks |
| Retrieve a webhook | client.sms.webhooks.get_webhook |
| Update a webhook | client.sms.webhooks.update_webhook |
| Delete a webhook | client.sms.webhooks.delete_webhook |
| Operation | Method |
|---|---|
| Create a broadcast | client.sms.broadcasts.create_broadcast |
| List broadcasts | client.sms.broadcasts.list_broadcasts |
| Retrieve a broadcast | client.sms.broadcasts.get_broadcast |
| Update a broadcast | client.sms.broadcasts.update_broadcast |
| Delete a broadcast | client.sms.broadcasts.delete_broadcast |
| Upload recipients | client.sms.broadcasts.upload_recipients |
| List recipients | client.sms.broadcasts.list_recipients |
| Preview a broadcast | client.sms.broadcasts.preview_broadcast |
| Export results as CSV | client.sms.broadcasts.export_broadcast |
| Launch a broadcast | client.sms.broadcasts.launch_broadcast |
| Pause a broadcast | client.sms.broadcasts.pause_broadcast |
| Resume a broadcast | client.sms.broadcasts.resume_broadcast |
| Cancel a broadcast | client.sms.broadcasts.cancel_broadcast |
| Operation | Method |
|---|---|
| Create an RCS sender | client.sms.rcs_senders.create_sender |
| List RCS senders | client.sms.rcs_senders.list_senders |
| Retrieve an RCS sender | client.sms.rcs_senders.get_sender |
| Update an RCS sender | client.sms.rcs_senders.update_sender |
| Refresh sender status | client.sms.rcs_senders.get_sender_status |
| Create a template | client.sms.rcs_senders.create_template |
| List templates | client.sms.rcs_senders.list_templates |
| Retrieve a template | client.sms.rcs_senders.get_template |
| Delete a template | client.sms.rcs_senders.delete_template |
| Refresh template status | client.sms.rcs_senders.get_template_status |
| Operation | Method |
|---|---|
| Create a brand | client.sms.brands.create_brand |
| List brands | client.sms.brands.list_brands |
| Retrieve a brand | client.sms.brands.get_brand |
| Update a brand | client.sms.brands.update_brand |
| Delete a brand | client.sms.brands.delete_brand |
| Register a brand | client.sms.brands.register_brand |
| List brand registrar statuses | client.sms.brands.brand_registrar_statuses |
| Request brand authentication | client.sms.brands.brand_auth_verification |
| Resend brand 2FA verification | client.sms.brands.resend2fa |
| Vet a brand | client.sms.brands.vet_brand |
| List brand vets | client.sms.brands.list_brand_vets |
| Operation | Method |
|---|---|
| Create a campaign | client.sms.campaigns.create_campaign |
| List campaigns | client.sms.campaigns.list_campaigns |
| Create a toll-free campaign | client.sms.campaigns.create_toll_free_campaign |
| List campaign priorities | client.sms.campaigns.campaign_priorities |
| Retrieve a campaign | client.sms.campaigns.get_campaign |
| Update a campaign | client.sms.campaigns.update_campaign |
| Delete a campaign | client.sms.campaigns.delete_campaign |
| Register a campaign | client.sms.campaigns.register_campaign |
| Deregister a campaign | client.sms.campaigns.deregister_campaign |
| Appeal a campaign rejection | client.sms.campaigns.appeal_campaign |
| Update a campaign registration | client.sms.campaigns.update_campaign_registration |
| List campaign network statuses | client.sms.campaigns.campaign_network_statuses |
| List campaign numbers | client.sms.campaigns.list_campaign_numbers |
| Add numbers to a campaign | client.sms.campaigns.add_campaign_numbers |
| Remove numbers from a campaign | client.sms.campaigns.remove_campaign_numbers |
| Upload a document | client.sms.campaigns.upload_document |
| Download a document | client.sms.campaigns.get_document |
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | client.Sms.Messages.SendMessage |
| List messages | client.Sms.Messages.ListMessages |
| Preview message cost | client.Sms.Messages.PreviewMessageCost |
| Check RCS reachability | client.Sms.Messages.CheckRcsReachability |
| Retrieve a message | client.Sms.Messages.GetMessage |
| Operation | Method |
|---|---|
| List your numbers | client.Sms.Numbers.ListNumbers |
| List countries in stock | client.Sms.Numbers.ListCountries |
| Search available numbers | client.Sms.Numbers.SearchAvailableNumbers |
| Purchase a number | client.Sms.Numbers.PurchaseNumber |
| List number purchases | client.Sms.Numbers.ListPurchases |
| Release a number | client.Sms.Numbers.ReleaseNumber |
| Operation | Method |
|---|---|
| List coverage | client.Sms.Coverage.ListCoverage |
| Retrieve country coverage | client.Sms.Coverage.GetCoverage |
| Operation | Method |
|---|---|
| List conversations | client.Sms.Conversations.ListConversations |
| Count unread messages | client.Sms.Conversations.UnreadCount |
| Retrieve a conversation | client.Sms.Conversations.GetConversation |
| List conversation messages | client.Sms.Conversations.ListConversationMessages |
| Mark a conversation read | client.Sms.Conversations.MarkConversationRead |
| Operation | Method |
|---|---|
| Create an opt-out | client.Sms.OptOuts.CreateOptOut |
| List opt-outs | client.Sms.OptOuts.ListOptOuts |
| Check an opt-out | client.Sms.OptOuts.CheckOptOut |
| Delete an opt-out | client.Sms.OptOuts.DeleteOptOut |
| Operation | Method |
|---|---|
| Create a webhook | client.Sms.Webhooks.CreateWebhook |
| List webhooks | client.Sms.Webhooks.ListWebhooks |
| Retrieve a webhook | client.Sms.Webhooks.GetWebhook |
| Update a webhook | client.Sms.Webhooks.UpdateWebhook |
| Delete a webhook | client.Sms.Webhooks.DeleteWebhook |
| Operation | Method |
|---|---|
| Create a broadcast | client.Sms.Broadcasts.CreateBroadcast |
| List broadcasts | client.Sms.Broadcasts.ListBroadcasts |
| Retrieve a broadcast | client.Sms.Broadcasts.GetBroadcast |
| Update a broadcast | client.Sms.Broadcasts.UpdateBroadcast |
| Delete a broadcast | client.Sms.Broadcasts.DeleteBroadcast |
| Upload recipients | client.Sms.Broadcasts.UploadRecipients |
| List recipients | client.Sms.Broadcasts.ListRecipients |
| Preview a broadcast | client.Sms.Broadcasts.PreviewBroadcast |
| Export results as CSV | client.Sms.Broadcasts.ExportBroadcast |
| Launch a broadcast | client.Sms.Broadcasts.LaunchBroadcast |
| Pause a broadcast | client.Sms.Broadcasts.PauseBroadcast |
| Resume a broadcast | client.Sms.Broadcasts.ResumeBroadcast |
| Cancel a broadcast | client.Sms.Broadcasts.CancelBroadcast |
| Operation | Method |
|---|---|
| Create an RCS sender | client.Sms.RcsSenders.CreateSender |
| List RCS senders | client.Sms.RcsSenders.ListSenders |
| Retrieve an RCS sender | client.Sms.RcsSenders.GetSender |
| Update an RCS sender | client.Sms.RcsSenders.UpdateSender |
| Refresh sender status | client.Sms.RcsSenders.GetSenderStatus |
| Create a template | client.Sms.RcsSenders.CreateTemplate |
| List templates | client.Sms.RcsSenders.ListTemplates |
| Retrieve a template | client.Sms.RcsSenders.GetTemplate |
| Delete a template | client.Sms.RcsSenders.DeleteTemplate |
| Refresh template status | client.Sms.RcsSenders.GetTemplateStatus |
| Operation | Method |
|---|---|
| Create a brand | client.Sms.Brands.CreateBrand |
| List brands | client.Sms.Brands.ListBrands |
| Retrieve a brand | client.Sms.Brands.GetBrand |
| Update a brand | client.Sms.Brands.UpdateBrand |
| Delete a brand | client.Sms.Brands.DeleteBrand |
| Register a brand | client.Sms.Brands.RegisterBrand |
| List brand registrar statuses | client.Sms.Brands.BrandRegistrarStatuses |
| Request brand authentication | client.Sms.Brands.BrandAuthVerification |
| Resend brand 2FA verification | client.Sms.Brands.Resend2Fa |
| Vet a brand | client.Sms.Brands.VetBrand |
| List brand vets | client.Sms.Brands.ListBrandVets |
| Operation | Method |
|---|---|
| Create a campaign | client.Sms.Campaigns.CreateCampaign |
| List campaigns | client.Sms.Campaigns.ListCampaigns |
| Create a toll-free campaign | client.Sms.Campaigns.CreateTollFreeCampaign |
| List campaign priorities | client.Sms.Campaigns.CampaignPriorities |
| Retrieve a campaign | client.Sms.Campaigns.GetCampaign |
| Update a campaign | client.Sms.Campaigns.UpdateCampaign |
| Delete a campaign | client.Sms.Campaigns.DeleteCampaign |
| Register a campaign | client.Sms.Campaigns.RegisterCampaign |
| Deregister a campaign | client.Sms.Campaigns.DeregisterCampaign |
| Appeal a campaign rejection | client.Sms.Campaigns.AppealCampaign |
| Update a campaign registration | client.Sms.Campaigns.UpdateCampaignRegistration |
| List campaign network statuses | client.Sms.Campaigns.CampaignNetworkStatuses |
| List campaign numbers | client.Sms.Campaigns.ListCampaignNumbers |
| Add numbers to a campaign | client.Sms.Campaigns.AddCampaignNumbers |
| Remove numbers from a campaign | client.Sms.Campaigns.RemoveCampaignNumbers |
| Upload a document | client.Sms.Campaigns.UploadDocument |
| Download a document | client.Sms.Campaigns.GetDocument |
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | client.sms().messages().sendMessage |
| List messages | client.sms().messages().listMessages |
| Preview message cost | client.sms().messages().previewMessageCost |
| Check RCS reachability | client.sms().messages().checkRcsReachability |
| Retrieve a message | client.sms().messages().getMessage |
| Operation | Method |
|---|---|
| List your numbers | client.sms().numbers().listNumbers |
| List countries in stock | client.sms().numbers().listCountries |
| Search available numbers | client.sms().numbers().searchAvailableNumbers |
| Purchase a number | client.sms().numbers().purchaseNumber |
| List number purchases | client.sms().numbers().listPurchases |
| Release a number | client.sms().numbers().releaseNumber |
| Operation | Method |
|---|---|
| List coverage | client.sms().coverage().listCoverage |
| Retrieve country coverage | client.sms().coverage().getCoverage |
| Operation | Method |
|---|---|
| List conversations | client.sms().conversations().listConversations |
| Count unread messages | client.sms().conversations().unreadCount |
| Retrieve a conversation | client.sms().conversations().getConversation |
| List conversation messages | client.sms().conversations().listConversationMessages |
| Mark a conversation read | client.sms().conversations().markConversationRead |
| Operation | Method |
|---|---|
| Create an opt-out | client.sms().optOuts().createOptOut |
| List opt-outs | client.sms().optOuts().listOptOuts |
| Check an opt-out | client.sms().optOuts().checkOptOut |
| Delete an opt-out | client.sms().optOuts().deleteOptOut |
| Operation | Method |
|---|---|
| Create a webhook | client.sms().webhooks().createWebhook |
| List webhooks | client.sms().webhooks().listWebhooks |
| Retrieve a webhook | client.sms().webhooks().getWebhook |
| Update a webhook | client.sms().webhooks().updateWebhook |
| Delete a webhook | client.sms().webhooks().deleteWebhook |
| Operation | Method |
|---|---|
| Create a broadcast | client.sms().broadcasts().createBroadcast |
| List broadcasts | client.sms().broadcasts().listBroadcasts |
| Retrieve a broadcast | client.sms().broadcasts().getBroadcast |
| Update a broadcast | client.sms().broadcasts().updateBroadcast |
| Delete a broadcast | client.sms().broadcasts().deleteBroadcast |
| Upload recipients | client.sms().broadcasts().uploadRecipients |
| List recipients | client.sms().broadcasts().listRecipients |
| Preview a broadcast | client.sms().broadcasts().previewBroadcast |
| Export results as CSV | client.sms().broadcasts().exportBroadcast |
| Launch a broadcast | client.sms().broadcasts().launchBroadcast |
| Pause a broadcast | client.sms().broadcasts().pauseBroadcast |
| Resume a broadcast | client.sms().broadcasts().resumeBroadcast |
| Cancel a broadcast | client.sms().broadcasts().cancelBroadcast |
| Operation | Method |
|---|---|
| Create an RCS sender | client.sms().rcsSenders().createSender |
| List RCS senders | client.sms().rcsSenders().listSenders |
| Retrieve an RCS sender | client.sms().rcsSenders().getSender |
| Update an RCS sender | client.sms().rcsSenders().updateSender |
| Refresh sender status | client.sms().rcsSenders().getSenderStatus |
| Create a template | client.sms().rcsSenders().createTemplate |
| List templates | client.sms().rcsSenders().listTemplates |
| Retrieve a template | client.sms().rcsSenders().getTemplate |
| Delete a template | client.sms().rcsSenders().deleteTemplate |
| Refresh template status | client.sms().rcsSenders().getTemplateStatus |
| Operation | Method |
|---|---|
| Create a brand | client.sms().brands().createBrand |
| List brands | client.sms().brands().listBrands |
| Retrieve a brand | client.sms().brands().getBrand |
| Update a brand | client.sms().brands().updateBrand |
| Delete a brand | client.sms().brands().deleteBrand |
| Register a brand | client.sms().brands().registerBrand |
| List brand registrar statuses | client.sms().brands().brandRegistrarStatuses |
| Request brand authentication | client.sms().brands().brandAuthVerification |
| Resend brand 2FA verification | client.sms().brands().resend2Fa |
| Vet a brand | client.sms().brands().vetBrand |
| List brand vets | client.sms().brands().listBrandVets |
| Operation | Method |
|---|---|
| Create a campaign | client.sms().campaigns().createCampaign |
| List campaigns | client.sms().campaigns().listCampaigns |
| Create a toll-free campaign | client.sms().campaigns().createTollFreeCampaign |
| List campaign priorities | client.sms().campaigns().campaignPriorities |
| Retrieve a campaign | client.sms().campaigns().getCampaign |
| Update a campaign | client.sms().campaigns().updateCampaign |
| Delete a campaign | client.sms().campaigns().deleteCampaign |
| Register a campaign | client.sms().campaigns().registerCampaign |
| Deregister a campaign | client.sms().campaigns().deregisterCampaign |
| Appeal a campaign rejection | client.sms().campaigns().appealCampaign |
| Update a campaign registration | client.sms().campaigns().updateCampaignRegistration |
| List campaign network statuses | client.sms().campaigns().campaignNetworkStatuses |
| List campaign numbers | client.sms().campaigns().listCampaignNumbers |
| Add numbers to a campaign | client.sms().campaigns().addCampaignNumbers |
| Remove numbers from a campaign | client.sms().campaigns().removeCampaignNumbers |
| Upload a document | client.sms().campaigns().uploadDocument |
| Download a document | client.sms().campaigns().getDocument |
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | client.sms.messages.send_message |
| List messages | client.sms.messages.list_messages |
| Preview message cost | client.sms.messages.preview_message_cost |
| Check RCS reachability | client.sms.messages.check_rcs_reachability |
| Retrieve a message | client.sms.messages.get_message |
| Operation | Method |
|---|---|
| List your numbers | client.sms.numbers.list_numbers |
| List countries in stock | client.sms.numbers.list_countries |
| Search available numbers | client.sms.numbers.search_available_numbers |
| Purchase a number | client.sms.numbers.purchase_number |
| List number purchases | client.sms.numbers.list_purchases |
| Release a number | client.sms.numbers.release_number |
| Operation | Method |
|---|---|
| List coverage | client.sms.coverage.list_coverage |
| Retrieve country coverage | client.sms.coverage.get_coverage |
| Operation | Method |
|---|---|
| List conversations | client.sms.conversations.list_conversations |
| Count unread messages | client.sms.conversations.unread_count |
| Retrieve a conversation | client.sms.conversations.get_conversation |
| List conversation messages | client.sms.conversations.list_conversation_messages |
| Mark a conversation read | client.sms.conversations.mark_conversation_read |
| Operation | Method |
|---|---|
| Create an opt-out | client.sms.opt_outs.create_opt_out |
| List opt-outs | client.sms.opt_outs.list_opt_outs |
| Check an opt-out | client.sms.opt_outs.check_opt_out |
| Delete an opt-out | client.sms.opt_outs.delete_opt_out |
| Operation | Method |
|---|---|
| Create a webhook | client.sms.webhooks.create_webhook |
| List webhooks | client.sms.webhooks.list_webhooks |
| Retrieve a webhook | client.sms.webhooks.get_webhook |
| Update a webhook | client.sms.webhooks.update_webhook |
| Delete a webhook | client.sms.webhooks.delete_webhook |
| Operation | Method |
|---|---|
| Create a broadcast | client.sms.broadcasts.create_broadcast |
| List broadcasts | client.sms.broadcasts.list_broadcasts |
| Retrieve a broadcast | client.sms.broadcasts.get_broadcast |
| Update a broadcast | client.sms.broadcasts.update_broadcast |
| Delete a broadcast | client.sms.broadcasts.delete_broadcast |
| Upload recipients | client.sms.broadcasts.upload_recipients |
| List recipients | client.sms.broadcasts.list_recipients |
| Preview a broadcast | client.sms.broadcasts.preview_broadcast |
| Export results as CSV | client.sms.broadcasts.export_broadcast |
| Launch a broadcast | client.sms.broadcasts.launch_broadcast |
| Pause a broadcast | client.sms.broadcasts.pause_broadcast |
| Resume a broadcast | client.sms.broadcasts.resume_broadcast |
| Cancel a broadcast | client.sms.broadcasts.cancel_broadcast |
| Operation | Method |
|---|---|
| Create an RCS sender | client.sms.rcs_senders.create_sender |
| List RCS senders | client.sms.rcs_senders.list_senders |
| Retrieve an RCS sender | client.sms.rcs_senders.get_sender |
| Update an RCS sender | client.sms.rcs_senders.update_sender |
| Refresh sender status | client.sms.rcs_senders.get_sender_status |
| Create a template | client.sms.rcs_senders.create_template |
| List templates | client.sms.rcs_senders.list_templates |
| Retrieve a template | client.sms.rcs_senders.get_template |
| Delete a template | client.sms.rcs_senders.delete_template |
| Refresh template status | client.sms.rcs_senders.get_template_status |
| Operation | Method |
|---|---|
| Create a brand | client.sms.brands.create_brand |
| List brands | client.sms.brands.list_brands |
| Retrieve a brand | client.sms.brands.get_brand |
| Update a brand | client.sms.brands.update_brand |
| Delete a brand | client.sms.brands.delete_brand |
| Register a brand | client.sms.brands.register_brand |
| List brand registrar statuses | client.sms.brands.brand_registrar_statuses |
| Request brand authentication | client.sms.brands.brand_auth_verification |
| Resend brand 2FA verification | client.sms.brands.resend2fa |
| Vet a brand | client.sms.brands.vet_brand |
| List brand vets | client.sms.brands.list_brand_vets |
| Operation | Method |
|---|---|
| Create a campaign | client.sms.campaigns.create_campaign |
| List campaigns | client.sms.campaigns.list_campaigns |
| Create a toll-free campaign | client.sms.campaigns.create_toll_free_campaign |
| List campaign priorities | client.sms.campaigns.campaign_priorities |
| Retrieve a campaign | client.sms.campaigns.get_campaign |
| Update a campaign | client.sms.campaigns.update_campaign |
| Delete a campaign | client.sms.campaigns.delete_campaign |
| Register a campaign | client.sms.campaigns.register_campaign |
| Deregister a campaign | client.sms.campaigns.deregister_campaign |
| Appeal a campaign rejection | client.sms.campaigns.appeal_campaign |
| Update a campaign registration | client.sms.campaigns.update_campaign_registration |
| List campaign network statuses | client.sms.campaigns.campaign_network_statuses |
| List campaign numbers | client.sms.campaigns.list_campaign_numbers |
| Add numbers to a campaign | client.sms.campaigns.add_campaign_numbers |
| Remove numbers from a campaign | client.sms.campaigns.remove_campaign_numbers |
| Upload a document | client.sms.campaigns.upload_document |
| Download a document | client.sms.campaigns.get_document |
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | client.Sms.Messages.SendMessageAsync |
| List messages | client.Sms.Messages.ListMessagesAsync |
| Preview message cost | client.Sms.Messages.PreviewMessageCostAsync |
| Check RCS reachability | client.Sms.Messages.CheckRcsReachabilityAsync |
| Retrieve a message | client.Sms.Messages.GetMessageAsync |
| Operation | Method |
|---|---|
| List your numbers | client.Sms.Numbers.ListNumbersAsync |
| List countries in stock | client.Sms.Numbers.ListCountriesAsync |
| Search available numbers | client.Sms.Numbers.SearchAvailableNumbersAsync |
| Purchase a number | client.Sms.Numbers.PurchaseNumberAsync |
| List number purchases | client.Sms.Numbers.ListPurchasesAsync |
| Release a number | client.Sms.Numbers.ReleaseNumberAsync |
| Operation | Method |
|---|---|
| List coverage | client.Sms.Coverage.ListCoverageAsync |
| Retrieve country coverage | client.Sms.Coverage.GetCoverageAsync |
| Operation | Method |
|---|---|
| List conversations | client.Sms.Conversations.ListConversationsAsync |
| Count unread messages | client.Sms.Conversations.UnreadCountAsync |
| Retrieve a conversation | client.Sms.Conversations.GetConversationAsync |
| List conversation messages | client.Sms.Conversations.ListConversationMessagesAsync |
| Mark a conversation read | client.Sms.Conversations.MarkConversationReadAsync |
| Operation | Method |
|---|---|
| Create an opt-out | client.Sms.OptOuts.CreateOptOutAsync |
| List opt-outs | client.Sms.OptOuts.ListOptOutsAsync |
| Check an opt-out | client.Sms.OptOuts.CheckOptOutAsync |
| Delete an opt-out | client.Sms.OptOuts.DeleteOptOutAsync |
| Operation | Method |
|---|---|
| Create a webhook | client.Sms.Webhooks.CreateWebhookAsync |
| List webhooks | client.Sms.Webhooks.ListWebhooksAsync |
| Retrieve a webhook | client.Sms.Webhooks.GetWebhookAsync |
| Update a webhook | client.Sms.Webhooks.UpdateWebhookAsync |
| Delete a webhook | client.Sms.Webhooks.DeleteWebhookAsync |
| Operation | Method |
|---|---|
| Create a broadcast | client.Sms.Broadcasts.CreateBroadcastAsync |
| List broadcasts | client.Sms.Broadcasts.ListBroadcastsAsync |
| Retrieve a broadcast | client.Sms.Broadcasts.GetBroadcastAsync |
| Update a broadcast | client.Sms.Broadcasts.UpdateBroadcastAsync |
| Delete a broadcast | client.Sms.Broadcasts.DeleteBroadcastAsync |
| Upload recipients | client.Sms.Broadcasts.UploadRecipientsAsync |
| List recipients | client.Sms.Broadcasts.ListRecipientsAsync |
| Preview a broadcast | client.Sms.Broadcasts.PreviewBroadcastAsync |
| Export results as CSV | client.Sms.Broadcasts.ExportBroadcastAsync |
| Launch a broadcast | client.Sms.Broadcasts.LaunchBroadcastAsync |
| Pause a broadcast | client.Sms.Broadcasts.PauseBroadcastAsync |
| Resume a broadcast | client.Sms.Broadcasts.ResumeBroadcastAsync |
| Cancel a broadcast | client.Sms.Broadcasts.CancelBroadcastAsync |
| Operation | Method |
|---|---|
| Create an RCS sender | client.Sms.RcsSenders.CreateSenderAsync |
| List RCS senders | client.Sms.RcsSenders.ListSendersAsync |
| Retrieve an RCS sender | client.Sms.RcsSenders.GetSenderAsync |
| Update an RCS sender | client.Sms.RcsSenders.UpdateSenderAsync |
| Refresh sender status | client.Sms.RcsSenders.GetSenderStatusAsync |
| Create a template | client.Sms.RcsSenders.CreateTemplateAsync |
| List templates | client.Sms.RcsSenders.ListTemplatesAsync |
| Retrieve a template | client.Sms.RcsSenders.GetTemplateAsync |
| Delete a template | client.Sms.RcsSenders.DeleteTemplateAsync |
| Refresh template status | client.Sms.RcsSenders.GetTemplateStatusAsync |
| Operation | Method |
|---|---|
| Create a brand | client.Sms.Brands.CreateBrandAsync |
| List brands | client.Sms.Brands.ListBrandsAsync |
| Retrieve a brand | client.Sms.Brands.GetBrandAsync |
| Update a brand | client.Sms.Brands.UpdateBrandAsync |
| Delete a brand | client.Sms.Brands.DeleteBrandAsync |
| Register a brand | client.Sms.Brands.RegisterBrandAsync |
| List brand registrar statuses | client.Sms.Brands.BrandRegistrarStatusesAsync |
| Request brand authentication | client.Sms.Brands.BrandAuthVerificationAsync |
| Resend brand 2FA verification | client.Sms.Brands.Resend2FaAsync |
| Vet a brand | client.Sms.Brands.VetBrandAsync |
| List brand vets | client.Sms.Brands.ListBrandVetsAsync |
| Operation | Method |
|---|---|
| Create a campaign | client.Sms.Campaigns.CreateCampaignAsync |
| List campaigns | client.Sms.Campaigns.ListCampaignsAsync |
| Create a toll-free campaign | client.Sms.Campaigns.CreateTollFreeCampaignAsync |
| List campaign priorities | client.Sms.Campaigns.CampaignPrioritiesAsync |
| Retrieve a campaign | client.Sms.Campaigns.GetCampaignAsync |
| Update a campaign | client.Sms.Campaigns.UpdateCampaignAsync |
| Delete a campaign | client.Sms.Campaigns.DeleteCampaignAsync |
| Register a campaign | client.Sms.Campaigns.RegisterCampaignAsync |
| Deregister a campaign | client.Sms.Campaigns.DeregisterCampaignAsync |
| Appeal a campaign rejection | client.Sms.Campaigns.AppealCampaignAsync |
| Update a campaign registration | client.Sms.Campaigns.UpdateCampaignRegistrationAsync |
| List campaign network statuses | client.Sms.Campaigns.CampaignNetworkStatusesAsync |
| List campaign numbers | client.Sms.Campaigns.ListCampaignNumbersAsync |
| Add numbers to a campaign | client.Sms.Campaigns.AddCampaignNumbersAsync |
| Remove numbers from a campaign | client.Sms.Campaigns.RemoveCampaignNumbersAsync |
| Upload a document | client.Sms.Campaigns.UploadDocumentAsync |
| Download a document | client.Sms.Campaigns.GetDocumentAsync |
Messages
Numbers
Coverage
Conversations
Opt-outs
Webhooks
Broadcasts
RCS Senders
10DLC Brands
10DLC Campaigns
| Operation | Method |
|---|---|
| Send a message | $client->sms->messages->sendMessage |
| List messages | $client->sms->messages->listMessages |
| Preview message cost | $client->sms->messages->previewMessageCost |
| Check RCS reachability | $client->sms->messages->checkRcsReachability |
| Retrieve a message | $client->sms->messages->getMessage |
| Operation | Method |
|---|---|
| List your numbers | $client->sms->numbers->listNumbers |
| List countries in stock | $client->sms->numbers->listCountries |
| Search available numbers | $client->sms->numbers->searchAvailableNumbers |
| Purchase a number | $client->sms->numbers->purchaseNumber |
| List number purchases | $client->sms->numbers->listPurchases |
| Release a number | $client->sms->numbers->releaseNumber |
| Operation | Method |
|---|---|
| List coverage | $client->sms->coverage->listCoverage |
| Retrieve country coverage | $client->sms->coverage->getCoverage |
| Operation | Method |
|---|---|
| List conversations | $client->sms->conversations->listConversations |
| Count unread messages | $client->sms->conversations->unreadCount |
| Retrieve a conversation | $client->sms->conversations->getConversation |
| List conversation messages | $client->sms->conversations->listConversationMessages |
| Mark a conversation read | $client->sms->conversations->markConversationRead |
| Operation | Method |
|---|---|
| Create an opt-out | $client->sms->optOuts->createOptOut |
| List opt-outs | $client->sms->optOuts->listOptOuts |
| Check an opt-out | $client->sms->optOuts->checkOptOut |
| Delete an opt-out | $client->sms->optOuts->deleteOptOut |
| Operation | Method |
|---|---|
| Create a webhook | $client->sms->webhooks->createWebhook |
| List webhooks | $client->sms->webhooks->listWebhooks |
| Retrieve a webhook | $client->sms->webhooks->getWebhook |
| Update a webhook | $client->sms->webhooks->updateWebhook |
| Delete a webhook | $client->sms->webhooks->deleteWebhook |
| Operation | Method |
|---|---|
| Create a broadcast | $client->sms->broadcasts->createBroadcast |
| List broadcasts | $client->sms->broadcasts->listBroadcasts |
| Retrieve a broadcast | $client->sms->broadcasts->getBroadcast |
| Update a broadcast | $client->sms->broadcasts->updateBroadcast |
| Delete a broadcast | $client->sms->broadcasts->deleteBroadcast |
| Upload recipients | $client->sms->broadcasts->uploadRecipients |
| List recipients | $client->sms->broadcasts->listRecipients |
| Preview a broadcast | $client->sms->broadcasts->previewBroadcast |
| Export results as CSV | $client->sms->broadcasts->exportBroadcast |
| Launch a broadcast | $client->sms->broadcasts->launchBroadcast |
| Pause a broadcast | $client->sms->broadcasts->pauseBroadcast |
| Resume a broadcast | $client->sms->broadcasts->resumeBroadcast |
| Cancel a broadcast | $client->sms->broadcasts->cancelBroadcast |
| Operation | Method |
|---|---|
| Create an RCS sender | $client->sms->rcsSenders->createSender |
| List RCS senders | $client->sms->rcsSenders->listSenders |
| Retrieve an RCS sender | $client->sms->rcsSenders->getSender |
| Update an RCS sender | $client->sms->rcsSenders->updateSender |
| Refresh sender status | $client->sms->rcsSenders->getSenderStatus |
| Create a template | $client->sms->rcsSenders->createTemplate |
| List templates | $client->sms->rcsSenders->listTemplates |
| Retrieve a template | $client->sms->rcsSenders->getTemplate |
| Delete a template | $client->sms->rcsSenders->deleteTemplate |
| Refresh template status | $client->sms->rcsSenders->getTemplateStatus |
| Operation | Method |
|---|---|
| Create a brand | $client->sms->brands->createBrand |
| List brands | $client->sms->brands->listBrands |
| Retrieve a brand | $client->sms->brands->getBrand |
| Update a brand | $client->sms->brands->updateBrand |
| Delete a brand | $client->sms->brands->deleteBrand |
| Register a brand | $client->sms->brands->registerBrand |
| List brand registrar statuses | $client->sms->brands->brandRegistrarStatuses |
| Request brand authentication | $client->sms->brands->brandAuthVerification |
| Resend brand 2FA verification | $client->sms->brands->resend2Fa |
| Vet a brand | $client->sms->brands->vetBrand |
| List brand vets | $client->sms->brands->listBrandVets |
| Operation | Method |
|---|---|
| Create a campaign | $client->sms->campaigns->createCampaign |
| List campaigns | $client->sms->campaigns->listCampaigns |
| Create a toll-free campaign | $client->sms->campaigns->createTollFreeCampaign |
| List campaign priorities | $client->sms->campaigns->campaignPriorities |
| Retrieve a campaign | $client->sms->campaigns->getCampaign |
| Update a campaign | $client->sms->campaigns->updateCampaign |
| Delete a campaign | $client->sms->campaigns->deleteCampaign |
| Register a campaign | $client->sms->campaigns->registerCampaign |
| Deregister a campaign | $client->sms->campaigns->deregisterCampaign |
| Appeal a campaign rejection | $client->sms->campaigns->appealCampaign |
| Update a campaign registration | $client->sms->campaigns->updateCampaignRegistration |
| List campaign network statuses | $client->sms->campaigns->campaignNetworkStatuses |
| List campaign numbers | $client->sms->campaigns->listCampaignNumbers |
| Add numbers to a campaign | $client->sms->campaigns->addCampaignNumbers |
| Remove numbers from a campaign | $client->sms->campaigns->removeCampaignNumbers |
| Upload a document | $client->sms->campaigns->uploadDocument |
| Download a document | $client->sms->campaigns->getDocument |