Legacy REST API

⚠️

This documentation refers to the Legacy REST API (deprecated). For the current API, see the main API documentation.

The Legacy REST API was the preferred legacy API for integrating with EZ Texting. It uses Basic HTTP Authentication and supports both XML and JSON response formats.

Base URL: https://app.eztexting.com

Authentication: Basic HTTP Authentication using your EZ Texting username and password.

Response Formats: Append ?format=json or ?format=xml to any endpoint.

Pagination: Supported values: 10, 20, 50, 100, 200 items per page.

Send SMS/MMS messages

POST /sending/messages?format={format}

Sends an SMS or MMS message via the shared short code.

Parameters:

ParameterRequiredDescription
PhoneNumbersYesArray of 10-digit phone numbers
GroupsNoArray of group names to receive the message
MessageConditionalText message content (required if no Subject)
SubjectConditionalSubject line for MMS (required if no Message)
MessageTypeIDYes1 = Express, 2 = Informed Delivery, 3 = Group
StampToSendNoSchedule send time (YYYY-MM-DD HH:MM:SS)
MediaFileIDNoID of media file for MMS

Example Request (JSON):

curl -u user:pass -X POST "https://app.eztexting.com/sending/messages?format=json" \
  -d "PhoneNumbers[]=2135551234" \
  -d "Message=Hello from EZ Texting" \
  -d "MessageTypeID=1"

Response Codes: 201 Created (success), 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Internal Server Error.

Delivery reports

Summary report

GET /sending/reports?format={format}

Returns a summary of message delivery statuses for a specified date range.

Parameters:

ParameterRequiredDescription
DateFromNoStart date (MM/DD/YYYY)
DateToNoEnd date (MM/DD/YYYY)

Detailed report

GET /sending/reports/{status}?format={format}

Returns detailed delivery report filtered by status type.

Status Values: delivered, no_credits, bounced, opted_out, not_sent

Parameters:

ParameterRequiredDescription
DateFromNoStart date (MM/DD/YYYY)
DateToNoEnd date (MM/DD/YYYY)
SortByNoPhoneNumber, Subject, Message, MessageTypeID
SortDirNoasc or desc
ItemsPerPageNo10, 20, 50, 100, 200
PageNoPage number

Inbox messages

Get all messages

GET /incoming-messages?format={format}

Returns all incoming text messages in your inbox.

Parameters:

ParameterRequiredDescription
SearchNoSearch text in messages
FolderIDNoFilter by folder ID
FilterNoRead or Unread
SortByNoReceivedOn, PhoneNumber, Message
SortDirNoasc or desc
ItemsPerPageNo10, 20, 50, 100, 200
PageNoPage number

Get single message

GET /incoming-messages/{id}?format={format}

Returns a single incoming message by ID.

Delete message

DELETE /incoming-messages/{id}?format={format}

Permanently deletes a single incoming message.

Move message to folder

PUT /incoming-messages?format={format}

Moves an incoming message to a specified folder.

Parameters:

ParameterRequiredDescription
IDYesMessage ID
FolderIDYesDestination folder ID

Inbox folders

Get all folders

GET /incoming-messages/folders?format={format}

Returns all inbox folders.

Get single folder

GET /incoming-messages/folders/{id}?format={format}

Returns a single folder by ID.

Create folder

POST /incoming-messages/folders?format={format}

Creates a new inbox folder.

Parameters:

ParameterRequiredDescription
NameYesFolder name

Update folder

PUT /incoming-messages/folders/{id}?format={format}

Updates an existing folder name.

Delete folder

DELETE /incoming-messages/folders/{id}?format={format}

Permanently deletes a folder and moves its messages to the Inbox.

Keywords

Check availability

GET /keywords/{keyword}?format={format}

Checks whether a keyword is available to rent on the shared short code.

Rent keyword

POST /keywords/{keyword}?format={format}

Rents a keyword on the shared short code.

Setup keyword

PUT /keywords/{keyword}?format={format}

Configures a rented keyword with auto-reply and forwarding settings.

