Developer Center

Here you will 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 our Email, SMS and Verification sending capability easy 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

POST /sapp/sms/api

SMS API URL For Text/Plain SMS


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

        PARAMETERS
        action      : send-sms
        to          : (country code) your phone number eg. 2348109477743
        from        : Your registered and approved sender ID
        sms         : Your message (160 characters amounts to 1 page)
        api_key     : Insert your API key (to get your key, login and visit your API console)
        
        SAMPLE RESPONSE
        
        Display status of the sent sms message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate country"
        }
        {
        "code"        : "106",
        "message"     : "Invalid Sender id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }

SMS API URL For Unicode SMS


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

        PARAMETERS
        action      : send-sms
        to          : (country code) your phone number eg. 2348109477743
        from        : Your registered and approved sender ID
        sms         : Your message (160 characters amounts to 1 page)
        unicode     : 1
        api_key     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display status of the sent sms message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate country"
        }
        {
        "code"        : "106",
        "message"     : "Invalid Sender id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }

SMS API URL For MMS SMS


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

        PARAMETERS
        action      : send-sms
        to          : (country code) your phone number eg. 2348109477743
        from        : Your registered and approved sender ID
        media_url   : Your media url (eg. https://www.youtube.com/channel/UC9BJ1Kjsun1-L02L9w-Jtqg)
        mms         : 1
        api_key     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display status of the sent sms message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate country"
        }
        {
        "code"        : "106",
        "message"     : "Invalid Sender id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }

SMS API URL For Schedule SMS


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

        PARAMETERS
        action      : send-sms
        to          : (country code) your phone number eg. 2348109477743
        from        : Your registered and approved sender ID
        schedule    : Time you want the message to go out (eg. 03/01/2019%205:14%20PM)
        api_key     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display status of the sent sms message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate country"
        }
        {
        "code"        : "106",
        "message"     : "Invalid Sender id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }

POST /sapp/sms/api

SMS API For Multiple Numbers


        POST STRING
        https://termii.com/sapp/sms/api?

        PARAMETERS
        action      : send-sms
        to          : [destination1, destination2, destinationN]
        from        : Your registered and approved sender ID
        sms         : Your message (160 characters amounts to 1 page)
        api_key     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display status of the sent sms message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate country"
        }
        {
        "code"        : "106",
        "message"     : "Invalid Sender id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }

POST /sapp/sms/api

SMS API Callback for 2way messaging (We support only long codes)


        POST STRING
        https://termii.com/sapp/sms/api?

        PARAMETERS
        action      : send-sms
        to          : Message destination address
        from        : Represents your Registered sender ID
        sms         : Text of the message that will be sent
        notify_url  : The URL on your callback server on which the Delivery report will be sent 
                    (Should Accept application/json).
        notify_id   : The ID that uniquely identifies the messages awaiting feedback.
        api_key     : Your ApiKey
        
        Note: Ensure you register a unique keyword and apply for a long code (To apply login to your account)

        SAMPLE RESPONSE
        
        Displays Json response
        

POST /sapp/api/sms/otp/send

Generate and verify secure sms tokens (OTP)




        ALL PARAMETERS
        api_key           
            1. Type             : string
            2. Description      : Key that uniquely identifies your request on our system
        message_type          
            1. Type             : string
            2. Description      : The type of pin of you want to generate 
            3. Possible values  :  NUMERIC, ALPHANUMERIC, HEX,ALPHA
        to           
            1. Type             : string
            2. Description      : Message destination address. Addresses must be in international format 
                                  (Example: 41793026727)
        from           
            1. Type             : string
            2. Description      : Represents a sender ID which can be alphanumeric or numeric. 
                                  Alphanumeric sender ID length should be between 3 and 11 characters 
                                  (Example: CompanyName). Also the sender ID must be registered on termii
        pin_attempts           
            1. Type             : integer
            2. Description      : Number of possible PIN attempts.(minimum value: 1)
        pin_time_to_live           
            1. Type             : integer
            2. Description      : PIN time to live. (in minutes. Minimum value: 0(lives on), maximum value:60)
        pin_length           
            1. Type             : integer
            2. Description      : Pin Length Minimum value: 4, maximum value:8)
        pin_placeholder           
            1. Type             : string
            2. Description      : PIN code placeholder. Right before sending SMS, PIN code placeholder 
                                  will be replaced with generated PIN code
        message_text           
            1. Type             : string
            2. Description      : Text of a message that will be sent. Message text must contain pin_placeholder
        pin           
            1. Type             : string
            2. Description      : PIN Code received on phone
        pin_id         
            1. Type             : string
            2. Description      : PIN code ID returned in the Send OTP request

        
        
POST STRING https://termii.com/sapp/api/sms/otp/send REQUEST A TOKEN {JSON} { "api_key" : "Insert your API key (To get your key login and visit your api console)", "message_type" : "NUMERIC", "to" : "(country code) your phone number eg. 2348109477743", "from" : "NUMERIC or ALPHANUMERIC ID assigned to your account", "pin_attempts" : Insert amount of attempts you want eg. 10, "pin_time_to_live" : Insert expiry of pin (this is in minutes) eg. 2, "pin_length" : Insert length of token eg. 6, "pin_placeholder" : "< pin >", "message_text" : "Your pin is < pin >" } SAMPLE RESPONSE Message delivered { pinId : bcc61c4a-33ee-406b-b2ae-b642aba75645, to : 2348109477744, smsStatus : Message Sent } Parameters Required { api_key : ["The api key field is required."], message_type : ["The message type field is required."], to : ["The to field is required."], pin_placeholder : ["The pin placeholder field is required."], message_text : ["The message text field is required."], pin_attempts : ["The pin attempts field is required."], pin_time_to_live : ["The pin time to live field is required."], pin_length : ["The pin length field is required."] }
POST STRING https://termii.com/sapp/api/sms/otp/verify VERIFY A TOKEN {JSON} { "api_key" : "Insert your API key (To get your key login and visit your api console)", "pin" : "Insert PIN Code received on phone", "pin_id" : "Insert PIN code ID returned in the Send OTP request" } SAMPLE RESPONSE PIN Verified { pinId : 4b4a0ed7-7225-45ee-a938-b58f512fec7u, verified : true, msisdn : 2348109477743, attemptsRemaining : 0 } PIN Expired { pinId : 4b4a0ed7-7225-45ee-a938-b58f512fec7u, verified : Expired, msisdn : 2348109477743 } NOTE: To ensure OTPs are sent, under your header set the following to; Content-Type : application/json Accept : application/json

GET /sapp/sms/api

Balance Check


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

        PARAMETERS
        action      : check-balance
        response    : json response

        SAMPLE RESPONSE
        
        Display mobile unit balance
        
        {
        balance     : 100,
        user        : Termii Webtech,
        country     : Nigeria
        }
        
        NOTE: Ensure under your header, the following are added;
              Content-Type : application/json
              Accept       : application/json
        



VOICE

POST /sapp/sms/api

API URL For Voice Messages


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

        PARAMETERS
        action      : send-sms
        to          : (country code) your phone number eg. 2348109477743
        from        : Your registered and approved sender ID
        sms         : Your message (160 characters amounts to 1 page)
        voice       : 1
        api_key     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display status of the sent Voice message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate" country
        }
        {
        "code"        : "106",
        "message"     : "Invalid Sender id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }



EMAIL

POST /api/v1/send-email

Send emails to multiple customers


        POST STRING
        https://termii.com/api/v1/send-email?

        PARAMETERS
        to          : Your customer emails
        type        : plain or HTML
        subject     : Your email title
        from        : Email you want customers to see as the sender
        name        : Your comapny name
        message     : Your message
        api_token   : Insert your API key (To get your key login and visit your api console)
        reply_to    : Email you want customers to send a reply to
        
        Note: For thirdparty email servers, this feature currently works only with Amazon SES servers
        
        SAMPLE RESPONSE
        
        Display delivery status of sent email
        
        {
        runtime_message_id : 0100016ca56bc928-f35f2bh0-eae8-428b-a01b-47e1949c68de-000000,
        status             : sent
        }
        
        Error Codes
        
        Field is required or Unauthorized
        
        NOTE: To ensure messages are sent, under your header set the following to;
              Content-Type : application/json
              Accept       : application/json
        



WHATSAPP

POST /sapp/sms/api

WhatsApp API URL For Text/Plain messages


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

        PARAMETERS
        action      : send-sms
        to          : (country code) your destination whatsapp enabled phone number eg. 2348109477743
        from        : Your registered and approved Device ID
        sms         : Your message (160 characters amounts to 1 page)
        api_key     : Insert your API key (to get your key, login and visit your API console)
        
        SAMPLE RESPONSE
        
        Display status of the sent WhatsApp message
        
        {
        code        : ok,
        message     : Status of the sent message,
        balance     : Mobile unit balance eg. 100,
        user        : Your username on Termii
        }
        
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        {
        "code"        : "105",
        "message"     : "Country Inactive. Contact Administrator to activate" country
        }
        {
        "code"        : "106",
        "message"     : "Invalid Device id"
        }
        {
        "code"        : "112",
        "message"     : "Invalid API Key"
        }
        
        NOTE: To ensure messages are sent, under your header set the following to;
              Content-Type : application/json
              Accept       : application/json
        

POST /sapp/api/sms/otp/send

WhatsApp OTP API (Generate and verify secure WhatsApp tokens)




        ALL PARAMETERS
        api_key           
            1. Type             : string
            2. Description      : Key that uniquely identifies your request on our system
        message_type          
            1. Type             : string
            2. Description      : The type of pin of you want to generate 
            3. Possible values  :  NUMERIC, ALPHANUMERIC, HEX,ALPHA
        to           
            1. Type             : string
            2. Description      : Message destination WhatsApp number. Number must be in international format 
                                  (Example: 2348109477744)
        from           
            1. Type             : string
            2. Description      : Represents a Device ID which is numeric. 
                                  (Note: Device ID is assigned only to premium customers)
        pin_attempts           
            1. Type             : integer
            2. Description      : Number of possible PIN attempts.(minimum value: 1)
        pin_time_to_live           
            1. Type             : integer
            2. Description      : PIN time to live. (in minutes. Minimum value: 0(lives on), maximum value:60)
        pin_length           
            1. Type             : integer
            2. Description      : Pin Length Minimum value: 4, maximum value:8)
        pin_placeholder           
            1. Type             : string
            2. Description      : PIN code placeholder. Right before sending SMS, PIN code placeholder 
                                  will be replaced with generated PIN code
        message_text           
            1. Type             : string
            2. Description      : Text of a message that will be sent. Message text must contain pin_placeholder
        pin           
            1. Type             : string
            2. Description      : PIN Code received on phone
        pin_id         
            1. Type             : string
            2. Description      : PIN code ID returned in the Send OTP request
        
