Skip to main content
POST

Overview

Sends an SMS text message to a phone number using one of your Magpipe numbers as the sender.

Request

Headers

string
required
Bearer token for authentication.
string
required
Must be application/json

Body Parameters

string
required
Recipient phone number in E.164 format.Example: "+14155551234"Constraints:
  • Must start with + followed by country code
  • 10-15 digits total
string
required
Your Magpipe phone number to send from. Must be SMS-enabled.Example: "+16045551234"
string
required
The message content.Example: "Your appointment is confirmed for tomorrow at 2pm."Constraints:
  • Maximum 1600 characters
  • Messages over 160 characters are sent as multiple segments
array
Array of URLs for MMS media attachments.Example: ["https://example.com/image.jpg"]Constraints:
  • Maximum 10 media items
  • Supported formats: jpg, png, gif, pdf
  • Maximum 5MB per file
string
ISO 8601 timestamp to schedule the message for later delivery.Example: "2024-01-16T10:00:00Z"Constraints:
  • Must be in the future
  • Maximum 7 days ahead

Response

boolean
Whether the message was sent/queued successfully.
string
Unique identifier for the message.
string
Current message status:
  • queued - Message is queued for delivery
  • sent - Message sent to carrier
  • scheduled - Message scheduled for future delivery
integer
Number of SMS segments the message was split into.
string
ISO 8601 timestamp.

Example Request

Example Response

Error Responses

Message Status Webhook

When the message status changes, a webhook is sent to your configured URL:

Message Status Values

SMS Segment Calculation

SMS messages are split into segments: Messages split across multiple segments include headers, reducing usable characters to 153 (GSM-7) or 67 (Unicode) per segment.