V2

API change history

This is a project with the aim create an HTTP based API that is both powerful and simple to use.

List your contacts

Is paginated, can include metadata

Try it

Request

Request URL

Request parameters

  • (optional)
    array

    Label filter

  • (optional)
    string

    Property filter

  • (optional)
    string

    Metadata filter

  • (optional)
    string

    Include metadata, parameter value doesn't matter

Request body

Responses

200 OK

List of contacts, optionally filtered

Representations

[
  {
    "id": "string",
    "ownerId": "string",
    "properties": {},
    "metadata": {},
    "labels": [
      "string"
    ]
  }
]
{
  "type": "array",
  "items": {
    "required": [
      "properties"
    ],
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "example": "string"
      },
      "ownerId": {
        "type": "string"
      },
      "properties": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      },
      "metadata": {
        "type": "object",
        "additionalProperties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "labels": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "example": {
      "id": "string",
      "ownerId": "string",
      "properties": {},
      "metadata": {},
      "labels": [
        "string"
      ]
    }
  }
}

400 Bad Request

Pagination or path parameters invalid

Representations

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "format": "int32",
      "type": "integer"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}

404 Not Found

No contacts to list

Representations

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "format": "int32",
      "type": "integer"
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.ip1sms.com/v2/contacts?labels={array}&properties={string}&metadata={string}&meta={string}"

--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 parameters
            queryString["labels"] = "{array}";
            queryString["properties"] = "{string}";
            queryString["metadata"] = "{string}";
            queryString["meta"] = "{string}";
            var uri = "https://api.ip1sms.com/v2/contacts?" + 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/v2/contacts");

            builder.setParameter("labels", "{array}");
            builder.setParameter("properties", "{string}");
            builder.setParameter("metadata", "{string}");
            builder.setParameter("meta", "{string}");

            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
            "labels": "{array}",
            "properties": "{string}",
            "metadata": "{string}",
            "meta": "{string}",
        };
      
        $.ajax({
            url: "https://api.ip1sms.com/v2/contacts?" + $.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/v2/contacts";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"labels={array}",
                         @"properties={string}",
                         @"metadata={string}",
                         @"meta={string}",
                      ];
    
    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/v2/contacts');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'labels' => '{array}',
    'properties' => '{string}',
    'metadata' => '{string}',
    'meta' => '{string}',
);

$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({
    # Request parameters
    'labels': '{array}',
    'properties': '{string}',
    'metadata': '{string}',
    'meta': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.ip1sms.com')
    conn.request("GET", "/v2/contacts?%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({
    # Request parameters
    'labels': '{array}',
    'properties': '{string}',
    'metadata': '{string}',
    'meta': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.ip1sms.com')
    conn.request("GET", "/v2/contacts?%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/v2/contacts')

query = URI.encode_www_form({
    # Request parameters
    'labels' => '{array}',
    'properties' => '{string}',
    'metadata' => '{string}',
    'meta' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

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