Back

EZ Texting API Essential Guide

Aug 18, 20246 minute read

What type of API does EZ Texting provide?

EZ Texting provides a REST API for developers to integrate with their platform. Here are the key points about EZ Texting's API:

API Type

  • EZ Texting offers a REST API

Key Features

  • Allows sending SMS messages through EZ Texting's SMS gateway
  • Provides access to many features of the EZ Texting platform
  • Supports both GET and POST requests
  • Offers bulk sending and message scheduling options

Documentation

  • Detailed API documentation is available, including parameters, example calls, and usage instructions

Legacy API

  • EZ Texting also has a legacy HTTP API, but active development has moved to the REST API
  • They encourage using the REST API over the legacy HTTP API

Additional Notes

  • An EZ Texting account is required to use the API
  • They provide a C# SDK available on NuGet and GitHub
  • Rate limiting is in place to prevent excessive API calls

Best Practices

  • When sending multiple requests, they recommend using specific logic to avoid rate limiting issues
  • For sending the same message to multiple recipients, using the REST API with an array of phone numbers is recommended

In summary, EZ Texting provides a modern REST API for developers to integrate SMS messaging capabilities into their applications, with a focus on flexibility and ease of use.

Does the EZ Texting API have webhooks?

EZ Texting offers both REST and HTTP APIs, with the REST API being the recommended and actively developed option. The API documentation covers functionality like sending SMS/MMS messages, managing contacts and groups, retrieving message status, and handling incoming messages through the Keyword API and Inbox Reply API. The API uses OAuth authentication.

However, the search results do not contain any information about webhooks or event subscriptions in the official EZ Texting API documentation. To get a definitive answer, it is recommended to:

  1. Check the latest API documentation on the EZ Texting website, as the search results may not reflect the most up-to-date information.
  2. Contact EZ Texting support directly to inquire about webhook capabilities.
  3. Explore if there are any alternative methods provided by EZ Texting for real-time notifications or event tracking, such as polling specific endpoints.

If webhooks are indeed not available, you may need to implement polling mechanisms to check for updates or changes in your EZ Texting account programmatically.

Rate Limits and other limitations

Based on the search results provided, here are the key points regarding API rate limits for the EZ Texting API:

Rate Limiting

  1. EZ Texting imposes a limit on the number of simultaneous connections that can be made from a server to theirs per second.

  2. To avoid having your IP blocked, you should not attempt to make more than 2 simultaneous HTTP connections per second to their servers.

  3. If your application exceeds this limit, you may receive a rate limiting error with the HTTP status code 503 in the header, and your request will not be processed.

Best Practices

  1. When sending multiple requests, EZ Texting strongly suggests using the following logic to avoid rate limiting:

    • Open Connection
    • Begin Loop
    • Make Request
    • Close Loop
    • Close Connection
  2. For sending the same message to multiple recipients, EZ Texting strongly urges users to consider using their REST API instead of the HTTP API.

  3. The REST API allows passing a single message and an array of phone numbers to deliver in a single request, which is more efficient than making multiple individual requests.

Additional Considerations

  1. EZ Texting encourages users to use their REST API over the HTTP API, as the HTTP API is considered a legacy product.

  2. The REST API offers new bulk sending and message scheduling options that are not available in the HTTP API.

  3. No new features will be added to the HTTP API.

It's important to note that while these rate limits are mentioned for the HTTP API, the search results do not provide specific information about rate limits for the REST API. For the most up-to-date and accurate information on API rate limits, especially for the REST API, it would be best to consult the official EZ Texting API documentation or contact their support team directly.

Latest API Version

Based on the search results provided, I could not find a specific mention of the most recent version of the EZ Texting API. However, I can provide some relevant information about EZ Texting's API offerings:

Key Points:

  1. EZ Texting offers both REST and HTTP APIs [1].

  2. The REST API is the more current and actively developed version [1].

  3. The HTTP API is considered a legacy product, with no new features being added [1].

  4. EZ Texting encourages users to use the REST API over the HTTP API [1][3].

  5. The REST API offers newer features such as bulk sending and message scheduling options [3].

Current API Status:

While the search results don't mention a specific version number, they do indicate that EZ Texting is in the process of transitioning from their legacy API to a new API:

  1. The documentation for both REST and HTTP APIs is labeled as referring to their "Legacy API" [1][2].

  2. There are mentions of a new API that will replace the legacy version [1][2][3].

  3. The legacy API is unavailable for new users and will be deprecated for existing users soon [1][2].

Recommendation:

Based on this information, if you're looking to integrate with EZ Texting's API, it's recommended to:

  1. Use the REST API rather than the HTTP API, as it's the more current version.

  2. Check EZ Texting's developer documentation for the most up-to-date information on their new API, which is set to replace the legacy versions.

  3. Contact EZ Texting directly for the most current information on their API versions and availability, as they appear to be in a transition period.

It's important to note that without more recent or specific information, it's not possible to provide the exact version number of the most recent EZ Texting API. For the most accurate and up-to-date information, it would be best to consult EZ Texting's official documentation or contact their support directly.

How to get a EZ Texting developer account and API Keys?

To get a developer account for EZ Texting to create an API integration, you'll need to follow these steps:

  1. Create an EZ Texting account:

    • Go to the EZ Texting website and sign up for an account.
  2. Familiarize yourself with the API documentation:

    • EZ Texting offers both REST and HTTP APIs, but they recommend using the REST API for new integrations.
    • Review the REST API documentation to understand the available endpoints and functionality.
  3. Obtain API credentials:

    • Your EZ Texting username and password will be used as authentication for API requests.
  4. Set up your development environment:

    • Choose a programming language and set up the necessary tools to make HTTP requests to the API.
    • EZ Texting provides code examples in various languages to help you get started.
  5. Test the API:

    • Start with simple API calls, such as retrieving account information or sending a test message.
    • Use the provided code examples as a reference for making API requests.
  6. Implement your integration:

    • Develop your application using the API endpoints that suit your needs.
    • Follow best practices for error handling and rate limiting.

What can you do with the EZ Texting API?

Here are the key data models you can interact with using the EZ Texting API:

Contacts

  • Create new contacts
  • Retrieve contact details
  • Update contact information
  • Add contacts to groups
  • Remove contacts from groups

Messages

  • Send SMS messages to individual numbers or groups
  • Schedule messages for future delivery
  • Check message delivery status
  • Retrieve sent and received messages
  • Filter messages by folder, text content, or phone number

Groups

  • Create contact groups
  • Add/remove contacts from groups
  • Retrieve group details
  • Send messages to entire groups

Keywords

  • Set up and configure keywords
  • Enable/disable double opt-in for keywords
  • Set auto-reply messages for keywords
  • Configure email/URL forwarding for incoming keyword messages
  • Add contacts who text in keywords to specific groups

Voice Broadcasts

  • Send voice messages to phone numbers or groups
  • Use audio files stored in EZ Texting account or external URLs
  • Schedule voice broadcasts for future delivery

Credits

  • Check available messaging credits on account

MMS

  • Send MMS messages with media attachments
  • Retrieve MMS messages

Folders

  • Organize messages into folders
  • Retrieve messages from specific folders

The API allows you to programmatically manage most aspects of your EZ Texting account, from contact and group management to sending various types of messages and configuring keywords. The REST API is recommended for new integrations as it offers more advanced features like bulk sending compared to the legacy HTTP API.