API Documentation

The Developer Hub

Welcome to the Developer Hub. You'll find comprehensive guides and documentation to help you start working with SMS,Voice, 2FA, VMN, SMPP and Outbound Dialing Documentation as quickly as possible. Let's jump right in!

Get Started    

Checking the VMN Inbox Messages through API

Introduction to VMN

Through VMN (Virtual Mobile Number) businesses can send outgoing SMS to user. Users can reply to the incoming SMS that is sent through the VMN. This API is used to check the incoming SMS that the user replies to the VMN Inbox.

How does this work?

What can you do with this API?

Through this API you can check the messages your subscriber send to your VMN inbox. Let's say you want to check the incoming messages that landed in your VMN number, this API is used. You can view a single message or consolidated list of messages between a date range on the application. You can forward the list to third party applications using the URL below:

Trigger URL

The Trigger URL is used to forward the incoming request to client's application. Please find the below sample URL for the sample.

http://xyz.com/receive.php?from={from}&message={message}&ts={ts}

Prerequisites

API Key
Sender ID
VMN Number

API to pull Incoming messages

Below is an API to get all the incoming messages from customer or against specific VMN number.

http://api-vmn.solutionsinfini.com/v1/?method=inbox&format=xml&api_key=xxxxxxxxxxxxxx&format=xml

Optional API Parameters

Parameter
Description

fromdate

Results starting from date. Date in any format. ex: 2017/01/06 or 06/01/2017

todate

Results ending to this date. Date in any format. ex: 2017/01/06 or 06/01/2017

number

VMN Number

keyword

Keyword

mobile

Sender number

limit

Number of results per each request. (default 50 items)

page

Number of the page to get request

format

Specify the output type. type is JSON, PHP, and XML formats

Success Response

<?xml version="1.0" encoding="UTF-8" ?>
<api>
    <status>200</status>
    <message>OK</message>
    <data>
        <rows>
        
        <inbox>
                <recipient>919901574422</recipient>
                <keyword>&lt;invalid&gt;</keyword>
                <sender>+AD-TESTME</sender>
                <message>testing</message>
                <operator></operator>
                <circle></circle>
                <response></response>
                <received_time>2018-02-05 16:00:29</received_time>
            </inbox>
        
         </rows>
    </data>
</api>

What's Next

Read out how to use Two Factor Authentication (Valify) API in the next page

Getting Started with Valify

Checking the VMN Inbox Messages through API