V1
API change historyThese APIs lets you use our message services from your applications.
Gets your current default settings for new SMS authentications
Gets your current default settings for new SMS authentications
Try itRequest
Request URL
Request body
Responses
200 OK
OK
Representations
{
"ConcurrentLimit": 0,
"From": "string",
"MessageFormat": "string",
"Length": 0,
"ExpirationTime": 0,
"NumericOnly": true
}{
"description": "Represents your account default SMS authentication settings, null = unset. These settings\r\noverride system defaults and is overidden by request parameters.",
"type": "object",
"properties": {
"ConcurrentLimit": {
"format": "int32",
"description": "The maximum number of allowed active SMS authentications per phone number, default 5",
"type": "integer"
},
"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"
}
}
}{
"ConcurrentLimit": 0,
"From": "string",
"MessageFormat": "string",
"Length": 0,
"ExpirationTime": 0,
"NumericOnly": true
}{
"description": "Represents your account default SMS authentication settings, null = unset. These settings\r\noverride system defaults and is overidden by request parameters.",
"type": "object",
"properties": {
"ConcurrentLimit": {
"format": "int32",
"description": "The maximum number of allowed active SMS authentications per phone number, default 5",
"type": "integer"
},
"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"
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.ip1sms.com/api/authentications/settings"
--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);
var uri = "https://api.ip1sms.com/api/authentications/settings?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // 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/settings");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
// 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/settings?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
},
type: "GET",
// 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/settings";
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:@"GET"];
// Request headers
// 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/settings');
$url = $request->getUrl();
$headers = array(
// Request headers
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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 = {
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.ip1sms.com')
conn.request("GET", "/api/authentications/settings?%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 = {
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.ip1sms.com')
conn.request("GET", "/api/authentications/settings?%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/settings')
request = Net::HTTP::Get.new(uri.request_uri)
# 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