Legacy HTTP API

⚠️

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

The Legacy HTTP API provides basic SMS features using simple HTTP GET/POST requests with query string parameters.

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

Authentication: Pass your EZ Texting username and password as User and Password parameters in each request.

Rate Limit: Maximum 2 simultaneous HTTP connections per second.

Send SMS message

POST /sending/messages

Sends an SMS message to one or more recipients.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password
PhoneNumbersYesComma-separated 10-digit phone numbers
MessageYesMessage text (max 160 characters)
MessageTypeIDYes1 = Express, 2 = Informed Delivery, 3 = Group
StampToSendNoScheduled send time (YYYY-MM-DD HH:MM:SS)

Example Request:

curl "https://app.eztexting.com/sending/messages" \
  -d "User=myuser" \
  -d "Password=mypass" \
  -d "PhoneNumbers=2135551234" \
  -d "Message=Hello from EZ Texting" \
  -d "MessageTypeID=1"

Check credits

GET /api/credits/check/

Returns your current credit balance.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password

Check keyword availability

GET /api/keyword/check/

Checks if a keyword is available on the shared short code.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password
KeywordYesThe keyword to check

Buy credits

POST /api/credits/buy/

Purchases additional credits.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password
NumberOfCreditsYesNumber of credits to purchase
CouponCodeNoCoupon code for discount

Rent keyword

POST /api/keyword/rent/

Rents a keyword on the shared short code.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password
KeywordYesThe keyword to rent

Configure keyword

POST /api/keyword/setup/

Configures an existing rented keyword with auto-reply and forwarding settings.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password
KeywordYesThe keyword to configure
EnableDoubleOptInNoEnable double opt-in (true/false)
ConfirmMessageNoOpt-in confirmation message
JoinMessageNoAuto-reply when keyword is texted
ForwardEmailNoEmail to forward submissions to
ForwardUrlNoURL to forward submissions to
GroupsNoContact groups to add to

Voice broadcast

POST /api/voicemessages/

Sends voice broadcast messages.

Parameters:

ParameterRequiredDescription
UserYesEZ Texting username
PasswordYesEZ Texting password
PhoneNumbersYesComma-separated phone numbers
CallerPhoneNumberYesCaller ID phone number
VoiceFileYesVoice message file URL
NameNoBroadcast name
StampToSendNoScheduled send time

Return codes

The HTTP API uses numeric return codes instead of HTTP status codes:

CodeDescription
1Success
-1Invalid user and/or password or not authorized to use the API
-2Credit limit reached
-5Locally opted-out number
-7Invalid message or message too long
-104Invalid phone number
-106Globally opted-out number
-10Unknown error

Carrier lookup (deprecated)

⚠️

The Carrier Lookup endpoint is deprecated and may be removed in a future update.

GET /api/sending/phone-numbers/

Returns carrier information for a given phone number. This endpoint is deprecated and should not be used for new integrations.


Did this page help you?