POST STRING https://termii.com/sapp/api/sms/otp/send 1. REQUEST A TOKEN {JSON} { "api_key" : "Insert your API key (To get your key login and visit your api console)", "message_type" : "NUMERIC", "to" : "(country code) your WhatsApp enabled phone number eg. 2348109477743", "from" : "NUMERIC ID assigned to your account", "pin_attempts" : Insert amount of attempts you want eg. 10, "pin_time_to_live" : Insert expiry of pin (this is in minutes) eg. 2, "pin_length" : Insert length of token eg. 6, "pin_placeholder" : "< pin >", "message_text" : "Your pin is < pin >" } SAMPLE RESPONSE Message delivered { pinId : bcc61c4a-33ee-406b-b2ae-b642aba73745, to : 2348109477744, smsStatus : Message Sent } Parameters Required { api_key : ["The api key field is required."], message_type : ["The message type field is required."], to : ["The to field is required."], pin_placeholder : ["The pin placeholder field is required."], message_text : ["The message text field is required."], pin_attempts : ["The pin attempts field is required."], pin_time_to_live : ["The pin time to live field is required."], pin_length : ["The pin length field is required."] }
POST STRING https://termii.com/sapp/api/sms/otp/verify 2. VERIFY A TOKEN {JSON} { "api_key" : "Insert your API key (To get your key login and visit your api console)", "pin" : "Insert PIN Code received on WhatsApp", "pin_id" : "Insert PIN code ID returned in the Send OTP request" } SAMPLE RESPONSE PIN Verified { pinId : 4b4a0ed7-7225-45ee-a938-b58f512fec7u, verified : true, msisdn : 2348109477743, attemptsRemaining : 0 } PIN Expired { pinId : 4b4a0ed7-7225-45ee-a938-b58f512fec7u, verified : Expired, msisdn : 2348109477743 } NOTE: To ensure OTPs are sent, under your header set the following to; Content-Type : application/json Accept : application/json



