Legacy incoming message APIs
This documentation refers to the Legacy Incoming Message APIs (deprecated). These have been replaced by Webhooks .
EZ Texting can forward incoming messages to your server in real-time using two different APIs: Keyword Submissions and Inbox Reply Messages. Both use HTTP GET requests to your specified URL.
Keyword submissions API
When a customer texts a keyword to your short code, EZ Texting sends a GET request to the URL you configured for that keyword.
Request Method: GET to your configured URL
Parameters sent by EZ Texting:
| Parameter | Description |
|---|---|
| PhoneNumber | The sender's 10-digit phone number |
| Message | The full text message content received |
Example Request from EZ Texting:
GET https://yourserver.com/handler?PhoneNumber=2135551234&Message=JOIN+Get+me+signed+up
Configuration options
Send Unique Requests: When enabled, EZ Texting will include the phone number only once per keyword. Subsequent messages from the same number to the same keyword will not trigger a new request.
Wait for Response From My Server: When enabled, EZ Texting waits for your server's response and sends it back to the customer as an SMS reply.
Response requirements
If "Wait for Response" is enabled:
- Response must be plain text (not HTML or JSON)
- Maximum 160 characters (136 characters for Canadian numbers)
- Must be returned within 60 seconds
- If no response or timeout, no reply is sent to the customer
Example Response:
Thanks for signing up! You will receive weekly updates. Reply STOP to opt out.
Inbox reply messages API
When a customer sends a reply message to your inbox, EZ Texting forwards it to your configured URL.
Request Method: GET to your configured URL
Parameters sent by EZ Texting:
| Parameter | Description |
|---|---|
| from | The sender's 10-digit phone number |
| message | The full text message content received |
Example Request from EZ Texting:
GET https://yourserver.com/inbox?from=2135551234&message=Yes+I+will+attend
Key differences from keyword API
| Feature | Keyword API | Inbox Reply API |
|---|---|---|
| Parameter names | PhoneNumber, Message | from, message |
| Trigger | Customer texts a keyword | Customer replies to any message |
| Configuration | Per-keyword URL setup | Account-level inbox forwarding |
| Response capability | Optional auto-reply | No auto-reply support |
Setting up forwarding URLs
For keywords
- Log into your EZ Texting account
- Navigate to Keywords in the main menu
- Select the keyword to configure
- Under Forwarding, enter your server URL
- Optionally enable "Send Unique Requests" and "Wait for Response"
- Save your settings
For inbox replies
- Log into your EZ Texting account
- Navigate to Inbox settings
- Under Reply Forwarding, enter your server URL
- Save your settings
Best practices
- Always return a 200 HTTP status code to acknowledge receipt, even if you don't need to send a reply
- Implement proper error handling and logging on your server
- If using the "Wait for Response" feature, ensure your server responds quickly (under 60 seconds)
- Store incoming messages in your own database for record-keeping
- Validate the incoming phone number format before processing
Updated 3 days ago