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 sendings of a survey

Is paginated

Try it

Request

Request URL

Request parameters

  • string

Request body

Responses

200 OK

List of survey sendings

Representations

[
  {
    "participants": [
      "string"
    ],
    "newParticipants": [
      {
        "phoneNumber": "string",
        "emailAddress": "string",
        "properties": {}
      }
    ],
    "channels": [
      "Sms"
    ],
    "defaultProperties": {},
    "sms": {
      "pendingParticipants": [
        "string"
      ],
      "deliveredParticipants": [
        "string"
      ],
      "failedParticipants": [
        "string"
      ],
      "status": "New",
      "sender": "string",
      "body": "string",
      "batchId": "string"
    },
    "email": {
      "pendingParticipants": [
        "string"
      ],
      "deliveredParticipants": [
        "string"
      ],
      "failedParticipants": [
        "string"
      ],
      "status": "New",
      "subject": "string",
      "message": "string",
      "emailIds": [
        "string"
      ]
    },
    "id": "string",
    "surveyId": "string",
    "status": "New"
  }
]
{
  "type": "array",
  "items": {
    "required": [
      "channels",
      "defaultProperties",
      "newParticipants",
      "participants"
    ],
    "type": "object",
    "properties": {
      "participants": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "newParticipants": {
        "type": "array",
        "items": {
          "required": [
            "properties"
          ],
          "type": "object",
          "properties": {
            "phoneNumber": {
              "format": "tel",
              "type": "string"
            },
            "emailAddress": {
              "format": "email",
              "type": "string"
            },
            "properties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          }
        }
      },
      "channels": {
        "type": "array",
        "items": {
          "enum": [
            "Sms",
            "Email"
          ],
          "type": "string"
        }
      },
      "defaultProperties": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      },
      "sms": {
        "required": [
          "body",
          "sender"
        ],
        "type": "object",
        "properties": {
          "pendingParticipants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deliveredParticipants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "failedParticipants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "enum": [
              "New",
              "Pending",
              "Ready",
              "Failed",
              "Sent",
              "Delivered"
            ],
            "type": "string"
          },
          "sender": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "batchId": {
            "type": "string"
          }
        }
      },
      "email": {
        "required": [
          "message",
          "subject"
        ],
        "type": "object",
        "properties": {
          "pendingParticipants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deliveredParticipants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "failedParticipants": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "enum": [
              "New",
              "Pending",
              "Ready",
              "Failed",
              "Sent",
              "Delivered"
            ],
            "type": "string"
          },
          "sender": {
            "type": "string"
          },
          "subject": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "emailIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "id": {
        "type": "string"
      },
      "surveyId": {
        "type": "string"
      },
      "status": {
        "enum": [
          "New",
          "Pending",
          "Ready",
          "Failed",
          "Sent",
          "Delivered"
        ],
        "type": "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 survey sendings 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/surveys/{surveyId}/sendings"

--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/v2/surveys/{surveyId}/sendings?" + 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/surveys/{surveyId}/sendings");


            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/v2/surveys/{surveyId}/sendings?" + $.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/surveys/{surveyId}/sendings";
    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/v2/surveys/{surveyId}/sendings');
$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", "/v2/surveys/{surveyId}/sendings?%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", "/v2/surveys/{surveyId}/sendings?%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/surveys/{surveyId}/sendings')


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