V1
API change historyThese APIs lets you use our message services from your applications.
Creates a new empty survey with the given information
Creates a new empty survey with the given information
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Survey data of new Survey
{
"Header": "string",
"Keyword": "string",
"KeywordResponse": "string",
"WelcomeText": "string",
"ThankYouText": "string",
"AllowAnonymous": true,
"TextColor": "string",
"BackgroundColor": "string",
"ButtonColor": "string",
"AlarmRecipient": "string",
"Name": "string",
"Ends": "string"
}{
"description": "Data for creation of a new survey",
"required": [
"AllowAnonymous",
"Name"
],
"type": "object",
"properties": {
"Header": {
"description": "Survey title",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Keyword": {
"description": "Survey keyword",
"maxLength": 15,
"minLength": 0,
"pattern": "^\\S+$",
"type": "string"
},
"KeywordResponse": {
"description": "If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.",
"type": "string"
},
"WelcomeText": {
"description": "Survey introduction text",
"type": "string"
},
"ThankYouText": {
"description": "Survey completed text",
"type": "string"
},
"AllowAnonymous": {
"description": "Whether to enable recipients to remain anonymous",
"type": "boolean"
},
"TextColor": {
"description": "Color of survey text, hexadecimal (ex. #333333)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"BackgroundColor": {
"description": "Color of survey background, hexadecimal (ex. #eeeeee)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"ButtonColor": {
"description": "Color of survey buttons, hexadecimal (ex. #a1c775)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"AlarmRecipient": {
"description": "Phone number that alarms should be sent to when triggered",
"type": "string"
},
"Name": {
"description": "Survey name",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Ends": {
"format": "date-time",
"description": "Timestamp for survey end, or null if not set",
"type": "string"
}
}
}{
"Header": "string",
"Keyword": "string",
"KeywordResponse": "string",
"WelcomeText": "string",
"ThankYouText": "string",
"AllowAnonymous": true,
"TextColor": "string",
"BackgroundColor": "string",
"ButtonColor": "string",
"AlarmRecipient": "string",
"Name": "string",
"Ends": "string"
}{
"description": "Data for creation of a new survey",
"required": [
"AllowAnonymous",
"Name"
],
"type": "object",
"properties": {
"Header": {
"description": "Survey title",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Keyword": {
"description": "Survey keyword",
"maxLength": 15,
"minLength": 0,
"pattern": "^\\S+$",
"type": "string"
},
"KeywordResponse": {
"description": "If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.",
"type": "string"
},
"WelcomeText": {
"description": "Survey introduction text",
"type": "string"
},
"ThankYouText": {
"description": "Survey completed text",
"type": "string"
},
"AllowAnonymous": {
"description": "Whether to enable recipients to remain anonymous",
"type": "boolean"
},
"TextColor": {
"description": "Color of survey text, hexadecimal (ex. #333333)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"BackgroundColor": {
"description": "Color of survey background, hexadecimal (ex. #eeeeee)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"ButtonColor": {
"description": "Color of survey buttons, hexadecimal (ex. #a1c775)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"AlarmRecipient": {
"description": "Phone number that alarms should be sent to when triggered",
"type": "string"
},
"Name": {
"description": "Survey name",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Ends": {
"format": "date-time",
"description": "Timestamp for survey end, or null if not set",
"type": "string"
}
}
}Responses
200 OK
OK
Representations
{
"Logo": true,
"Created": "string",
"Modified": "string",
"Ended": true,
"ID": 0,
"Header": "string",
"Keyword": "string",
"KeywordResponse": "string",
"WelcomeText": "string",
"ThankYouText": "string",
"AllowAnonymous": true,
"TextColor": "string",
"BackgroundColor": "string",
"ButtonColor": "string",
"AlarmRecipient": "string",
"Name": "string",
"Ends": "string"
}{
"description": "Detailed survey information",
"required": [
"ID",
"AllowAnonymous",
"Name"
],
"type": "object",
"properties": {
"Logo": {
"description": "Whether the survey uses a logo",
"type": "boolean"
},
"Created": {
"format": "date-time",
"description": "Timestamp for survey creation",
"type": "string"
},
"Modified": {
"format": "date-time",
"description": "Timestamp for last modification of survey",
"type": "string"
},
"Ended": {
"description": "Whether the survey has ended or is closed",
"type": "boolean"
},
"ID": {
"format": "int32",
"description": "Survey ID",
"type": "integer"
},
"Header": {
"description": "Survey title",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Keyword": {
"description": "Survey keyword",
"maxLength": 15,
"minLength": 0,
"pattern": "^\\S+$",
"type": "string"
},
"KeywordResponse": {
"description": "If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.",
"type": "string"
},
"WelcomeText": {
"description": "Survey introduction text",
"type": "string"
},
"ThankYouText": {
"description": "Survey completed text",
"type": "string"
},
"AllowAnonymous": {
"description": "Whether to enable recipients to remain anonymous",
"type": "boolean"
},
"TextColor": {
"description": "Color of survey text, hexadecimal (ex. #333333)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"BackgroundColor": {
"description": "Color of survey background, hexadecimal (ex. #eeeeee)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"ButtonColor": {
"description": "Color of survey buttons, hexadecimal (ex. #a1c775)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"AlarmRecipient": {
"description": "Phone number that alarms should be sent to when triggered",
"type": "string"
},
"Name": {
"description": "Survey name",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Ends": {
"format": "date-time",
"description": "Timestamp for survey end, or null if not set",
"type": "string"
}
}
}{
"Logo": true,
"Created": "string",
"Modified": "string",
"Ended": true,
"ID": 0,
"Header": "string",
"Keyword": "string",
"KeywordResponse": "string",
"WelcomeText": "string",
"ThankYouText": "string",
"AllowAnonymous": true,
"TextColor": "string",
"BackgroundColor": "string",
"ButtonColor": "string",
"AlarmRecipient": "string",
"Name": "string",
"Ends": "string"
}{
"description": "Detailed survey information",
"required": [
"ID",
"AllowAnonymous",
"Name"
],
"type": "object",
"properties": {
"Logo": {
"description": "Whether the survey uses a logo",
"type": "boolean"
},
"Created": {
"format": "date-time",
"description": "Timestamp for survey creation",
"type": "string"
},
"Modified": {
"format": "date-time",
"description": "Timestamp for last modification of survey",
"type": "string"
},
"Ended": {
"description": "Whether the survey has ended or is closed",
"type": "boolean"
},
"ID": {
"format": "int32",
"description": "Survey ID",
"type": "integer"
},
"Header": {
"description": "Survey title",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Keyword": {
"description": "Survey keyword",
"maxLength": 15,
"minLength": 0,
"pattern": "^\\S+$",
"type": "string"
},
"KeywordResponse": {
"description": "If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.",
"type": "string"
},
"WelcomeText": {
"description": "Survey introduction text",
"type": "string"
},
"ThankYouText": {
"description": "Survey completed text",
"type": "string"
},
"AllowAnonymous": {
"description": "Whether to enable recipients to remain anonymous",
"type": "boolean"
},
"TextColor": {
"description": "Color of survey text, hexadecimal (ex. #333333)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"BackgroundColor": {
"description": "Color of survey background, hexadecimal (ex. #eeeeee)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"ButtonColor": {
"description": "Color of survey buttons, hexadecimal (ex. #a1c775)",
"pattern": "^#([A-Fa-f0-9]{6})$",
"type": "string"
},
"AlarmRecipient": {
"description": "Phone number that alarms should be sent to when triggered",
"type": "string"
},
"Name": {
"description": "Survey name",
"maxLength": 150,
"minLength": 0,
"type": "string"
},
"Ends": {
"format": "date-time",
"description": "Timestamp for survey end, or null if not set",
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X POST "https://api.ip1sms.com/api/surveys"
-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/surveys?" + 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.PostAsync(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/surveys");
URI uri = builder.build();
HttpPost request = new HttpPost(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/surveys?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
},
type: "POST",
// 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/surveys";
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:@"POST"];
// 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/surveys');
$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_POST);
// 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("POST", "/api/surveys?%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("POST", "/api/surveys?%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/surveys')
request = Net::HTTP::Post.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