ANALYTICS

GET /sapp/sms/api

SMS API For Delivery Report (All updated sms history)


        GET STRING
        https://termii.com/sapp/sms/api?

        PARAMETERS
        action      : get-inbox
        api_key     : Insert your API key (To get your key login and visit your api console)

        SAMPLE RESPONSE
        
        Display status of all messages sent on your account
        
        {
        id                 : Specific message ID eg. 322307,
        from               : Unique sender ID for sms or device ID for WhatsApp,
        phone              : Your recipient phone number,
        sms                : Message sent to this customer,
        segments           : 1,
        status             : Delivery Status,
        type               : Sms type eg. plain, unicode, etc.
        }
        
        NOTE: Ensure under your header, the following are added;
              Content-Type : application/json
              Accept       : application/json
        

GET /api/v1/campaigns

Get all email campaigns' information {Curl}


        GET STRING
        https://termii.com/api/v1/campaigns?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        api_token     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display all created and sent email campaigns
        
        {
        uid            : Unique ID autogenerated for each campaign,
        name           : Campaign name,
        type           : Type of email eg. plain-text or regular,
        subject        : Title of your email,
        html           : HTML Content of your email,
        plain          : Text version for customers whose email only views text emails,
        from_email     : Default email (this will appear under sent from section),
        from_name      : Unique name customers see eg. Cecilia from Termii,
        reply_to       : Email customers can reply to,
        status         : Delivery status of this email,
        delivery_at    : Time this email delivered to the recipient,
        created_at     : Time this email was created eg. 2017-11-01 13:37:57,
        updated_at     : Time this email was last updated eg. 2019-08-16 19:58:59
        }
        
        Error Code
        
        Unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        

