VoxLink.ai
Start Free

API Reference

Send SMS

Send an SMS message using your phone number

On this page

This endpoint allows you to send SMS messages using your purchased phone numbers. The SMS will be sent via Twilio and costs will be automatically deducted from your account balance.

Request Body

fromintegerrequired

The ID of your phone number to send the SMS from (must be SMS-capable)

tostringrequired

The recipient's phone number in international format (e.g., "+1234567890")

bodystringrequired

The SMS message content (max 300 characters)

Response

messagestring

Success message confirming SMS was sent

dataobject

idinteger

  The unique identifier of the SMS record

phone_number_idinteger

  The ID of the phone number used to send the SMS

tostring

  The recipient's phone number in E.164 format

bodystring

  The SMS message content

user_idinteger

  The ID of the user who sent the SMS

segmentsinteger

  Number of SMS segments (for billing purposes)

segment_pricenumber

  Cost per SMS segment

total_costnumber

  Total cost of the SMS (segment_price * segments)

statusstring

  The current status of the SMS

sms_sidstring

  Twilio SMS SID for tracking

created_atstring

  The date and time when the SMS was created

updated_atstring

  The date and time when the SMS was last updated

Error Responses

400 Bad Request

messagestring

  Error message describing the issue (invalid phone number, insufficient balance, etc.)

500 Internal Server Error

messagestring

  Error message indicating SMS sending failure

errorstring

  Detailed error information

{
  "message": "SMS sent successfully",
  "data": {
    "id": 456,
    "phone_number_id": 78,
    "to": "+1234567890",
    "body": "Hello! This is a test message from Your Company. How can we help you today?",
    "user_id": 1,
    "segments": 1,
    "segment_price": 0.0075,
    "total_cost": 0.0075,
    "status": "sent",
    "sms_sid": "SM1234567890abcdef1234567890abcdef",
    "created_at": "2025-08-04 15:30:00",
    "updated_at": "2025-08-04 15:30:02"
  }
}

{
  "message": "From number not found"
}

{
  "message": "Invalid to phone number"
}

{
  "message": "Insufficient balance"
}

{
  "message": "From number is not SMS capable"
}

{
  "message": "Failed to send SMS",
  "error": "Twilio API error details"
}

Notes

  • The sender phone number must belong to the authenticated user
  • The sender phone number must be SMS-capable
  • The phone number subscription must be active (not expired)
  • Sufficient account balance is required to cover SMS costs
  • Phone numbers are automatically formatted to E.164 format
  • SMS costs vary by destination country and are charged per segment
  • Long messages may be split into multiple segments, increasing the cost
  • The recipient phone number must be valid according to international standards

Related guides

API Reference

Introduction

Welcome to the VoxLink API

Read guide →

API Reference

Authentication

Learn how to authenticate your API requests

Read guide →

API Reference

Get current user

Get the authenticated user's profile information

Read guide →

API Reference

List assistants

List all assistants for the authenticated user with pagination

Read guide →