V1

API change history

These APIs lets you use our message services from your applications.

Creates and sends a new SMS authentication with the given information

Creates and sends a new SMS authentication with the given information

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.

Request body

New SMS authentication data

{
  "Phone": "string",
  "From": "string",
  "MessageFormat": "string",
  "Length": 0,
  "ExpirationTime": 0,
  "NumericOnly": true
}
{
  "description": "Data for creating a new SMS authentication",
  "required": [
    "Phone"
  ],
  "type": "object",
  "properties": {
    "Phone": {
      "description": "Recipient phone number to authenticate",
      "type": "string"
    },
    "From": {
      "description": "Sending name or phone number, default iP1",
      "type": "string"
    },
    "MessageFormat": {
      "description": "Format for the SMS message, {0} = code",
      "pattern": "^(?=.*\\{0\\}).*$",
      "type": "string"
    },
    "Length": {
      "format": "int32",
      "description": "SMS authentication code length, default 5",
      "maximum": 25,
      "minimum": 3,
      "type": "integer"
    },
    "ExpirationTime": {
      "format": "int32",
      "description": "Amount of time (in seconds) until the SMS authentication expires, default 1200 (20 minutes)",
      "maximum": 86400,
      "minimum": 1,
      "type": "integer"
    },
    "NumericOnly": {
      "description": "Whether to force the code to be only numbers, default false",
      "type": "boolean"
    }
  }
}
{
  "Phone": "string",
  "From": "string",
  "MessageFormat": "string",
  "Length": 0,
  "ExpirationTime": 0,
  "NumericOnly": true
}
{
  "description": "Data for creating a new SMS authentication",
  "required": [
    "Phone"
  ],
  "type": "object",
  "properties": {
    "Phone": {
      "description": "Recipient phone number to authenticate",
      "type": "string"
    },
    "From": {
      "description": "Sending name or phone number, default iP1",
      "type": "string"
    },
    "MessageFormat": {
      "description": "Format for the SMS message, {0} = code",
      "pattern": "^(?=.*\\{0\\}).*$",
      "type": "string"
    },
    "Length": {
      "format": "int32",
      "description": "SMS authentication code length, default 5",
      "maximum": 25,
      "minimum": 3,
      "type": "integer"
    },
    "ExpirationTime": {
      "format": "int32",
      "description": "Amount of time (in seconds) until the SMS authentication expires, default 1200 (20 minutes)",
      "maximum": 86400,
      "minimum": 1,
      "type": "integer"
    },
    "NumericOnly": {
      "description": "Whether to force the code to be only numbers, default false",
      "type": "boolean"
    }
  }
}

Responses

200 OK

OK

Representations

{
  "ID": 0,
  "Phone": "string",
  "Created": "string",
  "HasExpired": true,
  "Expires": "string",
  "IsUsed": true,
  "Used": "string"
}
{
  "description": "Represents an SMS authentication",
  "type": "object",
  "properties": {
    "ID": {
      "format": "int32",
      "description": "SMS authentication ID",
      "type": "integer"
    },
    "Phone": {
      "description": "Recipient phone number",
      "type": "string"
    },
    "Created": {
      "format": "date-time",
      "description": "When the SMS authentication was created/started (UTC/GMT)",
      "type": "string"
    },
    "HasExpired": {
      "description": "Whether the SMS authentication has expired",
      "type": "boolean"
    },
    "Expires": {
      "format": "date-time",
      "description": "When the SMS authentication will expire (UTC/GMT)",
      "type": "string"
    },
    "IsUsed": {
      "description": "Whether the SMS authentication has been used",
      "type": "boolean"
    },
    "Used": {
      "format": "date-time",
      "description": "When the SMS authentication was used, if used (UTC/GMT)",
      "type": "string"
    }
  }
}
{
  "ID": 0,
  "Phone": "string",
  "Created": "string",
  "HasExpired": true,
  "Expires": "string",
  "IsUsed": true,
  "Used": "string"
}
{
  "description": "Represents an SMS authentication",
  "type": "object",
  "properties": {
    "ID": {
      "format": "int32",
      "description": "SMS authentication ID",
      "type": "integer"
    },
    "Phone": {
      "description": "Recipient phone number",
      "type": "string"
    },
    "Created": {
      "format": "date-time",
      "description": "When the SMS authentication was created/started (UTC/GMT)",
      "type": "string"
    },
    "HasExpired": {
      "description": "Whether the SMS authentication has expired",
      "type": "boolean"
    },
    "Expires": {
      "format": "date-time",
      "description": "When the SMS authentication will expire (UTC/GMT)",
      "type": "string"
    },
    "IsUsed": {
      "description": "Whether the SMS authentication has been used",
      "type": "boolean"
    },
    "Used": {
      "format": "date-time",
      "description": "When the SMS authentication was used, if used (UTC/GMT)",
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.ip1sms.com/api/authentications"
-H "Content-Type: application/json"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers

            var uri = "https://api.ip1sms.com/api/authentications?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.ip1sms.com/api/authentications");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.ip1sms.com/api/authentications?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.ip1sms.com/api/authentications";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.ip1sms.com/api/authentications');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.ip1sms.com')
    conn.request("POST", "/api/authentications?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.ip1sms.com')
    conn.request("POST", "/api/authentications?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.ip1sms.com/api/authentications')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body