EZI API

The EZI API provides two authentication methods: HTTP and REST. Both APIs allow you to send SMS messages and retrieve message information.

HTTP API

Authentication

Our HTTP API uses an API key for authentication. Your account’s API key can be found in the Settings section when you have logged into the web platform.

When using the HTTP API, the API key must be passed as a querystring variable: https://new.eziapi.com/sms?key={APIKEY} ...

Endpoint and Response Format

The current API endpoint is: https://new.eziapi.com

All responses are returned in JSON format.

Send an SMS

To send an SMS message using the HTTP API, submit a GET request:

Request

Response

On Success:

{
    "id": integer($int64):message-id,
    "recipient": integer:mobile-number,
    "encoding": str:encoding-type,
    "units": integer:unit-count,
    "status": str:message-status
}

REST API

Authentication

When using the REST API, the API key should be passed as a header in the request.

Endpoint and Response Format

The current API endpoint is: https://new.eziapi.com

All responses are returned in JSON format.

Send an SMS

To send an SMS message using the REST API, submit a POST request:

Request

Response

On Success:

{
    "id": integer($int64):message-id,
    "recipient": integer:mobile-number,
    "encoding": str:encoding-type,
    "units": integer:unit-count,
    "status": str:message-status
}

Retrieve Messages

To retrieve messages with optional filtering parameters using the REST API, submit a GET request:

Request

Example GET https://new.eziapi.com/v3/sms?limit=20&offset=0

Note: The API key should be included in the request header, not as a query parameter.

Response

{
    "results": [
        {
            "id": integer($int64):message-id,
            "direction": str:direction,
            "source": str:source-identifier,
            "msisdn": integer:mobile-number,
            "country": str:country-code,
            "content": str:message-content,
            "units": integer:unit-count,
            "encoding": str:encoding-type,
            "timestamp": integer:unix-timestamp,
            "last_updated": integer:unix-timestamp,
            "status": str:message-status,
            "message_id": integer($int64):message-id,
            "keyword_id": integer:keyword-id,
            "contact_id": integer:contact-id,
            "parent_id": integer:parent-message-id,
            "optout": boolean:optout-flag
        }
        // Additional messages...
    ],
    "limit": integer:limit,
    "offset": integer:offset,
    "total": integer:total-count
}

Message Object Structure

Each message in the results array contains the following fields:

Callbacks

MO Callback

When a mobile-originated (MO) message is received by our platform, we can forward it to your system via a callback URL that you configure. The callback will be sent as an HTTP GET request to your specified endpoint.

You can include placeholders in your callback URL that will be replaced with actual message data:

Binary Message Handling For binary messages (8-bit), the content will be base64 encoded and an additional parameter encoding=base64 will be included in the callback URL.

DLR Callback

When the status of a message changes (e.g., from “sent” to “delivered”), we can notify your system via a Delivery Receipt (DLR) callback. The callback will be sent as an HTTP POST request to your specified endpoint.

Callback Format

{
    "id": integer($int64):message-id,
    "status": str:message-status,
    "timestamp": integer:unix-timestamp
}

Note: You will need to contact our support team to configure callback URLs for your account.

Message Status Codes

The following are the status codes that may be returned for messages:

Help

Having trouble integrating with our EZI API? Contact our support team and we’ll help you sort it out support@ezitxt.com.