GET /api/v1/campaigns/{uid}

Retrieve a particular email campaign's information


        GET STRING
        https://termii.com/api/v1/campaigns/{uid}?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        {uid}         : Auto-generated id of a specific campaign
        api_token     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display all details of a specific email campaign
        
        {
            "campaign": {
                "uid": "5c77cd1403879",
                "name": "Introducing Termii App-store",
                "list": "",
                "segment": "",
                "default_subject": null,
                "from_email": "sales@termii.com",
                "from_name": "Temilade from Termii",
                "remind_message": null,
                "status": "done",
                "created_at": {
                    "date": "2019-02-28 11:59:16.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "updated_at": {
                    "date": "2019-08-17 18:00:37.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                }
            },
            "statistics": {
                "subscriber_count": 4600,
                "uniq_open_rate": 13,
                "delivered_rate": 1.0147826086957,
                "open_count": 889,
                "uniq_open_count": 607,
                "last_open": {
                    "date": "2019-08-17 07:09:58.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "click_rate": 33,
                "click_per_uniq_open": 1,
                "click_count": 13,
                "abuse_feedback_count": 0,
                "last_click": {
                    "date": "2019-03-11 14:15:02.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "bounce_count": 37,
                "unsubscribe_count": 7,
                "links": [
                    "https://termii.com/app-store",
                    "https://www.linkedin.com/company/termii-networks/"
                ],
                "top_locations": [
                    "209.85.238.16",
                    "66.249.93.70",
                    "66.249.93.65",
                    "66.249.93.68",
                    "209.85.238.18"
                ],
                "top_open_subscribers": [
                    {
                        "uid": "25632862938227294",
                        "email": "erubaazubuike82@gmail.com"
                    },
                    {
                        "uid": "26017816561844355",
                        "email": "malerosale89@gmail.com"
                    },
                    {
                        "uid": "25632862938481276",
                        "email": "bimbobotu@gmail.com"
                    },
                    {
                        "uid": "25632862938227918",
                        "email": "kabarikanee@gmail.com"
                    },
                    {
                        "uid": "25632862938481564",
                        "email": "kamsirose78@gmail.com"
                    }
                ]
            }
        }
        
        Error Code
        
        Unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        



AUDIENCE

POST /sapp/sms/api

Insert mobile phone contacts into a phone book


        POST STRING
        https://termii.com/sapp/contacts/api?action=&subscribe-us&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSEs=
        &phone_book=YourPhoneBook&phone_number=CustomerPhoneNumber

        PARAMETERS
        action      : subscribe-us
        phone_book  : The name of the phone book you have created 
                      on your account (Visit https://termii.com/sapp/user/phone-book to create yours)
        phone_number: (country code) your phone number eg. 2348109477743
        api_key     : Your ApiKey
        
        SAMPLE RESPONSE
        
        Display status of added phone contacts
        
        {
        code        : ok,
        message     : Subscription successfully done
        }
        
        Error Codes
        
        {
        "code"        : "103",
        "message"     : "Invalid Phone Number"
        }
        {
        "code"        : "104",
        "message"     : "Subscription list not found"
        }
        {
        "code"        : "105",
        "message"     : "You already subscribed"
        }
        
        NOTE: Ensure under your header, the following are added;
              Content-Type : application/json
              Accept       : application/json
        

POST /api/v1/lists

Create a new email list


        POST STRING
        https://termii.com/api/v1/lists?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7

        
        PARAMETERS
        Example: Implementing new email list
        
        api_token                 : Insert your API key (To get your key login and visit your api console)
        name                      : Title of lists
        from_email                : Default email (this will appear under sent from section)
        from_name                 : Unique name customers see eg. Cecilia from Termii
        default_subject           : Title of emails
        contact[company]          : Your comapny name
        contact[state]            : Your company state 
        contact[address_1]        : Your company official address
        contact[address_2]        : Your company official address (optional)
        contact[city]             : Your company city
        contact[zip]              : Your company country zip code
        contact[phone]            : Your comapany official phone number (add country code eg. 2348109302727)
        contact[country_id]       : 1 (This sets to your account default value)
        contact[email]            : Your company official email
        contact[url]              : Your company official website (https://james.ng/) - Important
        subscribe_confirmation    : 1 (This sets to your account default value)
        send_welcome_email        : 1 (This sets to your account default value)
        unsubscribe_notification  : 1 (This sets to your account default value)
        
        SAMPLE RESPONSE
        
        Display status of added email list
        
        {
        status        : 1,
        message       : List was successfully created,
        list_uid      : 5d57d93e8fe79
        }
        
        Error Code
        
        unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        

GET /api/v1/lists

Get all email lists' information


        GET STRING
        https://termii.com/api/v1/lists?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        api_token         : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display all created email lists
        
        {
        uid               : Unique ID autogenerated for each campaign,
        name              : Title of lists,
        default_subject   : Title of emails,
        from_email        : Default email (this will appear under sent from section),
        from_name         : Unique name customers see eg. Cecilia from Termii,
        status            : Status of email lists,
        created_at        : Time this email was created eg. 2017-11-01 13:37:57,
        updated_at        : Time this email was last updated eg. 2019-08-16 19:58:59
        }
        
        
        Error Code
        
        unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        

GET /api/v1/lists/{uid}

Retrieve a particular list's information


        GET STRING
        https://termii.com/api/v1/lists/{uid}?api_token=ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        {uid}         : Auto-generated id of a specific email list
        api_token     : Insert your API key (To get your key login and visit your api console)
        

        SAMPLE RESPONSE
        
        Display details of a particular email list
        
        {
            list: {
                 uid                   : 5g57e1ff3da88,
                 name                  : List 1,
                 default_subject       : Welcome to Termii,
                 from_email            : admin@abccorp.org,
                 from_name             : James from Termii,
                 remind_message        : null,
                 status                : "",
                 created_at            : {
                    date               :  2019-08-17 11:16:15.000000,
                    timezone_type      : 3,
                    timezone           : UTC
                },
                 updated_at            : {
                    date               : 2019-08-17 11:17:22.000000,
                    timezone_type      : 3,
                    timezone           : UTC
                },
                fields: [
                    {
                        label          : Email,
                        type           : text,
                        tag            : EMAIL,
                        default_value  : null,
                        visible        : 1,
                        required       : 1,
                        custom_order   : 0
                    },
                    {
                        label          : First name,
                        type           : text,
                        tag            : FIRST_NAME,
                        default_value  : null,
                        visible        : 1,
                        required       : 0,
                        custom_order   : 0
                    },
                    {
                        label          : Last name,
                        type           : text,
                        tag            : LAST_NAME,
                        default_value  : null,
                        visible        : 1,
                        required       : 0,
                        custom_order   : 0
                    }
                ]
            },
            contact : {
                company                : ABC Corp,
                address_1              : 14 Tottenham Court Road London England,
                address_2              : 44-46 Morningside Road Edinburgh Scotland,
                country                : Afghanistan,
                state                  : Lagos,
                zip                    : 23401,
                phone                  : 2348109477743,
                url                    : https://james.ng/,
                email                  : info@james.ng,
                city                   : Lagos
            },
            statistics : {
                subscriber_count       : 0,
                open_uniq_rate         : 0,
                click_rate             : 0,
                subscribe_rate         : 0,
                unsubscribe_rate       : 0,
                unsubscribe_count      : 0,
                unconfirmed_count      : 0
            }
        }
        
        Error Code
        
        Whoops, looks like something went wrong.
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        

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

Get all subscribers of an email list


        GET STRING
        https://termii.com/api/v1/lists/{list_uid}/subscribers?api_token=
        ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        list_uid          : Unique ID autogenerated for each email list,
        api_token         : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display all subscribers of a specific email list
        
        {
        list_uid          : Unique ID autogenerated for each email list,
        email             : Subscriber email address,
        status            : Status of email lists,
        FIRST_NAME        : Subscriber first name,
        LAST_NAME         : Subscriber last name,
        }
        
        
        Error Code
        
        unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        

POST /api/v1/lists/{list_uid}/subscribers/store

Add a new subscriber to an email list


        POST STRING
        https://termii.com/api/v1/lists/{list_uid}/subscribers/store?api_token=
        ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        Example: Inserting new email susbscriber to a specific email list
        
        list_uid          : Unique ID autogenerated for each email list,
        api_token         : Insert your API key (To get your key login and visit your api console)
        EMAIL             : Subscriber email address,
        FIRST_NAME        : Subscriber first name,
        LAST_NAME         : Subscriber last name,
        
        SAMPLE RESPONSE
        
        Add a subscriber to a specific email list
        
        {
        status            : 1,
        message           : Confirmation email sent to the subscriber,
        subscriber_uid    : Auto-generated id of a specific email list
        }
        
        Error Code
        
        unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        

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

Retrive a particular subscriber of an email list


        GET STRING
        https://termii.com/api/v1/lists/{list_uid}/subscribers/{uid}?api_token
        =ME45Scg0tKaDplHgvR7Pcv20o9RsNna9dxx39lsayRpKkCZkP9QAgqT10yL7
        
        PARAMETERS
        uid               : Unique ID autogenerated for each subscriber,
        list_uid          : Unique ID autogenerated for each email list,
        api_token         : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display all details of a particular subscriber of a specific email list
        
        {
        subscriber: {
            uid           : Unique ID autogenerated for each subscriber,
            email         : Subscriber email address,
            status        : Status of email lists,
            source        : Device subscriber is using to view your campaigns,
            ip_address    : Location of this subscriber,
            FIRST_NAME    : Subscriber first name,
            LAST_NAME     : Subscriber last name,
            }
        }
        
        Error Code
        
        unauthorized
        
        NOTE: Ensure under your header, the following are added;
              Accept       : application/json
        


SENDER ID

POST /sapp/sms/api

Request for a sender ID


https://termii.com/sapp/sms/api?action=register-sender-id&api_key=S2ZCbGZBdERNTmthZ3VxG2JhSE&sender_id=YourSenderID

        PARAMETERS
        action      : register-sender-id
        sender_id   : Input your preferred sender ID (eg. Termii)
        api_key     : Insert your API key (To get your key login and visit your api console)
        
        SAMPLE RESPONSE
        
        Display status of registered sender ID
        
        {
        code        : 200,
        message     : Sender Id Registration in Progress
        }
        
        Error Codes
        
        {
        "code"        : "100",
        "message"     : "Bad gateway requested"
        }
        {
        "code"        : "101",
        "message"     : "Wrong action"
        }
        
        NOTE: Ensure under your header, the following are added;
              Content-Type : application/json
              Accept       : application/json