V2

API change history

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

Update an SMS message template

Replaces all possible template data

Try it

Request

Request URL

Request parameters

  • string

    Template ID

Request headers

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

Request body

{
  "id": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "string"
  },
  "name": "string",
  "category": "string",
  "pinned": true,
  "body": "string",
  "created": "string",
  "modified": "string"
}
{
  "required": [
    "body",
    "category",
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "object",
      "properties": {
        "timestamp": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "machine": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "pid": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "increment": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "creationTime": {
          "format": "date-time",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "name": {
      "type": "string"
    },
    "category": {
      "pattern": "^/$|^(/[^/]+)+$",
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    },
    "body": {
      "type": "string"
    },
    "created": {
      "format": "date-time",
      "type": "string"
    },
    "modified": {
      "format": "date-time",
      "type": "string"
    }
  },
  "example": "{\r\n  \"id\": {\r\n    \"timestamp\": 0,\r\n    \"machine\": 0,\r\n    \"pid\": 0,\r\n    \"increment\": 0,\r\n    \"creationTime\": \"string\"\r\n  },\r\n  \"name\": \"string\",\r\n  \"category\": \"string\",\r\n  \"pinned\": true,\r\n  \"body\": \"string\",\r\n  \"created\": \"string\",\r\n  \"modified\": \"string\"\r\n}"
}

Responses

200 OK

Updated SMS message template

Representations

{
  "id": {
    "timestamp": 0,
    "machine": 0,
    "pid": 0,
    "increment": 0,
    "creationTime": "string"
  },
  "name": "string",
  "category": "string",
  "pinned": true,
  "body": "string",
  "created": "string",
  "modified": "string"
}
{
  "required": [
    "body",
    "category",
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "object",
      "properties": {
        "timestamp": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "machine": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "pid": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "increment": {
          "format": "int32",
          "type": "integer",
          "readOnly": true
        },
        "creationTime": {
          "format": "date-time",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "name": {
      "type": "string"
    },
    "category": {
      "pattern": "^/$|^(/[^/]+)+$",
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    },
    "body": {
      "type": "string"
    },
    "created": {
      "format": "date-time",
      "type": "string"
    },
    "modified": {
      "format": "date-time",
      "type": "string"
    }
  },
  "example": "{\r\n  \"id\": {\r\n    \"timestamp\": 0,\r\n    \"machine\": 0,\r\n    \"pid\": 0,\r\n    \"increment\": 0,\r\n    \"creationTime\": \"string\"\r\n  },\r\n  \"name\": \"string\",\r\n  \"category\": \"string\",\r\n  \"pinned\": true,\r\n  \"body\": \"string\",\r\n  \"created\": \"string\",\r\n  \"modified\": \"string\"\r\n}"
}

400 Bad Request

Path parameters or body 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

SMS message template missing or unable to update it

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 PUT "https://api.ip1sms.com/v2/batches/templates/{id}"
-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/v2/batches/templates/{id}?" + 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.PutAsync(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/v2/batches/templates/{id}");


            URI uri = builder.build();
            HttpPut request = new HttpPut(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/v2/batches/templates/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "PUT",
            // 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/batches/templates/{id}";
    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:@"PUT"];
    // 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/v2/batches/templates/{id}');
$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_PUT);

// 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("PUT", "/v2/batches/templates/{id}?%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("PUT", "/v2/batches/templates/{id}?%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/batches/templates/{id}')


request = Net::HTTP::Put.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