V1

API change history

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

Updates a given extra field with the given information. NOTE! Existing information is replaced entirely with the new information set.

Try it

Request

Request URL

https://api.ip1sms.com/api/contacts/extra/{extra}

Request parameters

extra

integer

Format - int32. Extra field ID

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.

Request body

Updated extra field data

application/json
text/json

Sample
Schema

{
  "ID": 0,
  "Key": "string",
  "Value": "string"
}

{
  "description": "Data for updating a contact extra field",
  "required": [
    "ID",
    "Key",
    "Value"
  ],
  "type": "object",
  "properties": {
    "ID": {
      "format": "int32",
      "description": "Contact extra field ID",
      "type": "integer"
    },
    "Key": {
      "description": "Contact extra field key/name",
      "type": "string"
    },
    "Value": {
      "description": "Contact extra field value/contents",
      "type": "string"
    }
  }
}

Sample
Schema

{
  "ID": 0,
  "Key": "string",
  "Value": "string"
}

{
  "description": "Data for updating a contact extra field",
  "required": [
    "ID",
    "Key",
    "Value"
  ],
  "type": "object",
  "properties": {
    "ID": {
      "format": "int32",
      "description": "Contact extra field ID",
      "type": "integer"
    },
    "Key": {
      "description": "Contact extra field key/name",
      "type": "string"
    },
    "Value": {
      "description": "Contact extra field value/contents",
      "type": "string"
    }
  }
}

Responses

200 OK

Sample
Schema

{
  "ContactID": 0,
  "Created": "string",
  "ID": 0,
  "Key": "string",
  "Value": "string"
}

{
  "description": "Summary of a contact extra field",
  "required": [
    "ID",
    "Key",
    "Value"
  ],
  "type": "object",
  "properties": {
    "ContactID": {
      "format": "int32",
      "description": "Contact ID",
      "type": "integer"
    },
    "Created": {
      "format": "date-time",
      "description": "Timestamp of extra field creation",
      "type": "string"
    },
    "ID": {
      "format": "int32",
      "description": "Contact extra field ID",
      "type": "integer"
    },
    "Key": {
      "description": "Contact extra field key/name",
      "type": "string"
    },
    "Value": {
      "description": "Contact extra field value/contents",
      "type": "string"
    }
  }
}

Sample
Schema

{
  "ContactID": 0,
  "Created": "string",
  "ID": 0,
  "Key": "string",
  "Value": "string"
}

{
  "description": "Summary of a contact extra field",
  "required": [
    "ID",
    "Key",
    "Value"
  ],
  "type": "object",
  "properties": {
    "ContactID": {
      "format": "int32",
      "description": "Contact ID",
      "type": "integer"
    },
    "Created": {
      "format": "date-time",
      "description": "Timestamp of extra field creation",
      "type": "string"
    },
    "ID": {
      "format": "int32",
      "description": "Contact extra field ID",
      "type": "integer"
    },
    "Key": {
      "description": "Contact extra field key/name",
      "type": "string"
    },
    "Value": {
      "description": "Contact extra field value/contents",
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api.ip1sms.com/api/contacts/extra/{extra}"
-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/contacts/extra/{extra}?" + 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/api/contacts/extra/{extra}");


            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/api/contacts/extra/{extra}?" + $.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/api/contacts/extra/{extra}";
    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/api/contacts/extra/{extra}');
$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", "/api/contacts/extra/{extra}?%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", "/api/contacts/extra/{extra}?%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/contacts/extra/{extra}')


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