Developer Center

Here you'll learn how to integrate Termii with your product and other apps.
To begin, what integrations are you interested in?

Quick API Guide

Learn how to integrate Termii via API

Start
API Token

Visit user console to get your API Token

Start
Multi-servers

Learn how to activate multi servers

Start

1. Introduction

Termii provides RESTful API which is based on simple HTTP POST/GET requests. We make it easy to our email, sms and verification sending capability with your website or application. Our API lets you create, manage, send, verify and schedule campaigns as well as track your delivery statistics.

2. API Reference

SMS

GET /sapp/sms/api

SMS API URL For Text/Plain SMS


https://termii.com/sapp/sms/api?action=send-sms&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSEs=&to=PhoneNumber&from=SenderID&sms=YourMessage

SMS API URL For Unicode SMS


https://termii.com/sapp/sms/api?action=send-sms&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSEs=&to=PhoneNumber&from=SenderID&sms=YourMessage&unicode=1

SMS API URL For MMS SMS


https://termii.com/sapp/sms/api?action=send-sms&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSEs=&to=PhoneNumber&from=SenderID&sms=YourMessage&mms=1&media_url=YourMediaUrl

SMS API URL For Schedule SMS


https://termii.com/sapp/sms/api?action=send-sms&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSEs=&to=PhoneNumber&from=SenderID&sms=YourMessage&schedule=YourScheduleTime

Balance Check


https://termii.com/sapp/sms/api?action=check-balance&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSEs=&response=json



EMAIL

GET /api/v1/lists

Get all email lists' information

curl -X GET -H "accept:application/json" -G \
https://termii.com/api/v1/lists?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


GET /api/v1/lists/{uid}

Retrieve a particular list's information

curl -X GET -H "accept:application/json" -G \
https://termii.com/api/v1/lists/{uid}?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


POST /api/v1/lists

Create a new email list

curl -X POST -H "accept:application/json" -G \
http://localhost:8000/api/v1/lists?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7

Example: Implementing new email list


        -d name=List+1 \
        -d from_email=admin@abccorp.org \
        -d from_name=ABC+Corp. \
        -d default_subject=Welcome+to+ABC+Corp. \
        -d contact[company]=ABC+Corp. \
        -d contact[state]=Armagh \
        -d contact[address_1]=14+Tottenham+Court+Road+London+England \
        -d contact[address_2]=44-46+Morningside+Road+Edinburgh+Scotland+EH10+4BF \
        -d contact[city]=Noname \
        -d contact[zip]=80000 \
        -d contact[phone]=123+456+889 \
        -d contact[country_id]=1 \
        -d contact[email]=info@abccorp.org \
        -d contact[url]=http://www.abccorp.org \
        -d subscribe_confirmation=1 \
        -d send_welcome_email=1 \
        -d unsubscribe_notification=1


GET /api/v1/campaigns

Get all campaigns' information

curl -X GET -H "accept:application/json" -G \
https://termii.com/api/v1/campaigns?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


GET /api/v1/campaigns/{uid}

Retrieve a particular campaign's information

curl -X GET -H "accept:application/json" -G \
https://termii.com/api/v1/campaigns/{uid}?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


GET /api/v1/lists/{list_uid}/subscribers

Get all subscribers of a mail list

Parameters:

curl -X GET -H "accept:application/json" -G \
https://termii.com/api/v1/lists/{list_uid}/subscribers?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


GET /api/v1/lists/{list_uid}/subscribers/{uid}

Retrive a particulr subscriber of a mail list

Parameters:

curl -X GET -H "accept:application/json" -G \
https://termii.com/api/v1/lists/{list_uid}/subscribers/{uid}?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


PATCH /api/v1/lists/{list_uid}/subscribers/{uid}/subscribe

Subscribe a subscriber

Parameters:

curl -X PATCH -H "accept:application/json" -G \
https://termii.com/api/v1/lists/{list_uid}/subscribers/{uid}/subscribe?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7


PATCH /api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe

Unsubscribe a subscriber

Parameters:

curl -X PATCH -H "accept:application/json" -G \
https://termii.com/api/v1/lists/{list_id}/subscribers/{uid}/unsubscribe?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7