EZI API

There are two additional EZI API available; HTTP and REST.


HTTP Authentication

Our HTTP API uses an API key for authentication. Your account’s API key can be found on the Setting 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

Request

Method URL
Get /sms
Parameter Description Type Required
key API Key String Yes
recipient International formatted MSISDN Integer Yes
content Body of the message to send String Yes
reply Flag if the message is a reply Boolean No
reply_to ID of the message being replied to Integer No
mask Alphanumeric mask (11 chars max) – if supported String No
premium Use the premium route – if supported Boolean No

Response

Status Reason Response
200 OK 
{
    id:<integer>,
    recipient:<integer>,
    status:<string> 
}


REST 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.


Messaging

Send an SMS

Get a list of all groups associated with your contacts.

Request

Method URL
POST /v3/sms
Parameter Description Default Type Values Required
key API key HEAD String Yes
recipient International formatted MSISDN of the recipient. Required if contact_id is not specified. POST Integer Yes/No
contact_id ID of the contact to send a message to. Required if recipient is not specified. POST Integer Yes/No
template_id ID of the template to use. Must be set if no content is supplied. POST Integer Yes/No
content Message content. Must be set if no template_id is supplied. POST String Yes/No
reply Flag for if the message is a reply. Set to either TRUE of FALSE. FALSE POST Boolean No
reply_to ID of the SMS this is a reply to. Required if reply is set to TRUE. POST Integer No
mask Alphanumeric mask (11 chars max) – if supported POST String No
premium Use the premium route – if supported FALSE POST Boolean No

Response

Status Reason Response
200 OK 
{
    id: <integer>
    direction: <string>
    msisdn: <integer>
    units: <integer>
    encoding: <string> 
    timestamp: <timestamp> 
    last_updated: <timestamp> 
    status: <string>
    message_id: <integer> 
    keyword_id: <integer> 
    contact_id: <integer> 
    parent_id: <integer>
}