V1
API change historyThese APIs lets you use our message services from your applications.
Send an NKI with the given information directly
Send an NKI with the given information directly
Try itRequest
Request URL
Request parameters
-
integer
Format - int32. NKI ID
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Message to send
{
"Numbers": [
"string"
],
"Contacts": [
0
],
"Groups": [
0
],
"Parameters": {},
"Email": true,
"From": "string",
"Message": "string"
}
{
"description": "Complete SMS message information",
"required": [
"From",
"Message"
],
"type": "object",
"properties": {
"Numbers": {
"description": "Recipient phone numbers",
"type": "array",
"items": {
"type": "string"
}
},
"Contacts": {
"description": "Recipient contacts",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"Groups": {
"description": "Recipient groups",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"Parameters": {
"description": "Templating parameters",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"Email": {
"description": "Whether to send SMS copies by email (for contacts with email addresses)",
"type": "boolean"
},
"From": {
"description": "SMS message sender name or phone number",
"type": "string"
},
"Message": {
"description": "SMS message contents",
"type": "string"
}
}
}
{
"Numbers": [
"string"
],
"Contacts": [
0
],
"Groups": [
0
],
"Parameters": {},
"Email": true,
"From": "string",
"Message": "string"
}
{
"description": "Complete SMS message information",
"required": [
"From",
"Message"
],
"type": "object",
"properties": {
"Numbers": {
"description": "Recipient phone numbers",
"type": "array",
"items": {
"type": "string"
}
},
"Contacts": {
"description": "Recipient contacts",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"Groups": {
"description": "Recipient groups",
"type": "array",
"items": {
"format": "int32",
"type": "integer"
}
},
"Parameters": {
"description": "Templating parameters",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"Email": {
"description": "Whether to send SMS copies by email (for contacts with email addresses)",
"type": "boolean"
},
"From": {
"description": "SMS message sender name or phone number",
"type": "string"
},
"Message": {
"description": "SMS message contents",
"type": "string"
}
}
}
Responses
200 OK
OK
Representations
[
{
"ID": 0,
"BundleID": 0,
"Status": 0,
"StatusDescription": "string",
"To": "string",
"CountryCode": "string",
"Currency": 752,
"TotalPrice": 0.0,
"Price": 0.0,
"Encoding": 0,
"Segments": 0,
"From": "string",
"Message": "string"
}
]
{
"type": "array",
"items": {
"description": "Outgoing SMS message information",
"required": [
"From",
"Message"
],
"type": "object",
"properties": {
"ID": {
"format": "int32",
"description": "SMS message ID",
"type": "integer"
},
"BundleID": {
"format": "int32",
"description": "SMS bundle ID, if any",
"type": "integer"
},
"Status": {
"format": "int32",
"description": "SMS message status code",
"type": "integer"
},
"StatusDescription": {
"description": "SMS message status description",
"type": "string",
"readOnly": true
},
"To": {
"description": "Destination phone number",
"type": "string"
},
"CountryCode": {
"description": "Country code of destination phone number if To field is valid, otherwise null",
"type": "string",
"readOnly": true
},
"Currency": {
"format": "int32",
"description": "What currency the SMS was payed in. Is displayed as ISO 4217 Alphabetic code",
"enum": [
752,
978
],
"type": "integer"
},
"TotalPrice": {
"format": "double",
"description": "The price for sending the entire message",
"type": "number"
},
"Price": {
"format": "double",
"description": "The price for sending each segment of the message",
"type": "number"
},
"Encoding": {
"format": "int32",
"description": "Encoding in which the message was encoded",
"enum": [
0,
2
],
"type": "integer",
"readOnly": true
},
"Segments": {
"format": "int32",
"description": "The number of segments the message consists of",
"type": "integer",
"readOnly": true
},
"From": {
"description": "SMS message sender name or phone number",
"type": "string"
},
"Message": {
"description": "SMS message contents",
"type": "string"
}
}
}
}
[
{
"ID": 0,
"BundleID": 0,
"Status": 0,
"StatusDescription": "string",
"To": "string",
"CountryCode": "string",
"Currency": 752,
"TotalPrice": 0.0,
"Price": 0.0,
"Encoding": 0,
"Segments": 0,
"From": "string",
"Message": "string"
}
]
{
"type": "array",
"items": {
"description": "Outgoing SMS message information",
"required": [
"From",
"Message"
],
"type": "object",
"properties": {
"ID": {
"format": "int32",
"description": "SMS message ID",
"type": "integer"
},
"BundleID": {
"format": "int32",
"description": "SMS bundle ID, if any",
"type": "integer"
},
"Status": {
"format": "int32",
"description": "SMS message status code",
"type": "integer"
},
"StatusDescription": {
"description": "SMS message status description",
"type": "string",
"readOnly": true
},
"To": {
"description": "Destination phone number",
"type": "string"
},
"CountryCode": {
"description": "Country code of destination phone number if To field is valid, otherwise null",
"type": "string",
"readOnly": true
},
"Currency": {
"format": "int32",
"description": "What currency the SMS was payed in. Is displayed as ISO 4217 Alphabetic code",
"enum": [
752,
978
],
"type": "integer"
},
"TotalPrice": {
"format": "double",
"description": "The price for sending the entire message",
"type": "number"
},
"Price": {
"format": "double",
"description": "The price for sending each segment of the message",
"type": "number"
},
"Encoding": {
"format": "int32",
"description": "Encoding in which the message was encoded",
"enum": [
0,
2
],
"type": "integer",
"readOnly": true
},
"Segments": {
"format": "int32",
"description": "The number of segments the message consists of",
"type": "integer",
"readOnly": true
},
"From": {
"description": "SMS message sender name or phone number",
"type": "string"
},
"Message": {
"description": "SMS message contents",
"type": "string"
}
}
}
}
Code samples
@ECHO OFF
curl -v -X POST "https://api.ip1sms.com/api/nkis/{nki}/send"
-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/nkis/{nki}/send?" + 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/nkis/{nki}/send");
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/nkis/{nki}/send?" + $.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/nkis/{nki}/send";
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/nkis/{nki}/send');
$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/nkis/{nki}/send?%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/nkis/{nki}/send?%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/nkis/{nki}/send')
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