IM API

Overview

Modica’s Intelligent Messaging API provides automatic fallback to alternative delivery channels (SMS, WhatsApp, email, etc…).

A fallback can be triggered by a specific event (and a timeout).

Example: fallback to sending the message as SMS if the WhatsApp message fails to be delivered within 10 seconds.

Authentication

HTTP Basic Authentication is used for all requests. If you access the API without having the correct credentials OR permission to access the API, you will get a HTTP 401 response.

Your gateway application credentials (application name and password) are available on the IM API configuration page in EZITXT.

You will need a user account and password to retrieve these.

If you don’t have these details, please contact support@ezitxt.com.

Authorised IP Addresses

You can whitelist your servers’ IPs or IP ranges using the ‘Add IP Address’ button under “Authorised IP Addresses”

Please note: once one or more IP addresses or IP ranges have been added connections from all other IP addresses will be rejected, any attempt from an IP not in the list will receive an Authentication error.

Base URI

All API access is over HTTPS, and accessed from:

https://new.eziapi.com/rest/im/v1

Versions

The IM API version is currently v1.

OpenAPI Specification

The OpenAPI (Swagger) specification can be found here: here.

You can see code examples and further information here.

Help

Having trouble integrating with any of our services? Contact support@ezitxt.com and we’ll help you sort it out.