GiK API

Bots

listBots

List of Bots

List of Bots with criteria


/v1/bots

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://getgik.com/v1/bots?page=&limit=&keyword="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BotsApi;

import java.io.File;
import java.util.*;

public class BotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        BotsApi apiInstance = new BotsApi();
        page page = ; // page | Page to show (default: 1)
        limit limit = ; // limit | Amount of results (default: 10; maximum: 100)
        keyword keyword = ; // keyword | Search name of the Bot
        try {
            ListBots result = apiInstance.listBots(page, limit, keyword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BotsApi#listBots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BotsApi;

public class BotsApiExample {

    public static void main(String[] args) {
        BotsApi apiInstance = new BotsApi();
        page page = ; // page | Page to show (default: 1)
        limit limit = ; // limit | Amount of results (default: 10; maximum: 100)
        keyword keyword = ; // keyword | Search name of the Bot
        try {
            ListBots result = apiInstance.listBots(page, limit, keyword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BotsApi#listBots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
page *page = ; // Page to show (default: 1) (optional)
limit *limit = ; // Amount of results (default: 10; maximum: 100) (optional)
keyword *keyword = ; // Search name of the Bot (optional)

BotsApi *apiInstance = [[BotsApi alloc] init];

// List of Bots
[apiInstance listBotsWith:page
    limit:limit
    keyword:keyword
              completionHandler: ^(ListBots output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.BotsApi()
var opts = { 
  'page': , // {{page}} Page to show (default: 1)
  'limit': , // {{limit}} Amount of results (default: 10; maximum: 100)
  'keyword':  // {{keyword}} Search name of the Bot
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listBots(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listBotsExample
    {
        public void main()
        {


            var apiInstance = new BotsApi();
            var page = new page(); // page | Page to show (default: 1) (optional) 
            var limit = new limit(); // limit | Amount of results (default: 10; maximum: 100) (optional) 
            var keyword = new keyword(); // keyword | Search name of the Bot (optional) 

            try
            {
                // List of Bots
                ListBots result = apiInstance.listBots(page, limit, keyword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BotsApi.listBots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiBotsApi();
$page = ; // page | Page to show (default: 1)
$limit = ; // limit | Amount of results (default: 10; maximum: 100)
$keyword = ; // keyword | Search name of the Bot

try {
    $result = $api_instance->listBots($page, $limit, $keyword);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BotsApi->listBots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BotsApi;


my $api_instance = WWW::SwaggerClient::BotsApi->new();
my $page = ; # page | Page to show (default: 1)
my $limit = ; # limit | Amount of results (default: 10; maximum: 100)
my $keyword = ; # keyword | Search name of the Bot

eval { 
    my $result = $api_instance->listBots(page => $page, limit => $limit, keyword => $keyword);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BotsApi->listBots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.BotsApi()
page =  # page | Page to show (default: 1) (optional)
limit =  # limit | Amount of results (default: 10; maximum: 100) (optional)
keyword =  # keyword | Search name of the Bot (optional)

try: 
    # List of Bots
    api_response = api_instance.list_bots(page=page, limit=limit, keyword=keyword)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BotsApi->listBots: %s\n" % e)

Parameters

Query parameters
Name Description
page
page
Page to show (default: 1)
limit
limit
Amount of results (default: 10; maximum: 100)
keyword
keyword
Search name of the Bot

Responses

Status: 200 - List of bot objects

Status: 400 - An error message when listing bots. Limit must be less than 100

Status: 404 - An error message when listing bots.


Conversations

conversationFeedback

Feedback Conversation from agents

Add feedback Conversation from agents


/v1/conversation_feedback/{id}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://getgik.com/v1/conversation_feedback/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

import java.io.File;
import java.util.*;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter
        Feedback body = ; // Feedback | A Conversation request information object
        try {
            OutMsgResponse result = apiInstance.conversationFeedback(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationFeedback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter
        Feedback body = ; // Feedback | A Conversation request information object
        try {
            OutMsgResponse result = apiInstance.conversationFeedback(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationFeedback");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
id *id = ; // The conversation id parameter
Feedback *body = ; // A Conversation request information object (optional)

ConversationsApi *apiInstance = [[ConversationsApi alloc] init];

// Feedback Conversation from agents
[apiInstance conversationFeedbackWith:id
    body:body
              completionHandler: ^(OutMsgResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.ConversationsApi()
var id = ; // {{id}} The conversation id parameter
var opts = { 
  'body':  // {{Feedback}} A Conversation request information object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.conversationFeedback(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class conversationFeedbackExample
    {
        public void main()
        {


            var apiInstance = new ConversationsApi();
            var id = new id(); // id | The conversation id parameter
            var body = new Feedback(); // Feedback | A Conversation request information object (optional) 

            try
            {
                // Feedback Conversation from agents
                OutMsgResponse result = apiInstance.conversationFeedback(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.conversationFeedback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationsApi();
$id = ; // id | The conversation id parameter
$body = ; // Feedback | A Conversation request information object

try {
    $result = $api_instance->conversationFeedback($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationFeedback: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;


my $api_instance = WWW::SwaggerClient::ConversationsApi->new();
my $id = ; # id | The conversation id parameter
my $body = WWW::SwaggerClient::Object::Feedback->new(); # Feedback | A Conversation request information object

eval { 
    my $result = $api_instance->conversationFeedback(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->conversationFeedback: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationsApi()
id =  # id | The conversation id parameter
body =  # Feedback | A Conversation request information object (optional)

try: 
    # Feedback Conversation from agents
    api_response = api_instance.conversation_feedback(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->conversationFeedback: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id
The conversation id parameter
Required
Body parameters
Name Description
body

Responses

Status: 200 - A Message object. Conversation deleted successfully

Status: 404 - An error message when deleting a conversation. Conversation not Found


createConversation

Create Conversation

Creates a conversation for specific bot


/v1/conversations

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://getgik.com/v1/conversations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

import java.io.File;
import java.util.*;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationsApi apiInstance = new ConversationsApi();
        CreateConversation body = ; // CreateConversation | A Conversation request information object
        try {
            ConversationResponse result = apiInstance.createConversation(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#createConversation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        CreateConversation body = ; // CreateConversation | A Conversation request information object
        try {
            ConversationResponse result = apiInstance.createConversation(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#createConversation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
CreateConversation *body = ; // A Conversation request information object (optional)

ConversationsApi *apiInstance = [[ConversationsApi alloc] init];

// Create Conversation
[apiInstance createConversationWith:body
              completionHandler: ^(ConversationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.ConversationsApi()
var opts = { 
  'body':  // {{CreateConversation}} A Conversation request information object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createConversation(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createConversationExample
    {
        public void main()
        {


            var apiInstance = new ConversationsApi();
            var body = new CreateConversation(); // CreateConversation | A Conversation request information object (optional) 

            try
            {
                // Create Conversation
                ConversationResponse result = apiInstance.createConversation(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.createConversation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationsApi();
$body = ; // CreateConversation | A Conversation request information object

try {
    $result = $api_instance->createConversation($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->createConversation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;


my $api_instance = WWW::SwaggerClient::ConversationsApi->new();
my $body = WWW::SwaggerClient::Object::CreateConversation->new(); # CreateConversation | A Conversation request information object

eval { 
    my $result = $api_instance->createConversation(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->createConversation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationsApi()
body =  # CreateConversation | A Conversation request information object (optional)

try: 
    # Create Conversation
    api_response = api_instance.create_conversation(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->createConversation: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - A conversation object

Status: 404 - An error message when creating a new conversation. Conversation name exists


deleteConversation

Delete Conversation

Deletes a conversation already created


/v1/conversations/{id}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://getgik.com/v1/conversations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

import java.io.File;
import java.util.*;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter to delete
        try {
            OutMsgResponse result = apiInstance.deleteConversation(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#deleteConversation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter to delete
        try {
            OutMsgResponse result = apiInstance.deleteConversation(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#deleteConversation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
id *id = ; // The conversation id parameter to delete

ConversationsApi *apiInstance = [[ConversationsApi alloc] init];

// Delete Conversation
[apiInstance deleteConversationWith:id
              completionHandler: ^(OutMsgResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.ConversationsApi()
var id = ; // {{id}} The conversation id parameter to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteConversation(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteConversationExample
    {
        public void main()
        {


            var apiInstance = new ConversationsApi();
            var id = new id(); // id | The conversation id parameter to delete

            try
            {
                // Delete Conversation
                OutMsgResponse result = apiInstance.deleteConversation(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.deleteConversation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationsApi();
$id = ; // id | The conversation id parameter to delete

try {
    $result = $api_instance->deleteConversation($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->deleteConversation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;


my $api_instance = WWW::SwaggerClient::ConversationsApi->new();
my $id = ; # id | The conversation id parameter to delete

eval { 
    my $result = $api_instance->deleteConversation(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->deleteConversation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationsApi()
id =  # id | The conversation id parameter to delete

try: 
    # Delete Conversation
    api_response = api_instance.delete_conversation(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->deleteConversation: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id
The conversation id parameter to delete
Required

Responses

Status: 200 - A Message object. Conversation deleted successfully

Status: 404 - An error message when deleting a conversation. Conversation not Found


getConversation

Get a Conversation

Creates a conversation for specific bot


/v1/conversations/{id}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://getgik.com/v1/conversations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

import java.io.File;
import java.util.*;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter
        try {
            ConversationResponse result = apiInstance.getConversation(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#getConversation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter
        try {
            ConversationResponse result = apiInstance.getConversation(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#getConversation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
id *id = ; // The conversation id parameter

ConversationsApi *apiInstance = [[ConversationsApi alloc] init];

// Get a Conversation
[apiInstance getConversationWith:id
              completionHandler: ^(ConversationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.ConversationsApi()
var id = ; // {{id}} The conversation id parameter

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConversation(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConversationExample
    {
        public void main()
        {


            var apiInstance = new ConversationsApi();
            var id = new id(); // id | The conversation id parameter

            try
            {
                // Get a Conversation
                ConversationResponse result = apiInstance.getConversation(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.getConversation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationsApi();
$id = ; // id | The conversation id parameter

try {
    $result = $api_instance->getConversation($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->getConversation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;


my $api_instance = WWW::SwaggerClient::ConversationsApi->new();
my $id = ; # id | The conversation id parameter

eval { 
    my $result = $api_instance->getConversation(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->getConversation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationsApi()
id =  # id | The conversation id parameter

try: 
    # Get a Conversation
    api_response = api_instance.get_conversation(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->getConversation: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id
The conversation id parameter
Required

Responses

Status: 200 - A conversation object

Status: 404 - An error message when getting a conversation. Conversation not Found


listConversations

List Conversations

List conversations with criteria


/v1/conversations

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://getgik.com/v1/conversations?page=&limit=&keyword="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

import java.io.File;
import java.util.*;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationsApi apiInstance = new ConversationsApi();
        page page = ; // page | Page to show (default: 1)
        limit limit = ; // limit | Amount of results (default: 10; maximum: 100)
        keyword keyword = ; // keyword | Search name of the Conversations
        try {
            ListConversations result = apiInstance.listConversations(page, limit, keyword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#listConversations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        page page = ; // page | Page to show (default: 1)
        limit limit = ; // limit | Amount of results (default: 10; maximum: 100)
        keyword keyword = ; // keyword | Search name of the Conversations
        try {
            ListConversations result = apiInstance.listConversations(page, limit, keyword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#listConversations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
page *page = ; // Page to show (default: 1) (optional)
limit *limit = ; // Amount of results (default: 10; maximum: 100) (optional)
keyword *keyword = ; // Search name of the Conversations (optional)

ConversationsApi *apiInstance = [[ConversationsApi alloc] init];

// List Conversations
[apiInstance listConversationsWith:page
    limit:limit
    keyword:keyword
              completionHandler: ^(ListConversations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.ConversationsApi()
var opts = { 
  'page': , // {{page}} Page to show (default: 1)
  'limit': , // {{limit}} Amount of results (default: 10; maximum: 100)
  'keyword':  // {{keyword}} Search name of the Conversations
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listConversations(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listConversationsExample
    {
        public void main()
        {


            var apiInstance = new ConversationsApi();
            var page = new page(); // page | Page to show (default: 1) (optional) 
            var limit = new limit(); // limit | Amount of results (default: 10; maximum: 100) (optional) 
            var keyword = new keyword(); // keyword | Search name of the Conversations (optional) 

            try
            {
                // List Conversations
                ListConversations result = apiInstance.listConversations(page, limit, keyword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.listConversations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationsApi();
$page = ; // page | Page to show (default: 1)
$limit = ; // limit | Amount of results (default: 10; maximum: 100)
$keyword = ; // keyword | Search name of the Conversations

try {
    $result = $api_instance->listConversations($page, $limit, $keyword);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->listConversations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;


my $api_instance = WWW::SwaggerClient::ConversationsApi->new();
my $page = ; # page | Page to show (default: 1)
my $limit = ; # limit | Amount of results (default: 10; maximum: 100)
my $keyword = ; # keyword | Search name of the Conversations

eval { 
    my $result = $api_instance->listConversations(page => $page, limit => $limit, keyword => $keyword);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->listConversations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationsApi()
page =  # page | Page to show (default: 1) (optional)
limit =  # limit | Amount of results (default: 10; maximum: 100) (optional)
keyword =  # keyword | Search name of the Conversations (optional)

try: 
    # List Conversations
    api_response = api_instance.list_conversations(page=page, limit=limit, keyword=keyword)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->listConversations: %s\n" % e)

Parameters

Query parameters
Name Description
page
page
Page to show (default: 1)
limit
limit
Amount of results (default: 10; maximum: 100)
keyword
keyword
Search name of the Conversations

Responses

Status: 200 - List of conversation objects

Status: 400 - An error message when listing conversations. Limit must be less than 100

Status: 404 - An error message when listing conversations.


updateConversation

Update Conversation Info

Update a conversation name or/and bot


/v1/conversations/{id}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://getgik.com/v1/conversations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

import java.io.File;
import java.util.*;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter
        CreateConversation body = ; // CreateConversation | A Conversation request information object
        try {
            ConversationResponse result = apiInstance.updateConversation(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#updateConversation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        id id = ; // id | The conversation id parameter
        CreateConversation body = ; // CreateConversation | A Conversation request information object
        try {
            ConversationResponse result = apiInstance.updateConversation(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#updateConversation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
id *id = ; // The conversation id parameter
CreateConversation *body = ; // A Conversation request information object (optional)

ConversationsApi *apiInstance = [[ConversationsApi alloc] init];

// Update Conversation Info
[apiInstance updateConversationWith:id
    body:body
              completionHandler: ^(ConversationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.ConversationsApi()
var id = ; // {{id}} The conversation id parameter
var opts = { 
  'body':  // {{CreateConversation}} A Conversation request information object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConversation(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateConversationExample
    {
        public void main()
        {


            var apiInstance = new ConversationsApi();
            var id = new id(); // id | The conversation id parameter
            var body = new CreateConversation(); // CreateConversation | A Conversation request information object (optional) 

            try
            {
                // Update Conversation Info
                ConversationResponse result = apiInstance.updateConversation(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.updateConversation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConversationsApi();
$id = ; // id | The conversation id parameter
$body = ; // CreateConversation | A Conversation request information object

try {
    $result = $api_instance->updateConversation($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->updateConversation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;


my $api_instance = WWW::SwaggerClient::ConversationsApi->new();
my $id = ; # id | The conversation id parameter
my $body = WWW::SwaggerClient::Object::CreateConversation->new(); # CreateConversation | A Conversation request information object

eval { 
    my $result = $api_instance->updateConversation(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->updateConversation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.ConversationsApi()
id =  # id | The conversation id parameter
body =  # CreateConversation | A Conversation request information object (optional)

try: 
    # Update Conversation Info
    api_response = api_instance.update_conversation(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->updateConversation: %s\n" % e)

Parameters

Path parameters
Name Description
id*
id
The conversation id parameter
Required
Body parameters
Name Description
body

Responses

Status: 200 - A conversation object

Status: 404 - An error message when updating a conversation. Conversation name exists


Messages

listMessages

List of Messages

List of Messages with criteria


/v1/messages

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://getgik.com/v1/messages?page=&limit=&keyword=&conversation_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MessagesApi;

import java.io.File;
import java.util.*;

public class MessagesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MessagesApi apiInstance = new MessagesApi();
        page page = ; // page | Page to show (default: 1)
        limit limit = ; // limit | Amount of results (default: 10; maximum: 100)
        keyword keyword = ; // keyword | Search text of the Message
        conversation_id conversationId = ; // conversation_id | id of the conversation that message belongs
        try {
            ListMessages result = apiInstance.listMessages(page, limit, keyword, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#listMessages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MessagesApi;

public class MessagesApiExample {

    public static void main(String[] args) {
        MessagesApi apiInstance = new MessagesApi();
        page page = ; // page | Page to show (default: 1)
        limit limit = ; // limit | Amount of results (default: 10; maximum: 100)
        keyword keyword = ; // keyword | Search text of the Message
        conversation_id conversationId = ; // conversation_id | id of the conversation that message belongs
        try {
            ListMessages result = apiInstance.listMessages(page, limit, keyword, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#listMessages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
page *page = ; // Page to show (default: 1) (optional)
limit *limit = ; // Amount of results (default: 10; maximum: 100) (optional)
keyword *keyword = ; // Search text of the Message (optional)
conversation_id *conversationId = ; // id of the conversation that message belongs (optional)

MessagesApi *apiInstance = [[MessagesApi alloc] init];

// List of Messages
[apiInstance listMessagesWith:page
    limit:limit
    keyword:keyword
    conversationId:conversationId
              completionHandler: ^(ListMessages output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.MessagesApi()
var opts = { 
  'page': , // {{page}} Page to show (default: 1)
  'limit': , // {{limit}} Amount of results (default: 10; maximum: 100)
  'keyword': , // {{keyword}} Search text of the Message
  'conversationId':  // {{conversation_id}} id of the conversation that message belongs
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listMessages(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listMessagesExample
    {
        public void main()
        {


            var apiInstance = new MessagesApi();
            var page = new page(); // page | Page to show (default: 1) (optional) 
            var limit = new limit(); // limit | Amount of results (default: 10; maximum: 100) (optional) 
            var keyword = new keyword(); // keyword | Search text of the Message (optional) 
            var conversationId = new conversation_id(); // conversation_id | id of the conversation that message belongs (optional) 

            try
            {
                // List of Messages
                ListMessages result = apiInstance.listMessages(page, limit, keyword, conversationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesApi.listMessages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMessagesApi();
$page = ; // page | Page to show (default: 1)
$limit = ; // limit | Amount of results (default: 10; maximum: 100)
$keyword = ; // keyword | Search text of the Message
$conversationId = ; // conversation_id | id of the conversation that message belongs

try {
    $result = $api_instance->listMessages($page, $limit, $keyword, $conversationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->listMessages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MessagesApi;


my $api_instance = WWW::SwaggerClient::MessagesApi->new();
my $page = ; # page | Page to show (default: 1)
my $limit = ; # limit | Amount of results (default: 10; maximum: 100)
my $keyword = ; # keyword | Search text of the Message
my $conversationId = ; # conversation_id | id of the conversation that message belongs

eval { 
    my $result = $api_instance->listMessages(page => $page, limit => $limit, keyword => $keyword, conversationId => $conversationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesApi->listMessages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.MessagesApi()
page =  # page | Page to show (default: 1) (optional)
limit =  # limit | Amount of results (default: 10; maximum: 100) (optional)
keyword =  # keyword | Search text of the Message (optional)
conversationId =  # conversation_id | id of the conversation that message belongs (optional)

try: 
    # List of Messages
    api_response = api_instance.list_messages(page=page, limit=limit, keyword=keyword, conversationId=conversationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesApi->listMessages: %s\n" % e)

Parameters

Query parameters
Name Description
page
page
Page to show (default: 1)
limit
limit
Amount of results (default: 10; maximum: 100)
keyword
keyword
Search text of the Message
conversation_id
conversation_id
id of the conversation that message belongs

Responses

Status: 200 - List of messages that matches the criteria

Status: 400 - An error message when listing messages. Limit must be less than 100

Status: 404 - An error message when listing messages.


sendMessage

Process a message for a Conversation

Creates a message request for a message response


/v1/messages

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://getgik.com/v1/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MessagesApi;

import java.io.File;
import java.util.*;

public class MessagesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MessagesApi apiInstance = new MessagesApi();
        MessageRequest body = ; // MessageRequest | A Message process request object
        try {
            MessageResponse result = apiInstance.sendMessage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#sendMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MessagesApi;

public class MessagesApiExample {

    public static void main(String[] args) {
        MessagesApi apiInstance = new MessagesApi();
        MessageRequest body = ; // MessageRequest | A Message process request object
        try {
            MessageResponse result = apiInstance.sendMessage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#sendMessage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
MessageRequest *body = ; // A Message process request object (optional)

MessagesApi *apiInstance = [[MessagesApi alloc] init];

// Process a message for a Conversation
[apiInstance sendMessageWith:body
              completionHandler: ^(MessageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var GiKApi = require('gi_k_api');
var defaultClient = GiKApi.ApiClient.instance;


var api = new GiKApi.MessagesApi()
var opts = { 
  'body':  // {{MessageRequest}} A Message process request object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendMessage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sendMessageExample
    {
        public void main()
        {


            var apiInstance = new MessagesApi();
            var body = new MessageRequest(); // MessageRequest | A Message process request object (optional) 

            try
            {
                // Process a message for a Conversation
                MessageResponse result = apiInstance.sendMessage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesApi.sendMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMessagesApi();
$body = ; // MessageRequest | A Message process request object

try {
    $result = $api_instance->sendMessage($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->sendMessage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MessagesApi;


my $api_instance = WWW::SwaggerClient::MessagesApi->new();
my $body = WWW::SwaggerClient::Object::MessageRequest->new(); # MessageRequest | A Message process request object

eval { 
    my $result = $api_instance->sendMessage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesApi->sendMessage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.MessagesApi()
body =  # MessageRequest | A Message process request object (optional)

try: 
    # Process a message for a Conversation
    api_response = api_instance.send_message(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesApi->sendMessage: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - A Message object with response

Status: 402 - An error message when processing a message. Query Limit Reached

Status: 404 - An error message when processing a message. Conversation not found