Parameters:

ParameterRequiredDescription
EnableDoubleOptInNoEnable double opt-in (true/false)
ConfirmMessageNoOpt-in confirmation message text
JoinMessageNoAuto-reply message when keyword is texted
ForwardEmailNoEmail to forward submissions to
ForwardUrlNoURL to forward submissions to
ContactGroupIDsNoGroups to add contacts to

Cancel keyword

DELETE /keywords/{keyword}?format={format}

Cancels a rented keyword.

Credits

Check balance

GET /billing/credits/get?format={format}

Returns your current credit balance including plan credits and additional credits.

Buy credits

POST /billing/credits?format={format}

Purchases additional credits using a stored credit card or new card details.

Parameters:

ParameterRequiredDescription
NumberOfCreditsYesNumber of credits to purchase
CouponCodeNoCoupon code for discount
StoredCreditCardConditionalLast 4 digits of stored card
FirstNameConditionalCardholder first name (new card)
LastNameConditionalCardholder last name (new card)
CreditCardTypeIDConditionalVisa, MasterCard, Amex, Discover
NumberConditionalFull credit card number (new card)
SecurityCodeConditionalCVV code (new card)
ExpirationMonthConditionalExpiration month (new card)
ExpirationYearConditionalExpiration year (new card)

Contacts

Get all contacts

GET /contacts?format={format}

Returns a list of contacts with optional filtering.

Parameters:

ParameterRequiredDescription
QueryNoSearch by first name, last name, phone, or email
SourceNoFilter by source: Unknown, Manually Added, Upload, Web Widget, API, Keyword
OptOutNotrue to show opted-out contacts
GroupNoFilter by group name
SortByNoPhoneNumber, FirstName, LastName, CreatedAt
SortDirNoasc or desc
ItemsPerPageNo10, 20, 50, 100, 200
PageNoPage number

Get single contact

GET /contacts/{id}?format={format}

Returns a single contact by phone number or ID.

Create contact

POST /contacts?format={format}

Creates a new contact.

Parameters:

ParameterRequiredDescription
PhoneNumberYes10-digit phone number
FirstNameNoFirst name
LastNameNoLast name
EmailNoEmail address
NoteNoContact note
GroupsNoArray of group names

Update contact

PUT /contacts/{id}?format={format}

Updates an existing contact.

Delete contact

DELETE /contacts/{id}?format={format}

Permanently deletes a contact.

Groups

Get all groups

GET /groups?format={format}

Returns all contact groups.

Parameters:

ParameterRequiredDescription
SortByNoName
SortDirNoasc or desc
ItemsPerPageNo10, 20, 50, 100, 200
PageNoPage number

Get single group

GET /groups/{id}?format={format}

Returns a single contact group by ID.

Create group

POST /groups?format={format}

Creates a new contact group.

Parameters:

ParameterRequiredDescription
NameYesGroup name
NoteNoGroup description/note

Update group

PUT /groups/{id}?format={format}

Updates an existing group.

Delete group

DELETE /groups/{id}?format={format}

Permanently deletes a group.

Media files

Get all media files

GET /media-files?format={format}

Returns all uploaded media files.

Get single media file

GET /media-files/{id}?format={format}

Returns a single media file by ID.

Upload media file

POST /media-files?format={format}

Uploads a new media file for use in MMS messages. Supported formats include jpg, gif, and png. Max file size is 300KB.

Delete media file

DELETE /media-files/{id}?format={format}

Deletes a media file.

Implementation notes

Rate Limiting: API requests are subject to rate limiting. If you receive 429 status codes, reduce your request frequency.

Error Responses: All errors return a JSON or XML response with an error code and message describing the issue.

Common HTTP Status Codes:

CodeDescription
200OK - Request succeeded
201Created - Resource created successfully
400Bad Request - Invalid parameters
401Unauthorized - Invalid credentials
403Forbidden - Insufficient permissions
404Not Found - Resource does not exist
500Internal Server Error

Did this page help you?