SMS API · v2

Build SMS workflows made for production.

From your first authenticated request to delivery reports, inbound SMS, contacts and campaign pages. The complete reference in English.

Get started Send an SMS API playground

POST /v2/batches

curl -X POST \
  https://api.ip1sms.com/v2/batches \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sender": "YourCompany",
    "recipients": ["$RECIPIENT"],
    "body": "Your message"
  }'

Documentation

Find the right chapter.

Fourteen chapters cover every topic and endpoint from the previous SMS API documentation.

Getting started

01Introduction

Base URL, authentication, limits and pagination for the iP.1 SMS API.

02Send SMS

Create an SMS batch with recipients, sender, text, scheduling and delivery reports.

Messages

03Batches

List, read and cancel SMS batches, and interpret batch summaries and status.

04Messages

List messages in a batch and read the complete status history of an individual message.

05Delivery reports

Receive message status by webhook and handle acknowledgements, retries and idempotency.

06Inbound SMS

Configure a virtual number and receive inbound SMS messages as secure callback requests.

07Status codes

Interpret accepted, successful, rejected and failed SMS statuses.

08Conversations

Retrieve inbound, outbound and summarized SMS data for a participant.

Contacts

09Contacts

Create, import, filter, read, update and delete contacts through the SMS API.

10Contact tools

Summarize contact data, manage labels and the blocklist, and perform filter-based bulk operations.

Account

11Senders and settings

12Accounts and subaccounts

Reference for account overview, account details and subaccount management in the separate API namespace.

Landing pages

13Landing pages

Create, list, update and delete mobile-friendly campaign pages through the API.

14Landing page elements

Manage title, text, button, image and video elements and their shared properties.

Need an account?

Try the API with your own credentials.

Create account About the SMS API