ShowMe Rest API

API change history

Session invitation

Send session link invitation to the guest user. InvitationType: There are three type of invitations supported by Blitzz, please use 1 for SMS, 2 for WhatsApp and 3 for Email Invite. At a time, only one invitation will work. For WhatsApp, Message is static and you cann't change it. IsoCode: This is the country's ISO code(US or UK or IN). You can get all the supported countries by calling country list API. If you have fixed country everytime then you can directly pass ISO code in request body without calling Country list API. QueryStringParameter is used to turn on/off video and microphone. You can pass these parameters value like "?m=0&c=1&o=0&s=3". All parameters are optional. If not passed, default values will be taken from Call experience settings. m - microphone | 0 - off and 1 - on, c - camera | 0 - off, 1 - back camera on when connect and 2 - front camera on, o - If user wants to Join as Silent Observer | 0 - join as guest and 1 - join as Silent observer, s - default platform support options | 1 - browser first, 2 - app only, 3 - browser only, 4 - ask user.

Try it

Request

Request URL

Request parameters

  • string

    Session id to send invitation

Request headers

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

Request body

{
  "InvitationType": {},
  "IsoCode": "string",
  "MobileNo": "string",
  "EmailAddress": "string",
  "Message": "string",
  "QueryStringParameter": "string"
}
{
  "required": [
    "InvitationType"
  ],
  "type": "object",
  "properties": {
    "InvitationType": {
      "maximum": 5.0,
      "minimum": 1.0,
      "allOf": [
        {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6
          ],
          "type": "integer",
          "format": "int32"
        }
      ]
    },
    "IsoCode": {
      "type": "string",
      "nullable": true
    },
    "MobileNo": {
      "type": "string",
      "nullable": true
    },
    "EmailAddress": {
      "maxLength": 255,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "Message": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "QueryStringParameter": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "InvitationType": {},
  "IsoCode": "string",
  "MobileNo": "string",
  "EmailAddress": "string",
  "Message": "string",
  "QueryStringParameter": "string"
}
{
  "required": [
    "InvitationType"
  ],
  "type": "object",
  "properties": {
    "InvitationType": {
      "maximum": 5.0,
      "minimum": 1.0,
      "allOf": [
        {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6
          ],
          "type": "integer",
          "format": "int32"
        }
      ]
    },
    "IsoCode": {
      "type": "string",
      "nullable": true
    },
    "MobileNo": {
      "type": "string",
      "nullable": true
    },
    "EmailAddress": {
      "maxLength": 255,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "Message": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "QueryStringParameter": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "InvitationType": {},
  "IsoCode": "string",
  "MobileNo": "string",
  "EmailAddress": "string",
  "Message": "string",
  "QueryStringParameter": "string"
}
{
  "required": [
    "InvitationType"
  ],
  "type": "object",
  "properties": {
    "InvitationType": {
      "maximum": 5.0,
      "minimum": 1.0,
      "allOf": [
        {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6
          ],
          "type": "integer",
          "format": "int32"
        }
      ]
    },
    "IsoCode": {
      "type": "string",
      "nullable": true
    },
    "MobileNo": {
      "type": "string",
      "nullable": true
    },
    "EmailAddress": {
      "maxLength": 255,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "Message": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "QueryStringParameter": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

200 OK

Success

Representations

{
  "InvitationType": {},
  "IsoCode": "string",
  "MobileNo": "string",
  "EmailAddress": "string",
  "Message": "string",
  "QueryStringParameter": "string"
}
{
  "required": [
    "InvitationType"
  ],
  "type": "object",
  "properties": {
    "InvitationType": {
      "maximum": 5.0,
      "minimum": 1.0,
      "allOf": [
        {
          "enum": [
            1,
            2,
            3,
            4,
            5,
            6
          ],
          "type": "integer",
          "format": "int32"
        }
      ]
    },
    "IsoCode": {
      "type": "string",
      "nullable": true
    },
    "MobileNo": {
      "type": "string",
      "nullable": true
    },
    "EmailAddress": {
      "maxLength": 255,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "Message": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "QueryStringParameter": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Code samples

@ECHO OFF

curl -v -X POST "https://restapi.blitzz.co/api/session/{SessionId}/invitation"
-H "UserToken: "
-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
            client.DefaultRequestHeaders.Add("UserToken", "");

            var uri = "https://restapi.blitzz.co/api/session/{SessionId}/invitation?" + 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://restapi.blitzz.co/api/session/{SessionId}/invitation");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("UserToken", "");
            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://restapi.blitzz.co/api/session/{SessionId}/invitation?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("UserToken","");
                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://restapi.blitzz.co/api/session/{SessionId}/invitation";
    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:@"" forHTTPHeaderField:@"UserToken"];
    [_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://restapi.blitzz.co/api/session/{SessionId}/invitation');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'UserToken' => '',
    '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
    'UserToken': '',
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('restapi.blitzz.co')
    conn.request("POST", "/api/session/{SessionId}/invitation?%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
    'UserToken': '',
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('restapi.blitzz.co')
    conn.request("POST", "/api/session/{SessionId}/invitation?%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://restapi.blitzz.co/api/session/{SessionId}/invitation')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['UserToken'] = ''
# 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