CloudTelephony End User API

ACDAttendantGroup

getACDGroup

Get group

Retrieve information about a specific ACD/Attendant group for a user.<br><br><i>NOTE: This method is DEPRECATED and will be removed in future releases.</i>


/user/acd-attendant-group/{domain}/{user}/{group}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/acd-attendant-group/{domain}/{user}/{group}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | 
        String user = user_example; // String | 
        Long group = 789; // Long | 
        try {
            group result = apiInstance.getACDGroup(domain, user, group);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | 
        String user = user_example; // String | 
        Long group = 789; // Long | 
        try {
            group result = apiInstance.getACDGroup(domain, user, group);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // 
String *user = user_example; // 
Long *group = 789; // 

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

// Get group
[apiInstance getACDGroupWith:domain
    user:user
    group:group
              completionHandler: ^(group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} 
var user = user_example; // {{String}} 
var group = 789; // {{Long}} 

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

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | 
            var user = user_example;  // String | 
            var group = 789;  // Long | 

            try
            {
                // Get group
                group result = apiInstance.getACDGroup(domain, user, group);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.getACDGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | 
$user = user_example; // String | 
$group = 789; // Long | 

try {
    $result = $api_instance->getACDGroup($domain, $user, $group);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->getACDGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | 
my $user = user_example; # String | 
my $group = 789; # Long | 

eval { 
    my $result = $api_instance->getACDGroup(domain => $domain, user => $user, group => $group);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->getACDGroup: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | 
user = user_example # String | 
group = 789 # Long | 

try: 
    # Get group
    api_response = api_instance.get_acd_group(domain, user, group)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->getACDGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
user*
String
Required
group*
Long (int64)
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getACDGroup1

Get group

Retrieve information about a specific ACD/Attendant group for a user. It is possible to filter out the statistics.<br><br><i>NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.</i>


/user/acd-attendant-group/{domain}/{user}/{group}/{group-domain}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/acd-attendant-group/{domain}/{user}/{group}/{group-domain}?ignoreStatistics="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user id of the user
        Long group = 789; // Long | The id of the ACD/Attendant group
        String groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response
        try {
            group result = apiInstance.getACDGroup1(domain, user, group, groupDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroup1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user id of the user
        Long group = 789; // Long | The id of the ACD/Attendant group
        String groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response
        try {
            group result = apiInstance.getACDGroup1(domain, user, group, groupDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroup1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user's organization
String *user = user_example; // The user id of the user
Long *group = 789; // The id of the ACD/Attendant group
String *groupDomain = groupDomain_example; // The domain of the organization the ACD/Attendant group belongs to
Boolean *ignoreStatistics = true; // Don't include statistics and immediately return an empty response

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

// Get group
[apiInstance getACDGroup1With:domain
    user:user
    group:group
    groupDomain:groupDomain
    ignoreStatistics:ignoreStatistics
              completionHandler: ^(group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} The domain of the user's organization
var user = user_example; // {{String}} The user id of the user
var group = 789; // {{Long}} The id of the ACD/Attendant group
var groupDomain = groupDomain_example; // {{String}} The domain of the organization the ACD/Attendant group belongs to
var ignoreStatistics = true; // {{Boolean}} Don't include statistics and immediately return an empty response

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

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | The domain of the user's organization
            var user = user_example;  // String | The user id of the user
            var group = 789;  // Long | The id of the ACD/Attendant group
            var groupDomain = groupDomain_example;  // String | The domain of the organization the ACD/Attendant group belongs to
            var ignoreStatistics = true;  // Boolean | Don't include statistics and immediately return an empty response

            try
            {
                // Get group
                group result = apiInstance.getACDGroup1(domain, user, group, groupDomain, ignoreStatistics);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.getACDGroup1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | The domain of the user's organization
$user = user_example; // String | The user id of the user
$group = 789; // Long | The id of the ACD/Attendant group
$groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
$ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response

try {
    $result = $api_instance->getACDGroup1($domain, $user, $group, $groupDomain, $ignoreStatistics);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->getACDGroup1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | The domain of the user's organization
my $user = user_example; # String | The user id of the user
my $group = 789; # Long | The id of the ACD/Attendant group
my $groupDomain = groupDomain_example; # String | The domain of the organization the ACD/Attendant group belongs to
my $ignoreStatistics = true; # Boolean | Don't include statistics and immediately return an empty response

eval { 
    my $result = $api_instance->getACDGroup1(domain => $domain, user => $user, group => $group, groupDomain => $groupDomain, ignoreStatistics => $ignoreStatistics);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->getACDGroup1: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | The domain of the user's organization
user = user_example # String | The user id of the user
group = 789 # Long | The id of the ACD/Attendant group
groupDomain = groupDomain_example # String | The domain of the organization the ACD/Attendant group belongs to
ignoreStatistics = true # Boolean | Don't include statistics and immediately return an empty response

try: 
    # Get group
    api_response = api_instance.get_acd_group1(domain, user, group, groupDomain, ignoreStatistics)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->getACDGroup1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user's organization
Required
user*
String
The user id of the user
Required
group*
Long (int64)
The id of the ACD/Attendant group
Required
group-domain*
String
The domain of the organization the ACD/Attendant group belongs to
Required
Query parameters
Name Description
ignoreStatistics*
Boolean
Don't include statistics and immediately return an empty response
Required

Responses

Status: 200 - OK

{"id":5,"domain":"example.org","name":"TestAttendantGroup","type":"ATTENDANT","loggedIn":true,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":true,"isAvailable":true},{"id":"agent4@example.org","firstName":"Agent","activity":"Available","lastName":"Four","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":1,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":true}
{"id":5,"domain":"example.org","name":"TestAttendantGroup","type":"ATTENDANT","loggedIn":true,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":true,"isAvailable":true},{"id":"agent4@example.org","firstName":"Agent","activity":"Available","lastName":"Four","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":1,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":true}

Status: 403 - Not Authorized

Status: 404 - Not Found


getACDGroupV1

Get group

Retrieve information about a specific ACD/ACD Light/Attendant group for a user. It is possible to filter out the statistics.


/user/acd-attendant-group/v1/{domain}/{user}/{group}/{group-domain}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//user/acd-attendant-group/v1/{domain}/{user}/{group}/{group-domain}?ignoreStatistics="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user id of the user
        Long group = 789; // Long | The id of the ACD/ACD Light/Attendant group
        String groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response
        try {
            group result = apiInstance.getACDGroupV1(domain, user, group, groupDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroupV1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user id of the user
        Long group = 789; // Long | The id of the ACD/ACD Light/Attendant group
        String groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response
        try {
            group result = apiInstance.getACDGroupV1(domain, user, group, groupDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroupV1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user's organization
String *user = user_example; // The user id of the user
Long *group = 789; // The id of the ACD/ACD Light/Attendant group
String *groupDomain = groupDomain_example; // The domain of the organization the ACD/Attendant group belongs to
Boolean *ignoreStatistics = true; // Don't include statistics and immediately return an empty response (optional)

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

// Get group
[apiInstance getACDGroupV1With:domain
    user:user
    group:group
    groupDomain:groupDomain
    ignoreStatistics:ignoreStatistics
              completionHandler: ^(group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} The domain of the user's organization
var user = user_example; // {{String}} The user id of the user
var group = 789; // {{Long}} The id of the ACD/ACD Light/Attendant group
var groupDomain = groupDomain_example; // {{String}} The domain of the organization the ACD/Attendant group belongs to
var opts = { 
  'ignoreStatistics': true // {{Boolean}} Don't include statistics and immediately return an empty response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getACDGroupV1(domain, user, group, groupDomain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | The domain of the user's organization
            var user = user_example;  // String | The user id of the user
            var group = 789;  // Long | The id of the ACD/ACD Light/Attendant group
            var groupDomain = groupDomain_example;  // String | The domain of the organization the ACD/Attendant group belongs to
            var ignoreStatistics = true;  // Boolean | Don't include statistics and immediately return an empty response (optional) 

            try
            {
                // Get group
                group result = apiInstance.getACDGroupV1(domain, user, group, groupDomain, ignoreStatistics);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.getACDGroupV1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | The domain of the user's organization
$user = user_example; // String | The user id of the user
$group = 789; // Long | The id of the ACD/ACD Light/Attendant group
$groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
$ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response

try {
    $result = $api_instance->getACDGroupV1($domain, $user, $group, $groupDomain, $ignoreStatistics);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->getACDGroupV1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | The domain of the user's organization
my $user = user_example; # String | The user id of the user
my $group = 789; # Long | The id of the ACD/ACD Light/Attendant group
my $groupDomain = groupDomain_example; # String | The domain of the organization the ACD/Attendant group belongs to
my $ignoreStatistics = true; # Boolean | Don't include statistics and immediately return an empty response

eval { 
    my $result = $api_instance->getACDGroupV1(domain => $domain, user => $user, group => $group, groupDomain => $groupDomain, ignoreStatistics => $ignoreStatistics);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->getACDGroupV1: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | The domain of the user's organization
user = user_example # String | The user id of the user
group = 789 # Long | The id of the ACD/ACD Light/Attendant group
groupDomain = groupDomain_example # String | The domain of the organization the ACD/Attendant group belongs to
ignoreStatistics = true # Boolean | Don't include statistics and immediately return an empty response (optional)

try: 
    # Get group
    api_response = api_instance.get_acd_group_v1(domain, user, group, groupDomain, ignoreStatistics=ignoreStatistics)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->getACDGroupV1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user's organization
Required
user*
String
The user id of the user
Required
group*
Long (int64)
The id of the ACD/ACD Light/Attendant group
Required
group-domain*
String
The domain of the organization the ACD/Attendant group belongs to
Required
Query parameters
Name Description
ignoreStatistics
Boolean
Don't include statistics and immediately return an empty response

Responses

Status: 200 - OK

{"id":5,"domain":"example.org","name":"TestAttendantGroup","type":"ATTENDANT","loggedIn":true,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":true,"isAvailable":true},{"id":"agent4@example.org","firstName":"Agent","activity":"Available","lastName":"Four","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":1,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":true,"distributionType":"PRIORITY"}

Status: 403 - Not Authorized

Status: 404 - Not Found


getACDGroups

List groups

List all ACD/Attendant groups for a user. <br>Login state, availability and activity for all agents/attendants belonging to respective group are also included.<br><br><i>NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.</i>


/user/acd-attendant-group/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/acd-attendant-group/{domain}/{user}?ignoreStatistics=&ignoreAgents="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user's id
        Boolean ignoreStatistics = true; // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
        Boolean ignoreAgents = true; // Boolean | Whether agents shall be included, or not. If omitted, agents will be included.
        try {
            acdAttendantGroups result = apiInstance.getACDGroups(domain, user, ignoreStatistics, ignoreAgents);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user's id
        Boolean ignoreStatistics = true; // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
        Boolean ignoreAgents = true; // Boolean | Whether agents shall be included, or not. If omitted, agents will be included.
        try {
            acdAttendantGroups result = apiInstance.getACDGroups(domain, user, ignoreStatistics, ignoreAgents);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user's organization
String *user = user_example; // The user's id
Boolean *ignoreStatistics = true; // Whether statistics shall be included, or not. If omitted, statistics will be included. (optional)
Boolean *ignoreAgents = true; // Whether agents shall be included, or not. If omitted, agents will be included. (optional)

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

// List groups
[apiInstance getACDGroupsWith:domain
    user:user
    ignoreStatistics:ignoreStatistics
    ignoreAgents:ignoreAgents
              completionHandler: ^(acdAttendantGroups output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} The domain of the user's organization
var user = user_example; // {{String}} The user's id
var opts = { 
  'ignoreStatistics': true, // {{Boolean}} Whether statistics shall be included, or not. If omitted, statistics will be included.
  'ignoreAgents': true // {{Boolean}} Whether agents shall be included, or not. If omitted, agents will be included.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getACDGroups(domain, user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | The domain of the user's organization
            var user = user_example;  // String | The user's id
            var ignoreStatistics = true;  // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included. (optional) 
            var ignoreAgents = true;  // Boolean | Whether agents shall be included, or not. If omitted, agents will be included. (optional) 

            try
            {
                // List groups
                acdAttendantGroups result = apiInstance.getACDGroups(domain, user, ignoreStatistics, ignoreAgents);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.getACDGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | The domain of the user's organization
$user = user_example; // String | The user's id
$ignoreStatistics = true; // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
$ignoreAgents = true; // Boolean | Whether agents shall be included, or not. If omitted, agents will be included.

try {
    $result = $api_instance->getACDGroups($domain, $user, $ignoreStatistics, $ignoreAgents);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->getACDGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | The domain of the user's organization
my $user = user_example; # String | The user's id
my $ignoreStatistics = true; # Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
my $ignoreAgents = true; # Boolean | Whether agents shall be included, or not. If omitted, agents will be included.

eval { 
    my $result = $api_instance->getACDGroups(domain => $domain, user => $user, ignoreStatistics => $ignoreStatistics, ignoreAgents => $ignoreAgents);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->getACDGroups: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | The domain of the user's organization
user = user_example # String | The user's id
ignoreStatistics = true # Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included. (optional)
ignoreAgents = true # Boolean | Whether agents shall be included, or not. If omitted, agents will be included. (optional)

try: 
    # List groups
    api_response = api_instance.get_acd_groups(domain, user, ignoreStatistics=ignoreStatistics, ignoreAgents=ignoreAgents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->getACDGroups: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user's organization
Required
user*
String
The user's id
Required
Query parameters
Name Description
ignoreStatistics
Boolean
Whether statistics shall be included, or not. If omitted, statistics will be included.
ignoreAgents
Boolean
Whether agents shall be included, or not. If omitted, agents will be included.

Responses

Status: 200 - OK

{"groups":[{"id":21,"domain":"example.org","name":"Acd group 1","type":"ACD","loggedIn":false,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"john@example.org","firstName":"John","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"agent3@example.org","firstName":"Agent","activity":"Available","lastName":"Three","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":0,"numberOfFreeAgents":0,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":false},{"id":5,"domain":"example.org","name":"TestAttendantGroup","type":"ATTENDANT","loggedIn":true,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":true,"isAvailable":true},{"id":"agent4@example.org","firstName":"Agent","activity":"Available","lastName":"Four","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":1,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":true},{"id":25,"domain":"example.org","name":"Acd group 2","type":"ACD_LIGHT","loggedIn":false,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"john@example.org","firstName":"John","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"agent3@example.org","firstName":"Agent","activity":"Available","lastName":"Three","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":2,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":false}]}
{"groups":[{"id":21,"domain":"example.org","name":"Acd group 1","type":"ACD","loggedIn":false,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"john@example.org","firstName":"John","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"agent3@example.org","firstName":"Agent","activity":"Available","lastName":"Three","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":0,"numberOfFreeAgents":0,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":false},{"id":5,"domain":"example.org","name":"TestAttendantGroup","type":"ATTENDANT","loggedIn":true,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":true,"isAvailable":true},{"id":"agent4@example.org","firstName":"Agent","activity":"Available","lastName":"Four","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":1,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":true},{"id":25,"domain":"example.org","name":"Acd group 2","type":"ACD_LIGHT","loggedIn":false,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"john@example.org","firstName":"John","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"agent3@example.org","firstName":"Agent","activity":"Available","lastName":"Three","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":2,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":false}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


getACDGroupsV1

List groups

List all ACD/ACD Light/Attendant groups for a user. <br>Login state, availability and activity for all agents/attendants belonging to respective group are also included.


/user/acd-attendant-group/v1/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//user/acd-attendant-group/v1/{domain}/{user}?ignoreStatistics=&ignoreAgents="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user's id
        Boolean ignoreStatistics = true; // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
        Boolean ignoreAgents = true; // Boolean | Whether agents shall be included, or not. If omitted, agents will be included.
        try {
            acdAttendantGroups result = apiInstance.getACDGroupsV1(domain, user, ignoreStatistics, ignoreAgents);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroupsV1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user's id
        Boolean ignoreStatistics = true; // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
        Boolean ignoreAgents = true; // Boolean | Whether agents shall be included, or not. If omitted, agents will be included.
        try {
            acdAttendantGroups result = apiInstance.getACDGroupsV1(domain, user, ignoreStatistics, ignoreAgents);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#getACDGroupsV1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user's organization
String *user = user_example; // The user's id
Boolean *ignoreStatistics = true; // Whether statistics shall be included, or not. If omitted, statistics will be included. (optional)
Boolean *ignoreAgents = true; // Whether agents shall be included, or not. If omitted, agents will be included. (optional)

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

// List groups
[apiInstance getACDGroupsV1With:domain
    user:user
    ignoreStatistics:ignoreStatistics
    ignoreAgents:ignoreAgents
              completionHandler: ^(acdAttendantGroups output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} The domain of the user's organization
var user = user_example; // {{String}} The user's id
var opts = { 
  'ignoreStatistics': true, // {{Boolean}} Whether statistics shall be included, or not. If omitted, statistics will be included.
  'ignoreAgents': true // {{Boolean}} Whether agents shall be included, or not. If omitted, agents will be included.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getACDGroupsV1(domain, user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | The domain of the user's organization
            var user = user_example;  // String | The user's id
            var ignoreStatistics = true;  // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included. (optional) 
            var ignoreAgents = true;  // Boolean | Whether agents shall be included, or not. If omitted, agents will be included. (optional) 

            try
            {
                // List groups
                acdAttendantGroups result = apiInstance.getACDGroupsV1(domain, user, ignoreStatistics, ignoreAgents);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.getACDGroupsV1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | The domain of the user's organization
$user = user_example; // String | The user's id
$ignoreStatistics = true; // Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
$ignoreAgents = true; // Boolean | Whether agents shall be included, or not. If omitted, agents will be included.

try {
    $result = $api_instance->getACDGroupsV1($domain, $user, $ignoreStatistics, $ignoreAgents);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->getACDGroupsV1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | The domain of the user's organization
my $user = user_example; # String | The user's id
my $ignoreStatistics = true; # Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included.
my $ignoreAgents = true; # Boolean | Whether agents shall be included, or not. If omitted, agents will be included.

eval { 
    my $result = $api_instance->getACDGroupsV1(domain => $domain, user => $user, ignoreStatistics => $ignoreStatistics, ignoreAgents => $ignoreAgents);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->getACDGroupsV1: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | The domain of the user's organization
user = user_example # String | The user's id
ignoreStatistics = true # Boolean | Whether statistics shall be included, or not. If omitted, statistics will be included. (optional)
ignoreAgents = true # Boolean | Whether agents shall be included, or not. If omitted, agents will be included. (optional)

try: 
    # List groups
    api_response = api_instance.get_acd_groups_v1(domain, user, ignoreStatistics=ignoreStatistics, ignoreAgents=ignoreAgents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->getACDGroupsV1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user's organization
Required
user*
String
The user's id
Required
Query parameters
Name Description
ignoreStatistics
Boolean
Whether statistics shall be included, or not. If omitted, statistics will be included.
ignoreAgents
Boolean
Whether agents shall be included, or not. If omitted, agents will be included.

Responses

Status: 200 - OK

{"groups":[{"id":21,"domain":"example.org","name":"Acd group 1","type":"ACD","loggedIn":false,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"john@example.org","firstName":"John","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"agent3@example.org","firstName":"Agent","activity":"Available","lastName":"Three","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":0,"numberOfFreeAgents":0,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":false,"distributionType":"SKILLS"},{"id":5,"domain":"example.org","name":"TestAttendantGroup","type":"ATTENDANT","loggedIn":true,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":true,"isAvailable":true},{"id":"agent4@example.org","firstName":"Agent","activity":"Available","lastName":"Four","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":1,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":true,"distributionType":"PRIORITY"},{"id":25,"domain":"example.org","name":"Acd group 2","type":"ACD_LIGHT","loggedIn":false,"nightMode":false,"agents":[{"id":"jane@example.org","firstName":"Jane","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"john@example.org","firstName":"John","activity":"Available","lastName":"Doe","skillLevel":3,"isLoggedIn":false,"isAvailable":true},{"id":"agent3@example.org","firstName":"Agent","activity":"Available","lastName":"Three","skillLevel":3,"isLoggedIn":false,"isAvailable":true}],"roles":[{"type":"AGENT"}],"statistic":{"numberOfLoggedInAgents":2,"numberOfFreeAgents":1,"numberOfCallsInQueue":0},"allowUsingFunctionNumber":false,"distributionType":"PRIORITY"}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


loginAgent

Log in/Log out

To log in/log out an agent or attendant of an ACD/Attendant group<br><br><i>NOTE: This method is DEPRECATED and will be removed in future releases.</i>


/user/acd-attendant-group/{domain}/{user}/{group}/agents/{agent}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/acd-attendant-group/{domain}/{user}/{group}/agents/{agent}?action=&logout="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | 
        String user = user_example; // String | 
        Long group = 789; // Long | 
        String agent = agent_example; // String | 
        String action = action_example; // String | 
        String logout = logout_example; // String | 
        try {
            group result = apiInstance.loginAgent(domain, user, group, agent, action, logout);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#loginAgent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | 
        String user = user_example; // String | 
        Long group = 789; // Long | 
        String agent = agent_example; // String | 
        String action = action_example; // String | 
        String logout = logout_example; // String | 
        try {
            group result = apiInstance.loginAgent(domain, user, group, agent, action, logout);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#loginAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // 
String *user = user_example; // 
Long *group = 789; // 
String *agent = agent_example; // 
String *action = action_example; //  (optional)
String *logout = logout_example; //  (optional)

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

// Log in/Log out
[apiInstance loginAgentWith:domain
    user:user
    group:group
    agent:agent
    action:action
    logout:logout
              completionHandler: ^(group output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} 
var user = user_example; // {{String}} 
var group = 789; // {{Long}} 
var agent = agent_example; // {{String}} 
var opts = { 
  'action': action_example, // {{String}} 
  'logout': logout_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loginAgent(domain, user, group, agent, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | 
            var user = user_example;  // String | 
            var group = 789;  // Long | 
            var agent = agent_example;  // String | 
            var action = action_example;  // String |  (optional) 
            var logout = logout_example;  // String |  (optional) 

            try
            {
                // Log in/Log out
                group result = apiInstance.loginAgent(domain, user, group, agent, action, logout);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.loginAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | 
$user = user_example; // String | 
$group = 789; // Long | 
$agent = agent_example; // String | 
$action = action_example; // String | 
$logout = logout_example; // String | 

try {
    $result = $api_instance->loginAgent($domain, $user, $group, $agent, $action, $logout);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->loginAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | 
my $user = user_example; # String | 
my $group = 789; # Long | 
my $agent = agent_example; # String | 
my $action = action_example; # String | 
my $logout = logout_example; # String | 

eval { 
    my $result = $api_instance->loginAgent(domain => $domain, user => $user, group => $group, agent => $agent, action => $action, logout => $logout);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->loginAgent: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | 
user = user_example # String | 
group = 789 # Long | 
agent = agent_example # String | 
action = action_example # String |  (optional)
logout = logout_example # String |  (optional)

try: 
    # Log in/Log out
    api_response = api_instance.login_agent(domain, user, group, agent, action=action, logout=logout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->loginAgent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
user*
String
Required
group*
Long (int64)
Required
agent*
String
Required
Query parameters
Name Description
action
String
logout
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


loginLogoutAgent

Log in/Log out

To log in/log out an agent or attendant of an ACD/Attendant group


/user/acd-attendant-group/{domain}/{user}/{group}/{group-domain}/agents/{agent}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/acd-attendant-group/{domain}/{user}/{group}/{group-domain}/agents/{agent}?action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ACDAttendantGroupApi;

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

public class ACDAttendantGroupApiExample {

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


        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user id of the user
        Long group = 789; // Long | The id of the ACD/Attendant group
        String groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
        String agent = agent_example; // String | The username of the agent to log in or out, including domain part
        String action = action_example; // String | The action to perform
        try {
            apiInstance.loginLogoutAgent(domain, user, group, groupDomain, agent, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#loginLogoutAgent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ACDAttendantGroupApi;

public class ACDAttendantGroupApiExample {

    public static void main(String[] args) {
        ACDAttendantGroupApi apiInstance = new ACDAttendantGroupApi();
        String domain = domain_example; // String | The domain of the user's organization
        String user = user_example; // String | The user id of the user
        Long group = 789; // Long | The id of the ACD/Attendant group
        String groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
        String agent = agent_example; // String | The username of the agent to log in or out, including domain part
        String action = action_example; // String | The action to perform
        try {
            apiInstance.loginLogoutAgent(domain, user, group, groupDomain, agent, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling ACDAttendantGroupApi#loginLogoutAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user's organization
String *user = user_example; // The user id of the user
Long *group = 789; // The id of the ACD/Attendant group
String *groupDomain = groupDomain_example; // The domain of the organization the ACD/Attendant group belongs to
String *agent = agent_example; // The username of the agent to log in or out, including domain part
String *action = action_example; // The action to perform

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

// Log in/Log out
[apiInstance loginLogoutAgentWith:domain
    user:user
    group:group
    groupDomain:groupDomain
    agent:agent
    action:action
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ACDAttendantGroupApi()
var domain = domain_example; // {{String}} The domain of the user's organization
var user = user_example; // {{String}} The user id of the user
var group = 789; // {{Long}} The id of the ACD/Attendant group
var groupDomain = groupDomain_example; // {{String}} The domain of the organization the ACD/Attendant group belongs to
var agent = agent_example; // {{String}} The username of the agent to log in or out, including domain part
var action = action_example; // {{String}} The action to perform

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.loginLogoutAgent(domain, user, group, groupDomain, agent, action, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ACDAttendantGroupApi();
            var domain = domain_example;  // String | The domain of the user's organization
            var user = user_example;  // String | The user id of the user
            var group = 789;  // Long | The id of the ACD/Attendant group
            var groupDomain = groupDomain_example;  // String | The domain of the organization the ACD/Attendant group belongs to
            var agent = agent_example;  // String | The username of the agent to log in or out, including domain part
            var action = action_example;  // String | The action to perform

            try
            {
                // Log in/Log out
                apiInstance.loginLogoutAgent(domain, user, group, groupDomain, agent, action);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ACDAttendantGroupApi.loginLogoutAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiACDAttendantGroupApi();
$domain = domain_example; // String | The domain of the user's organization
$user = user_example; // String | The user id of the user
$group = 789; // Long | The id of the ACD/Attendant group
$groupDomain = groupDomain_example; // String | The domain of the organization the ACD/Attendant group belongs to
$agent = agent_example; // String | The username of the agent to log in or out, including domain part
$action = action_example; // String | The action to perform

try {
    $api_instance->loginLogoutAgent($domain, $user, $group, $groupDomain, $agent, $action);
} catch (Exception $e) {
    echo 'Exception when calling ACDAttendantGroupApi->loginLogoutAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ACDAttendantGroupApi;


my $api_instance = WWW::SwaggerClient::ACDAttendantGroupApi->new();
my $domain = domain_example; # String | The domain of the user's organization
my $user = user_example; # String | The user id of the user
my $group = 789; # Long | The id of the ACD/Attendant group
my $groupDomain = groupDomain_example; # String | The domain of the organization the ACD/Attendant group belongs to
my $agent = agent_example; # String | The username of the agent to log in or out, including domain part
my $action = action_example; # String | The action to perform

eval { 
    $api_instance->loginLogoutAgent(domain => $domain, user => $user, group => $group, groupDomain => $groupDomain, agent => $agent, action => $action);
};
if ($@) {
    warn "Exception when calling ACDAttendantGroupApi->loginLogoutAgent: $@\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.ACDAttendantGroupApi()
domain = domain_example # String | The domain of the user's organization
user = user_example # String | The user id of the user
group = 789 # Long | The id of the ACD/Attendant group
groupDomain = groupDomain_example # String | The domain of the organization the ACD/Attendant group belongs to
agent = agent_example # String | The username of the agent to log in or out, including domain part
action = action_example # String | The action to perform

try: 
    # Log in/Log out
    api_instance.login_logout_agent(domain, user, group, groupDomain, agent, action)
except ApiException as e:
    print("Exception when calling ACDAttendantGroupApi->loginLogoutAgent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user's organization
Required
user*
String
The user id of the user
Required
group*
Long (int64)
The id of the ACD/Attendant group
Required
group-domain*
String
The domain of the organization the ACD/Attendant group belongs to
Required
agent*
String
The username of the agent to log in or out, including domain part
Required
Query parameters
Name Description
action*
String
The action to perform
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


ActivityDiversionMapping

clearMappings

Delete diversions

Delete all activity diversions for a user.


/activitydiversionmapping/{domain}/{userId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//activitydiversionmapping/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActivityDiversionMappingApi;

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

public class ActivityDiversionMappingApiExample {

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


        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.clearMappings(userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#clearMappings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActivityDiversionMappingApi;

public class ActivityDiversionMappingApiExample {

    public static void main(String[] args) {
        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.clearMappings(userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#clearMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The user ID of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Delete diversions
[apiInstance clearMappingsWith:userId
    domain:domain
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ActivityDiversionMappingApi()
var userId = userId_example; // {{String}} The user ID of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.clearMappings(userId, domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ActivityDiversionMappingApi();
            var userId = userId_example;  // String | The user ID of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Delete diversions
                apiInstance.clearMappings(userId, domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityDiversionMappingApi.clearMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiActivityDiversionMappingApi();
$userId = userId_example; // String | The user ID of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $api_instance->clearMappings($userId, $domain);
} catch (Exception $e) {
    echo 'Exception when calling ActivityDiversionMappingApi->clearMappings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActivityDiversionMappingApi;


my $api_instance = WWW::SwaggerClient::ActivityDiversionMappingApi->new();
my $userId = userId_example; # String | The user ID of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    $api_instance->clearMappings(userId => $userId, domain => $domain);
};
if ($@) {
    warn "Exception when calling ActivityDiversionMappingApi->clearMappings: $@\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.ActivityDiversionMappingApi()
userId = userId_example # String | The user ID of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Delete diversions
    api_instance.clear_mappings(userId, domain)
except ApiException as e:
    print("Exception when calling ActivityDiversionMappingApi->clearMappings: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The user ID of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


deleteMapping

Delete activity diversion

Delete diversion for specified activity for a user.<br>Available activity ids can be fetched with the Configuration API.


/activitydiversionmapping/{domain}/{userId}/{activityId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//activitydiversionmapping/{domain}/{userId}/{activityId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActivityDiversionMappingApi;

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

public class ActivityDiversionMappingApiExample {

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


        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String activityId = activityId_example; // String | The ID of the activity
        try {
            apiInstance.deleteMapping(userId, domain, activityId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#deleteMapping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActivityDiversionMappingApi;

public class ActivityDiversionMappingApiExample {

    public static void main(String[] args) {
        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String activityId = activityId_example; // String | The ID of the activity
        try {
            apiInstance.deleteMapping(userId, domain, activityId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#deleteMapping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The user ID of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *activityId = activityId_example; // The ID of the activity

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

// Delete activity diversion
[apiInstance deleteMappingWith:userId
    domain:domain
    activityId:activityId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ActivityDiversionMappingApi()
var userId = userId_example; // {{String}} The user ID of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var activityId = activityId_example; // {{String}} The ID of the activity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteMapping(userId, domain, activityId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ActivityDiversionMappingApi();
            var userId = userId_example;  // String | The user ID of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var activityId = activityId_example;  // String | The ID of the activity

            try
            {
                // Delete activity diversion
                apiInstance.deleteMapping(userId, domain, activityId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityDiversionMappingApi.deleteMapping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiActivityDiversionMappingApi();
$userId = userId_example; // String | The user ID of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$activityId = activityId_example; // String | The ID of the activity

try {
    $api_instance->deleteMapping($userId, $domain, $activityId);
} catch (Exception $e) {
    echo 'Exception when calling ActivityDiversionMappingApi->deleteMapping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActivityDiversionMappingApi;


my $api_instance = WWW::SwaggerClient::ActivityDiversionMappingApi->new();
my $userId = userId_example; # String | The user ID of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $activityId = activityId_example; # String | The ID of the activity

eval { 
    $api_instance->deleteMapping(userId => $userId, domain => $domain, activityId => $activityId);
};
if ($@) {
    warn "Exception when calling ActivityDiversionMappingApi->deleteMapping: $@\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.ActivityDiversionMappingApi()
userId = userId_example # String | The user ID of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
activityId = activityId_example # String | The ID of the activity

try: 
    # Delete activity diversion
    api_instance.delete_mapping(userId, domain, activityId)
except ApiException as e:
    print("Exception when calling ActivityDiversionMappingApi->deleteMapping: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The user ID of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
activityId*
String
The ID of the activity
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


getMapping

Get activity diversion

Get the diversion number for a specified activity for a user.<br>Available activity ids can be fetched with the Configuration API.


/activitydiversionmapping/{domain}/{userId}/{activityId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//activitydiversionmapping/{domain}/{userId}/{activityId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActivityDiversionMappingApi;

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

public class ActivityDiversionMappingApiExample {

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


        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String activityId = activityId_example; // String | The ID of the activity
        try {
            DiversionMappingDTO result = apiInstance.getMapping(userId, domain, activityId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#getMapping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActivityDiversionMappingApi;

public class ActivityDiversionMappingApiExample {

    public static void main(String[] args) {
        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String activityId = activityId_example; // String | The ID of the activity
        try {
            DiversionMappingDTO result = apiInstance.getMapping(userId, domain, activityId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#getMapping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The user ID of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *activityId = activityId_example; // The ID of the activity

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

// Get activity diversion
[apiInstance getMappingWith:userId
    domain:domain
    activityId:activityId
              completionHandler: ^(DiversionMappingDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ActivityDiversionMappingApi()
var userId = userId_example; // {{String}} The user ID of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var activityId = activityId_example; // {{String}} The ID of the activity

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

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


            var apiInstance = new ActivityDiversionMappingApi();
            var userId = userId_example;  // String | The user ID of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var activityId = activityId_example;  // String | The ID of the activity

            try
            {
                // Get activity diversion
                DiversionMappingDTO result = apiInstance.getMapping(userId, domain, activityId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityDiversionMappingApi.getMapping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiActivityDiversionMappingApi();
$userId = userId_example; // String | The user ID of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$activityId = activityId_example; // String | The ID of the activity

try {
    $result = $api_instance->getMapping($userId, $domain, $activityId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivityDiversionMappingApi->getMapping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActivityDiversionMappingApi;


my $api_instance = WWW::SwaggerClient::ActivityDiversionMappingApi->new();
my $userId = userId_example; # String | The user ID of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $activityId = activityId_example; # String | The ID of the activity

eval { 
    my $result = $api_instance->getMapping(userId => $userId, domain => $domain, activityId => $activityId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivityDiversionMappingApi->getMapping: $@\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.ActivityDiversionMappingApi()
userId = userId_example # String | The user ID of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
activityId = activityId_example # String | The ID of the activity

try: 
    # Get activity diversion
    api_response = api_instance.get_mapping(userId, domain, activityId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivityDiversionMappingApi->getMapping: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The user ID of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
activityId*
String
The ID of the activity
Required

Responses

Status: 200 - OK

{"activityId":"lunch","phoneNumber":"+12345679"}
{"activityId":"lunch","phoneNumber":"+12345679"}

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


getMappings

List diversions

Get all activity diversions for a user.


/activitydiversionmapping/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//activitydiversionmapping/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActivityDiversionMappingApi;

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

public class ActivityDiversionMappingApiExample {

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


        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            DiversionMappingsDTO result = apiInstance.getMappings(userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#getMappings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActivityDiversionMappingApi;

public class ActivityDiversionMappingApiExample {

    public static void main(String[] args) {
        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            DiversionMappingsDTO result = apiInstance.getMappings(userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#getMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The user ID of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// List diversions
[apiInstance getMappingsWith:userId
    domain:domain
              completionHandler: ^(DiversionMappingsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ActivityDiversionMappingApi()
var userId = userId_example; // {{String}} The user ID of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

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

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


            var apiInstance = new ActivityDiversionMappingApi();
            var userId = userId_example;  // String | The user ID of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // List diversions
                DiversionMappingsDTO result = apiInstance.getMappings(userId, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityDiversionMappingApi.getMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiActivityDiversionMappingApi();
$userId = userId_example; // String | The user ID of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

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


my $api_instance = WWW::SwaggerClient::ActivityDiversionMappingApi->new();
my $userId = userId_example; # String | The user ID of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    my $result = $api_instance->getMappings(userId => $userId, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivityDiversionMappingApi->getMappings: $@\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.ActivityDiversionMappingApi()
userId = userId_example # String | The user ID of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # List diversions
    api_response = api_instance.get_mappings(userId, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivityDiversionMappingApi->getMappings: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The user ID of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

{"diversion-mapping":[{"activityId":"busy","phoneNumber":"+12345678"},{"activityId":"lunch","phoneNumber":"+12345679"},{"activityId":"out_of_office","phoneNumber":"+12345679"}]}
{"diversion-mapping":[{"activityId":"busy","phoneNumber":"+12345678"},{"activityId":"lunch","phoneNumber":"+12345679"},{"activityId":"out_of_office","phoneNumber":"+12345679"}]}

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


updateMapping

Set activity diversion

Set an activity diversion for a user.<br>Both POST and PUT can be used in the request.<br>Available activity ids can be fetched with the Configuration API.


/activitydiversionmapping/{domain}/{userId}/{activityId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//activitydiversionmapping/{domain}/{userId}/{activityId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActivityDiversionMappingApi;

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

public class ActivityDiversionMappingApiExample {

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


        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        DiversionMappingDTO body = {
  "phoneNumber" : "+12345679"
}; // DiversionMappingDTO | 
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String activityId = activityId_example; // String | The ID of the activity
        try {
            DiversionMappingDTO result = apiInstance.updateMapping(body, userId, domain, activityId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#updateMapping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActivityDiversionMappingApi;

public class ActivityDiversionMappingApiExample {

    public static void main(String[] args) {
        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        DiversionMappingDTO body = {
  "phoneNumber" : "+12345679"
}; // DiversionMappingDTO | 
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String activityId = activityId_example; // String | The ID of the activity
        try {
            DiversionMappingDTO result = apiInstance.updateMapping(body, userId, domain, activityId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#updateMapping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
DiversionMappingDTO *body = {
  "phoneNumber" : "+12345679"
}; // 
String *userId = userId_example; // The user ID of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *activityId = activityId_example; // The ID of the activity

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

// Set activity diversion
[apiInstance updateMappingWith:body
    userId:userId
    domain:domain
    activityId:activityId
              completionHandler: ^(DiversionMappingDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ActivityDiversionMappingApi()
var body = {
  "phoneNumber" : "+12345679"
}; // {{DiversionMappingDTO}} 
var userId = userId_example; // {{String}} The user ID of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var activityId = activityId_example; // {{String}} The ID of the activity

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

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


            var apiInstance = new ActivityDiversionMappingApi();
            var body = new DiversionMappingDTO(); // DiversionMappingDTO | 
            var userId = userId_example;  // String | The user ID of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var activityId = activityId_example;  // String | The ID of the activity

            try
            {
                // Set activity diversion
                DiversionMappingDTO result = apiInstance.updateMapping(body, userId, domain, activityId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityDiversionMappingApi.updateMapping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiActivityDiversionMappingApi();
$body = {
  "phoneNumber" : "+12345679"
}; // DiversionMappingDTO | 
$userId = userId_example; // String | The user ID of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$activityId = activityId_example; // String | The ID of the activity

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


my $api_instance = WWW::SwaggerClient::ActivityDiversionMappingApi->new();
my $body = WWW::SwaggerClient::Object::DiversionMappingDTO->new(); # DiversionMappingDTO | 
my $userId = userId_example; # String | The user ID of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $activityId = activityId_example; # String | The ID of the activity

eval { 
    my $result = $api_instance->updateMapping(body => $body, userId => $userId, domain => $domain, activityId => $activityId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivityDiversionMappingApi->updateMapping: $@\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.ActivityDiversionMappingApi()
body = {
  "phoneNumber" : "+12345679"
} # DiversionMappingDTO | 
userId = userId_example # String | The user ID of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
activityId = activityId_example # String | The ID of the activity

try: 
    # Set activity diversion
    api_response = api_instance.update_mapping(body, userId, domain, activityId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivityDiversionMappingApi->updateMapping: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The user ID of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
activityId*
String
The ID of the activity
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"activityId":"out_of_office","phoneNumber":"+12345679"}
{"activityId":"out_of_office","phoneNumber":"+12345679"}

Status: 400 - Input parameters missing or invalid

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


updateMappings

Set diversions

Set activity diversions for a user.<br>Both POST and PUT can be used in the request.<br>This will replace all existing settings.


/activitydiversionmapping/{domain}/{userId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//activitydiversionmapping/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActivityDiversionMappingApi;

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

public class ActivityDiversionMappingApiExample {

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


        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        DiversionMappingsDTO body = {
  "diversion-mapping" : [ {
    "activityId" : "busy",
    "phoneNumber" : "+12345678"
  }, {
    "activityId" : "lunch",
    "phoneNumber" : "+12345679"
  }, {
    "activityId" : "out_of_office",
    "phoneNumber" : "+12345679"
  } ]
}; // DiversionMappingsDTO | 
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            DiversionMappingsDTO result = apiInstance.updateMappings(body, userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#updateMappings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActivityDiversionMappingApi;

public class ActivityDiversionMappingApiExample {

    public static void main(String[] args) {
        ActivityDiversionMappingApi apiInstance = new ActivityDiversionMappingApi();
        DiversionMappingsDTO body = {
  "diversion-mapping" : [ {
    "activityId" : "busy",
    "phoneNumber" : "+12345678"
  }, {
    "activityId" : "lunch",
    "phoneNumber" : "+12345679"
  }, {
    "activityId" : "out_of_office",
    "phoneNumber" : "+12345679"
  } ]
}; // DiversionMappingsDTO | 
        String userId = userId_example; // String | The user ID of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            DiversionMappingsDTO result = apiInstance.updateMappings(body, userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityDiversionMappingApi#updateMappings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
DiversionMappingsDTO *body = {
  "diversion-mapping" : [ {
    "activityId" : "busy",
    "phoneNumber" : "+12345678"
  }, {
    "activityId" : "lunch",
    "phoneNumber" : "+12345679"
  }, {
    "activityId" : "out_of_office",
    "phoneNumber" : "+12345679"
  } ]
}; // 
String *userId = userId_example; // The user ID of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Set diversions
[apiInstance updateMappingsWith:body
    userId:userId
    domain:domain
              completionHandler: ^(DiversionMappingsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ActivityDiversionMappingApi()
var body = {
  "diversion-mapping" : [ {
    "activityId" : "busy",
    "phoneNumber" : "+12345678"
  }, {
    "activityId" : "lunch",
    "phoneNumber" : "+12345679"
  }, {
    "activityId" : "out_of_office",
    "phoneNumber" : "+12345679"
  } ]
}; // {{DiversionMappingsDTO}} 
var userId = userId_example; // {{String}} The user ID of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

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

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


            var apiInstance = new ActivityDiversionMappingApi();
            var body = new DiversionMappingsDTO(); // DiversionMappingsDTO | 
            var userId = userId_example;  // String | The user ID of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Set diversions
                DiversionMappingsDTO result = apiInstance.updateMappings(body, userId, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActivityDiversionMappingApi.updateMappings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiActivityDiversionMappingApi();
$body = {
  "diversion-mapping" : [ {
    "activityId" : "busy",
    "phoneNumber" : "+12345678"
  }, {
    "activityId" : "lunch",
    "phoneNumber" : "+12345679"
  }, {
    "activityId" : "out_of_office",
    "phoneNumber" : "+12345679"
  } ]
}; // DiversionMappingsDTO | 
$userId = userId_example; // String | The user ID of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

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


my $api_instance = WWW::SwaggerClient::ActivityDiversionMappingApi->new();
my $body = WWW::SwaggerClient::Object::DiversionMappingsDTO->new(); # DiversionMappingsDTO | 
my $userId = userId_example; # String | The user ID of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    my $result = $api_instance->updateMappings(body => $body, userId => $userId, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActivityDiversionMappingApi->updateMappings: $@\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.ActivityDiversionMappingApi()
body = {
  "diversion-mapping" : [ {
    "activityId" : "busy",
    "phoneNumber" : "+12345678"
  }, {
    "activityId" : "lunch",
    "phoneNumber" : "+12345679"
  }, {
    "activityId" : "out_of_office",
    "phoneNumber" : "+12345679"
  } ]
} # DiversionMappingsDTO | 
userId = userId_example # String | The user ID of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Set diversions
    api_response = api_instance.update_mappings(body, userId, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActivityDiversionMappingApi->updateMappings: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The user ID of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"diversion-mapping":[{"activityId":"busy","phoneNumber":"+12345678"},{"activityId":"lunch","phoneNumber":"+12345679"},{"activityId":"out_of_office","phoneNumber":"+12345679"}]}
{"diversion-mapping":[{"activityId":"busy","phoneNumber":"+12345678"},{"activityId":"lunch","phoneNumber":"+12345679"},{"activityId":"out_of_office","phoneNumber":"+12345679"}]}

Status: 400 - Input parameters missing or invalid

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


BuddyList

addContactToBuddyList

Add contact

Add a contact to a user's favourites.


/buddy_list/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//buddy_list/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BuddyListApi;

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

public class BuddyListApiExample {

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


        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String cid = cid_example; // String | The contact ID of the user we want to add to the favourites list
        try {
            apiInstance.addContactToBuddyList(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#addContactToBuddyList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BuddyListApi;

public class BuddyListApiExample {

    public static void main(String[] args) {
        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String cid = cid_example; // String | The contact ID of the user we want to add to the favourites list
        try {
            apiInstance.addContactToBuddyList(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#addContactToBuddyList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user whose contact list we are managing
String *cid = cid_example; // The contact ID of the user we want to add to the favourites list

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

// Add contact
[apiInstance addContactToBuddyListWith:domain
    user:user
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.BuddyListApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user whose contact list we are managing
var cid = cid_example; // {{String}} The contact ID of the user we want to add to the favourites list

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addContactToBuddyList(domain, user, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new BuddyListApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user whose contact list we are managing
            var cid = cid_example;  // String | The contact ID of the user we want to add to the favourites list

            try
            {
                // Add contact
                apiInstance.addContactToBuddyList(domain, user, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BuddyListApi.addContactToBuddyList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiBuddyListApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user whose contact list we are managing
$cid = cid_example; // String | The contact ID of the user we want to add to the favourites list

try {
    $api_instance->addContactToBuddyList($domain, $user, $cid);
} catch (Exception $e) {
    echo 'Exception when calling BuddyListApi->addContactToBuddyList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BuddyListApi;


my $api_instance = WWW::SwaggerClient::BuddyListApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user whose contact list we are managing
my $cid = cid_example; # String | The contact ID of the user we want to add to the favourites list

eval { 
    $api_instance->addContactToBuddyList(domain => $domain, user => $user, cid => $cid);
};
if ($@) {
    warn "Exception when calling BuddyListApi->addContactToBuddyList: $@\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.BuddyListApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user whose contact list we are managing
cid = cid_example # String | The contact ID of the user we want to add to the favourites list

try: 
    # Add contact
    api_instance.add_contact_to_buddy_list(domain, user, cid)
except ApiException as e:
    print("Exception when calling BuddyListApi->addContactToBuddyList: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user whose contact list we are managing
Required
cid*
String
The contact ID of the user we want to add to the favourites list
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not found


deleteContactFromBuddyList

Delete contact

Delete a contact from a user's favourites.


/buddy_list/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//buddy_list/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BuddyListApi;

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

public class BuddyListApiExample {

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


        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String cid = cid_example; // String | The contact ID of the user we want to remove from the favourites list
        try {
            apiInstance.deleteContactFromBuddyList(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#deleteContactFromBuddyList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BuddyListApi;

public class BuddyListApiExample {

    public static void main(String[] args) {
        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String cid = cid_example; // String | The contact ID of the user we want to remove from the favourites list
        try {
            apiInstance.deleteContactFromBuddyList(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#deleteContactFromBuddyList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user whose contact list we are managing
String *cid = cid_example; // The contact ID of the user we want to remove from the favourites list

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

// Delete contact
[apiInstance deleteContactFromBuddyListWith:domain
    user:user
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.BuddyListApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user whose contact list we are managing
var cid = cid_example; // {{String}} The contact ID of the user we want to remove from the favourites list

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteContactFromBuddyList(domain, user, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new BuddyListApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user whose contact list we are managing
            var cid = cid_example;  // String | The contact ID of the user we want to remove from the favourites list

            try
            {
                // Delete contact
                apiInstance.deleteContactFromBuddyList(domain, user, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BuddyListApi.deleteContactFromBuddyList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiBuddyListApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user whose contact list we are managing
$cid = cid_example; // String | The contact ID of the user we want to remove from the favourites list

try {
    $api_instance->deleteContactFromBuddyList($domain, $user, $cid);
} catch (Exception $e) {
    echo 'Exception when calling BuddyListApi->deleteContactFromBuddyList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BuddyListApi;


my $api_instance = WWW::SwaggerClient::BuddyListApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user whose contact list we are managing
my $cid = cid_example; # String | The contact ID of the user we want to remove from the favourites list

eval { 
    $api_instance->deleteContactFromBuddyList(domain => $domain, user => $user, cid => $cid);
};
if ($@) {
    warn "Exception when calling BuddyListApi->deleteContactFromBuddyList: $@\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.BuddyListApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user whose contact list we are managing
cid = cid_example # String | The contact ID of the user we want to remove from the favourites list

try: 
    # Delete contact
    api_instance.delete_contact_from_buddy_list(domain, user, cid)
except ApiException as e:
    print("Exception when calling BuddyListApi->deleteContactFromBuddyList: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user whose contact list we are managing
Required
cid*
String
The contact ID of the user we want to remove from the favourites list
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactFromBuddyList

Verify contact

Verify a contact is in the favourite contact list.


/buddy_list/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//buddy_list/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BuddyListApi;

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

public class BuddyListApiExample {

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


        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String cid = cid_example; // String | The contact ID of the user we want to verify is in the favourites list
        try {
            apiInstance.getContactFromBuddyList(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#getContactFromBuddyList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BuddyListApi;

public class BuddyListApiExample {

    public static void main(String[] args) {
        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String cid = cid_example; // String | The contact ID of the user we want to verify is in the favourites list
        try {
            apiInstance.getContactFromBuddyList(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#getContactFromBuddyList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user whose contact list we are managing
String *cid = cid_example; // The contact ID of the user we want to verify is in the favourites list

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

// Verify contact
[apiInstance getContactFromBuddyListWith:domain
    user:user
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.BuddyListApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user whose contact list we are managing
var cid = cid_example; // {{String}} The contact ID of the user we want to verify is in the favourites list

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getContactFromBuddyList(domain, user, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new BuddyListApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user whose contact list we are managing
            var cid = cid_example;  // String | The contact ID of the user we want to verify is in the favourites list

            try
            {
                // Verify contact
                apiInstance.getContactFromBuddyList(domain, user, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BuddyListApi.getContactFromBuddyList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiBuddyListApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user whose contact list we are managing
$cid = cid_example; // String | The contact ID of the user we want to verify is in the favourites list

try {
    $api_instance->getContactFromBuddyList($domain, $user, $cid);
} catch (Exception $e) {
    echo 'Exception when calling BuddyListApi->getContactFromBuddyList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BuddyListApi;


my $api_instance = WWW::SwaggerClient::BuddyListApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user whose contact list we are managing
my $cid = cid_example; # String | The contact ID of the user we want to verify is in the favourites list

eval { 
    $api_instance->getContactFromBuddyList(domain => $domain, user => $user, cid => $cid);
};
if ($@) {
    warn "Exception when calling BuddyListApi->getContactFromBuddyList: $@\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.BuddyListApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user whose contact list we are managing
cid = cid_example # String | The contact ID of the user we want to verify is in the favourites list

try: 
    # Verify contact
    api_instance.get_contact_from_buddy_list(domain, user, cid)
except ApiException as e:
    print("Exception when calling BuddyListApi->getContactFromBuddyList: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user whose contact list we are managing
Required
cid*
String
The contact ID of the user we want to verify is in the favourites list
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not found


reApplyContactTemplates

Update contact

Update the favourites of a user based on the configured favourites templates of the organization and groups the user belongs to.


/buddy_list/{domain}/{user}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//buddy_list/{domain}/{user}?applyContactTemplates="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BuddyListApi;

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

public class BuddyListApiExample {

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


        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String applyContactTemplates = applyContactTemplates_example; // String | Set to 'true' to generate favourites based on exisiting templates on organization and group level
        try {
            apiInstance.reApplyContactTemplates(domain, user, applyContactTemplates);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#reApplyContactTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BuddyListApi;

public class BuddyListApiExample {

    public static void main(String[] args) {
        BuddyListApi apiInstance = new BuddyListApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user whose contact list we are managing
        String applyContactTemplates = applyContactTemplates_example; // String | Set to 'true' to generate favourites based on exisiting templates on organization and group level
        try {
            apiInstance.reApplyContactTemplates(domain, user, applyContactTemplates);
        } catch (ApiException e) {
            System.err.println("Exception when calling BuddyListApi#reApplyContactTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user whose contact list we are managing
String *applyContactTemplates = applyContactTemplates_example; // Set to 'true' to generate favourites based on exisiting templates on organization and group level

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

// Update contact
[apiInstance reApplyContactTemplatesWith:domain
    user:user
    applyContactTemplates:applyContactTemplates
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.BuddyListApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user whose contact list we are managing
var applyContactTemplates = applyContactTemplates_example; // {{String}} Set to 'true' to generate favourites based on exisiting templates on organization and group level

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.reApplyContactTemplates(domain, user, applyContactTemplates, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new BuddyListApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user whose contact list we are managing
            var applyContactTemplates = applyContactTemplates_example;  // String | Set to 'true' to generate favourites based on exisiting templates on organization and group level

            try
            {
                // Update contact
                apiInstance.reApplyContactTemplates(domain, user, applyContactTemplates);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BuddyListApi.reApplyContactTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiBuddyListApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user whose contact list we are managing
$applyContactTemplates = applyContactTemplates_example; // String | Set to 'true' to generate favourites based on exisiting templates on organization and group level

try {
    $api_instance->reApplyContactTemplates($domain, $user, $applyContactTemplates);
} catch (Exception $e) {
    echo 'Exception when calling BuddyListApi->reApplyContactTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BuddyListApi;


my $api_instance = WWW::SwaggerClient::BuddyListApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user whose contact list we are managing
my $applyContactTemplates = applyContactTemplates_example; # String | Set to 'true' to generate favourites based on exisiting templates on organization and group level

eval { 
    $api_instance->reApplyContactTemplates(domain => $domain, user => $user, applyContactTemplates => $applyContactTemplates);
};
if ($@) {
    warn "Exception when calling BuddyListApi->reApplyContactTemplates: $@\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.BuddyListApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user whose contact list we are managing
applyContactTemplates = applyContactTemplates_example # String | Set to 'true' to generate favourites based on exisiting templates on organization and group level

try: 
    # Update contact
    api_instance.re_apply_contact_templates(domain, user, applyContactTemplates)
except ApiException as e:
    print("Exception when calling BuddyListApi->reApplyContactTemplates: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user whose contact list we are managing
Required
Query parameters
Name Description
applyContactTemplates*
String
Set to 'true' to generate favourites based on exisiting templates on organization and group level
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


CallControl

addToConference

Add call to ad-hoc conference

The call specified by {callId} will be transformed into an ad-hoc conference call, if it is not already, and the call specified in the request body will be added to the conference.


/call/control/v1/addtoconference/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/addtoconference/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        TargetCallDTO body = ; // TargetCallDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user performing the call
        String callId = callId_example; // String | The ID of the call that should be the ad-hoc conference call
        try {
            CallStateDTO result = apiInstance.addToConference(body, domain, userId, callId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#addToConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        TargetCallDTO body = ; // TargetCallDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user performing the call
        String callId = callId_example; // String | The ID of the call that should be the ad-hoc conference call
        try {
            CallStateDTO result = apiInstance.addToConference(body, domain, userId, callId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#addToConference");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
TargetCallDTO *body = ; // 
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user performing the call
String *callId = callId_example; // The ID of the call that should be the ad-hoc conference call

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

// Add call to ad-hoc conference
[apiInstance addToConferenceWith:body
    domain:domain
    userId:userId
    callId:callId
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var body = ; // {{TargetCallDTO}} 
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user performing the call
var callId = callId_example; // {{String}} The ID of the call that should be the ad-hoc conference call

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var body = new TargetCallDTO(); // TargetCallDTO | 
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user performing the call
            var callId = callId_example;  // String | The ID of the call that should be the ad-hoc conference call

            try
            {
                // Add call to ad-hoc conference
                CallStateDTO result = apiInstance.addToConference(body, domain, userId, callId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.addToConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$body = ; // TargetCallDTO | 
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user performing the call
$callId = callId_example; // String | The ID of the call that should be the ad-hoc conference call

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $body = WWW::SwaggerClient::Object::TargetCallDTO->new(); # TargetCallDTO | 
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user performing the call
my $callId = callId_example; # String | The ID of the call that should be the ad-hoc conference call

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
body =  # TargetCallDTO | 
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user performing the call
callId = callId_example # String | The ID of the call that should be the ad-hoc conference call

try: 
    # Add call to ad-hoc conference
    api_response = api_instance.add_to_conference(body, domain, userId, callId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->addToConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user performing the call
Required
callId*
String
The ID of the call that should be the ad-hoc conference call
Required
Body parameters
Name Description
body *
Query parameters
Name Description

Responses

Status: 201 - The call was added to the conference

{"stateToken":48738853,"callId":"xxx111yyy","userId":"alice@organization.org","remoteParty":{"partyId":"conference@organization.org","type":"SERVICE_ID","telUri":"tel:+46277100","displayName":"Conference","displayNumber":"7100"},"participants":[{"id":"xxx22yyy","remoteParty":{"partyId":"adhoc@organization.org","type":"USER_ID","telUri":"tel:+46277565","displayName":"Adrian Hocksley","displayNumber":"7565"},"historyInfo":{"subject":"Main Switchboad number","campOn":true,"initialParty":{"partyId":"daisy@organization.org","type":"USER_ID","telUri":"tel:+46277469","displayName":"Daisy Smith","displayNumber":"7469"},"previousParty":{"partyId":"1234@organization.org","type":"FUNCTION_NUMBER_ID","telUri":"tel:+46277400","displayName":"Switchboard","displayNumber":"7400"},"previousRetargetReason":"DISTRIBUTED"}},{"id":"xxx222yyy","remoteParty":{"partyId":"adhoc@organization.org","type":"USER_ID","telUri":"tel:+46277566","displayName":"Ada Hocklington","displayNumber":"7566"}}],"conference":true,"inbound":true,"intruded":false,"status":"ACTIVE","event":"PARTICIPANT_ADDED","muted":false,"duration":5,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"HOLD"},{"action":"SAVE_REC"},{"action":"PAUSE_REC"}]}

Status: 400 - The call being added was itself a conference call

Status: 403 - Not Authorized

Status: 404 - Domain, user or callId was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


alternateCall

Alternate call

Place an existing call on hold and then retrieves a previously held call. This can also be used to place an existing call on hold and then answer to an alerting call at the same device.


/call/control/v1/alternate/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/alternate/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the two calls
        String callId = callId_example; // String | The ID of the call that should be put on hold
        TargetCallDTO body = ; // TargetCallDTO | 
        try {
            CallStateDTO result = apiInstance.alternateCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#alternateCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the two calls
        String callId = callId_example; // String | The ID of the call that should be put on hold
        TargetCallDTO body = ; // TargetCallDTO | 
        try {
            CallStateDTO result = apiInstance.alternateCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#alternateCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the two calls
String *callId = callId_example; // The ID of the call that should be put on hold
TargetCallDTO *body = ; //  (optional)

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

// Alternate call
[apiInstance alternateCallWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the two calls
var callId = callId_example; // {{String}} The ID of the call that should be put on hold
var opts = { 
  'body':  // {{TargetCallDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.alternateCall(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the two calls
            var callId = callId_example;  // String | The ID of the call that should be put on hold
            var body = new TargetCallDTO(); // TargetCallDTO |  (optional) 

            try
            {
                // Alternate call
                CallStateDTO result = apiInstance.alternateCall(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.alternateCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the two calls
$callId = callId_example; // String | The ID of the call that should be put on hold
$body = ; // TargetCallDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the two calls
my $callId = callId_example; # String | The ID of the call that should be put on hold
my $body = WWW::SwaggerClient::Object::TargetCallDTO->new(); # TargetCallDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the two calls
callId = callId_example # String | The ID of the call that should be put on hold
body =  # TargetCallDTO |  (optional)

try: 
    # Alternate call
    api_response = api_instance.alternate_call(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->alternateCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the two calls
Required
callId*
String
The ID of the call that should be put on hold
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is succesfully altered

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"HELD","muted":false,"duration":25,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"RESUME"},{"action":"PARK"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or device was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to either of the state tokens in the server differed from the expected token in the request


answerCall

Answer call

Answer a call that is in the ringing state using a specific device. Note that it's not possible to perform this action for all devices. The call state will show which devices that can be used.


/call/control/v1/answer/{domain}/{userId}/{callId}/{deviceId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/answer/{domain}/{userId}/{callId}/{deviceId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user answering the call
        String callId = callId_example; // String | The ID of the call to answer
        String deviceId = deviceId_example; // String | The device used to answer the call
        ActionMonitorCallDTO body = {
  "summary" : "Answer incoming call with webhook",
  "description" : "Answer a call and request updates using a public webhook url.",
  "value" : {
    "targetUrl" : "https://example.com/callback?id=34ff",
    "targetId" : "my_callback_id"
  }
}; // ActionMonitorCallDTO | 
        try {
            CallStateDTO result = apiInstance.answerCall(domain, userId, callId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#answerCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user answering the call
        String callId = callId_example; // String | The ID of the call to answer
        String deviceId = deviceId_example; // String | The device used to answer the call
        ActionMonitorCallDTO body = {
  "summary" : "Answer incoming call with webhook",
  "description" : "Answer a call and request updates using a public webhook url.",
  "value" : {
    "targetUrl" : "https://example.com/callback?id=34ff",
    "targetId" : "my_callback_id"
  }
}; // ActionMonitorCallDTO | 
        try {
            CallStateDTO result = apiInstance.answerCall(domain, userId, callId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#answerCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user answering the call
String *callId = callId_example; // The ID of the call to answer
String *deviceId = deviceId_example; // The device used to answer the call
ActionMonitorCallDTO *body = {
  "summary" : "Answer incoming call with webhook",
  "description" : "Answer a call and request updates using a public webhook url.",
  "value" : {
    "targetUrl" : "https://example.com/callback?id=34ff",
    "targetId" : "my_callback_id"
  }
}; //  (optional)

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

// Answer call
[apiInstance answerCallWith:domain
    userId:userId
    callId:callId
    deviceId:deviceId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user answering the call
var callId = callId_example; // {{String}} The ID of the call to answer
var deviceId = deviceId_example; // {{String}} The device used to answer the call
var opts = { 
  'body': {
  "summary" : "Answer incoming call with webhook",
  "description" : "Answer a call and request updates using a public webhook url.",
  "value" : {
    "targetUrl" : "https://example.com/callback?id=34ff",
    "targetId" : "my_callback_id"
  }
} // {{ActionMonitorCallDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.answerCall(domainuserIdcallIddeviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user answering the call
            var callId = callId_example;  // String | The ID of the call to answer
            var deviceId = deviceId_example;  // String | The device used to answer the call
            var body = new ActionMonitorCallDTO(); // ActionMonitorCallDTO |  (optional) 

            try
            {
                // Answer call
                CallStateDTO result = apiInstance.answerCall(domain, userId, callId, deviceId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.answerCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user answering the call
$callId = callId_example; // String | The ID of the call to answer
$deviceId = deviceId_example; // String | The device used to answer the call
$body = {
  "summary" : "Answer incoming call with webhook",
  "description" : "Answer a call and request updates using a public webhook url.",
  "value" : {
    "targetUrl" : "https://example.com/callback?id=34ff",
    "targetId" : "my_callback_id"
  }
}; // ActionMonitorCallDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user answering the call
my $callId = callId_example; # String | The ID of the call to answer
my $deviceId = deviceId_example; # String | The device used to answer the call
my $body = WWW::SwaggerClient::Object::ActionMonitorCallDTO->new(); # ActionMonitorCallDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user answering the call
callId = callId_example # String | The ID of the call to answer
deviceId = deviceId_example # String | The device used to answer the call
body = {
  "summary" : "Answer incoming call with webhook",
  "description" : "Answer a call and request updates using a public webhook url.",
  "value" : {
    "targetUrl" : "https://example.com/callback?id=34ff",
    "targetId" : "my_callback_id"
  }
} # ActionMonitorCallDTO |  (optional)

try: 
    # Answer call
    api_response = api_instance.answer_call(domain, userId, callId, deviceId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->answerCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user answering the call
Required
callId*
String
The ID of the call to answer
Required
deviceId*
String
The device used to answer the call
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is established

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":5,"recording":true,"recordingDuration":5,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"STOP_REC"}]}
{"stateToken":48738853,"callId":"xxx222yyy","userId":"bob@organization.org","remoteParty":{"partyId":"55@internal","type":"CONTACT_ID","telUri":"tel:+465550011","displayNumber":"05550011"},"conference":false,"historyInfo":{"subject":"Main Switchboad number","campOn":true,"initialParty":{"partyId":"daisy@organization.org","type":"USER_ID","telUri":"tel:+46277469","displayName":"Daisy Smith","displayNumber":"7469"},"previousParty":{"partyId":"1234@organization.org","type":"FUNCTION_NUMBER_ID","telUri":"tel:+46277400","displayName":"Switchboard","displayNumber":"7400"},"previousRetargetReason":"DISTRIBUTED"},"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":5,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"SAVE_REC"},{"action":"PAUSE_REC"}]}
{"stateToken":487345453,"callId":"xxxyyy123","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"historyInfo":{"campOn":false,"previousParty":{"partyId":"daisy@organization.org","type":"USER_ID","telUri":"tel:+46277469","displayName":"Daisy Smith","displayNumber":"7469"},"previousRetargetReason":"TRANSFERRED"},"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":5,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"DISCARD_REC"}]}
{"stateToken":48738853,"callId":"xxx222yyy","userId":"bob@organization.org","remoteParty":{"partyId":"55@internal","type":"CONTACT_ID","telUri":"tel:+465550011","displayNumber":"05550011"},"conference":false,"historyInfo":{"subject":"Car service booking","acdSupport":"7463","campOn":false,"previousParty":{"partyId":"4321@organization.org","type":"FUNCTION_NUMBER_ID","telUri":"tel:+46277444","displayName":"Car Support","displayNumber":"7444"},"previousRetargetReason":"DISTRIBUTED"},"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":5,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"SAVE_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or device was not found

Status: 409 - The request was not allowed in the current state of the server


deleteCall

Terminate call

Hanging up (clear) an established call, reject (decline) a call that is in the ringing state or cancel an outbound ringing call.


/call/control/v1/delete/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//call/control/v1/delete/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user deleting the call
        String callId = callId_example; // String | The ID of the call to delete
        try {
            apiInstance.deleteCall(domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#deleteCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user deleting the call
        String callId = callId_example; // String | The ID of the call to delete
        try {
            apiInstance.deleteCall(domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#deleteCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user deleting the call
String *callId = callId_example; // The ID of the call to delete

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

// Terminate call
[apiInstance deleteCallWith:domain
    userId:userId
    callId:callId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user deleting the call
var callId = callId_example; // {{String}} The ID of the call to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCall(domain, userId, callId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user deleting the call
            var callId = callId_example;  // String | The ID of the call to delete

            try
            {
                // Terminate call
                apiInstance.deleteCall(domain, userId, callId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.deleteCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user deleting the call
$callId = callId_example; // String | The ID of the call to delete

try {
    $api_instance->deleteCall($domain, $userId, $callId);
} catch (Exception $e) {
    echo 'Exception when calling CallControlApi->deleteCall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallControlApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user deleting the call
my $callId = callId_example; # String | The ID of the call to delete

eval { 
    $api_instance->deleteCall(domain => $domain, userId => $userId, callId => $callId);
};
if ($@) {
    warn "Exception when calling CallControlApi->deleteCall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user deleting the call
callId = callId_example # String | The ID of the call to delete

try: 
    # Terminate call
    api_instance.delete_call(domain, userId, callId)
except ApiException as e:
    print("Exception when calling CallControlApi->deleteCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user deleting the call
Required
callId*
String
The ID of the call to delete
Required
Query parameters
Name Description

Responses

Status: 200 - Call is terminated

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found


holdCall

Hold call

Put the call on hold. Depending on the configuration of the server, music on hold may be played to the other party.


/call/control/v1/hold/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/hold/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to hold
        String callId = callId_example; // String | The ID of the call to hold
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.holdCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#holdCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to hold
        String callId = callId_example; // String | The ID of the call to hold
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.holdCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#holdCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to hold
String *callId = callId_example; // The ID of the call to hold
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Hold call
[apiInstance holdCallWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to hold
var callId = callId_example; // {{String}} The ID of the call to hold
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.holdCall(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to hold
            var callId = callId_example;  // String | The ID of the call to hold
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Hold call
                CallStateDTO result = apiInstance.holdCall(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.holdCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to hold
$callId = callId_example; // String | The ID of the call to hold
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to hold
my $callId = callId_example; # String | The ID of the call to hold
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to hold
callId = callId_example # String | The ID of the call to hold
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Hold call
    api_response = api_instance.hold_call(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->holdCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to hold
Required
callId*
String
The ID of the call to hold
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is held

{"stateToken":487345453,"callId":"aaa111bbb","userId":"alice@organization.org","remoteParty":{"partyId":"bob@organization.org","type":"USER_ID","telUri":"tel:+46277464","displayName":"Bob Bobson","displayNumber":"7464"},"conference":false,"inbound":false,"intruded":false,"status":"HELD","muted":false,"duration":50,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"RESUME"},{"action":"PARK"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


leaveConference

Leave ad-hoc conference

Leaving an ad-hoc conference allowing any remaining participants to continue the call. To terminate the conference, use the method to terminate a call.


/call/control/v1/leaveconference/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"/api//call/control/v1/leaveconference/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the ad-hoc conference call
        String callId = callId_example; // String | The ID of the ad-hoc conference call
        try {
            CallStateDTO result = apiInstance.leaveConference(domain, userId, callId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#leaveConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the ad-hoc conference call
        String callId = callId_example; // String | The ID of the ad-hoc conference call
        try {
            CallStateDTO result = apiInstance.leaveConference(domain, userId, callId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#leaveConference");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the ad-hoc conference call
String *callId = callId_example; // The ID of the ad-hoc conference call

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

// Leave ad-hoc conference
[apiInstance leaveConferenceWith:domain
    userId:userId
    callId:callId
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the ad-hoc conference call
var callId = callId_example; // {{String}} The ID of the ad-hoc conference call

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the ad-hoc conference call
            var callId = callId_example;  // String | The ID of the ad-hoc conference call

            try
            {
                // Leave ad-hoc conference
                CallStateDTO result = apiInstance.leaveConference(domain, userId, callId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.leaveConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the ad-hoc conference call
$callId = callId_example; // String | The ID of the ad-hoc conference call

try {
    $result = $api_instance->leaveConference($domain, $userId, $callId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallControlApi->leaveConference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallControlApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the ad-hoc conference call
my $callId = callId_example; # String | The ID of the ad-hoc conference call

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the ad-hoc conference call
callId = callId_example # String | The ID of the ad-hoc conference call

try: 
    # Leave ad-hoc conference
    api_response = api_instance.leave_conference(domain, userId, callId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->leaveConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the ad-hoc conference call
Required
callId*
String
The ID of the ad-hoc conference call
Required
Query parameters
Name Description

Responses

Status: 200 - The user successfully left the conference

{"stateToken":48738853,"callId":"xxx222yyy","userId":"alice@organization.org","conference":true,"inbound":true,"intruded":false,"status":"TERMINATED","event":"LEFT_CONFERENCE","muted":false,"duration":0}

Status: 400 - The call is not an ad-hoc conference

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server


makeCall

Make call

Setup up call from a particular device. The device ID can be fetched from the UserDeviceInfo API. Successful completion of this request does not mean that the call is established, just that the device has successfully initiated the call.


/call/control/v1/make/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/make/{domain}/{userId}/{deviceId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        ActionMakeDTO body = {
  "summary" : "External destination",
  "description" : "Alice makes a call from her primary line to the external number +1444344.",
  "value" : {
    "destination" : "tel:+1444344",
    "userLine" : {
      "type" : "OFFICE_FIXED",
      "groupId" : 1
    }
  }
}; // ActionMakeDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user performing the call
        String deviceId = deviceId_example; // String | The device used to perform the call
        try {
            CallStateDTO result = apiInstance.makeCall(body, domain, userId, deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#makeCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        ActionMakeDTO body = {
  "summary" : "External destination",
  "description" : "Alice makes a call from her primary line to the external number +1444344.",
  "value" : {
    "destination" : "tel:+1444344",
    "userLine" : {
      "type" : "OFFICE_FIXED",
      "groupId" : 1
    }
  }
}; // ActionMakeDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user performing the call
        String deviceId = deviceId_example; // String | The device used to perform the call
        try {
            CallStateDTO result = apiInstance.makeCall(body, domain, userId, deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#makeCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
ActionMakeDTO *body = {
  "summary" : "External destination",
  "description" : "Alice makes a call from her primary line to the external number +1444344.",
  "value" : {
    "destination" : "tel:+1444344",
    "userLine" : {
      "type" : "OFFICE_FIXED",
      "groupId" : 1
    }
  }
}; // 
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user performing the call
String *deviceId = deviceId_example; // The device used to perform the call

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

// Make call
[apiInstance makeCallWith:body
    domain:domain
    userId:userId
    deviceId:deviceId
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var body = {
  "summary" : "External destination",
  "description" : "Alice makes a call from her primary line to the external number +1444344.",
  "value" : {
    "destination" : "tel:+1444344",
    "userLine" : {
      "type" : "OFFICE_FIXED",
      "groupId" : 1
    }
  }
}; // {{ActionMakeDTO}} 
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user performing the call
var deviceId = deviceId_example; // {{String}} The device used to perform the call

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var body = new ActionMakeDTO(); // ActionMakeDTO | 
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user performing the call
            var deviceId = deviceId_example;  // String | The device used to perform the call

            try
            {
                // Make call
                CallStateDTO result = apiInstance.makeCall(body, domain, userId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.makeCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$body = {
  "summary" : "External destination",
  "description" : "Alice makes a call from her primary line to the external number +1444344.",
  "value" : {
    "destination" : "tel:+1444344",
    "userLine" : {
      "type" : "OFFICE_FIXED",
      "groupId" : 1
    }
  }
}; // ActionMakeDTO | 
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user performing the call
$deviceId = deviceId_example; // String | The device used to perform the call

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $body = WWW::SwaggerClient::Object::ActionMakeDTO->new(); # ActionMakeDTO | 
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user performing the call
my $deviceId = deviceId_example; # String | The device used to perform the call

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
body = {
  "summary" : "External destination",
  "description" : "Alice makes a call from her primary line to the external number +1444344.",
  "value" : {
    "destination" : "tel:+1444344",
    "userLine" : {
      "type" : "OFFICE_FIXED",
      "groupId" : 1
    }
  }
} # ActionMakeDTO | 
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user performing the call
deviceId = deviceId_example # String | The device used to perform the call

try: 
    # Make call
    api_response = api_instance.make_call(body, domain, userId, deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->makeCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user performing the call
Required
deviceId*
String
The device used to perform the call
Required
Body parameters
Name Description
body *
Query parameters
Name Description

Responses

Status: 201 - Call is initated

{"stateToken":487345453,"callId":"aaa111bbb","userId":"alice@organization.org","remoteParty":{"partyId":"bob@organization.org","type":"USER_ID","telUri":"tel:+46277464","displayName":"Bob Bobson","displayNumber":"7464"},"conference":false,"inbound":false,"intruded":false,"status":"INITIATED","muted":false,"duration":0,"deviceIds":["+1555555"]}

Status: 202 - The call setup has been initiated, but the processing has not been completed

Status: 403 - Not Authorized

Status: 404 - Domain, user or device was not found


moveCall

Move call

Move the established call to another available device for the user. Should the call be on hold, then it will remain on hold in the new device.


/call/control/v1/move/{domain}/{userId}/{callId}/{deviceId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/move/{domain}/{userId}/{callId}/{deviceId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to move
        String callId = callId_example; // String | The ID of the call to move
        String deviceId = deviceId_example; // String | The device to move the call to
        ExpectedStateTokenDTO body = {
  "summary" : "Move without state token",
  "description" : "Move a call to another device.",
  "value" : { }
}; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.moveCall(domain, userId, callId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#moveCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to move
        String callId = callId_example; // String | The ID of the call to move
        String deviceId = deviceId_example; // String | The device to move the call to
        ExpectedStateTokenDTO body = {
  "summary" : "Move without state token",
  "description" : "Move a call to another device.",
  "value" : { }
}; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.moveCall(domain, userId, callId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#moveCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to move
String *callId = callId_example; // The ID of the call to move
String *deviceId = deviceId_example; // The device to move the call to
ExpectedStateTokenDTO *body = {
  "summary" : "Move without state token",
  "description" : "Move a call to another device.",
  "value" : { }
}; //  (optional)

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

// Move call
[apiInstance moveCallWith:domain
    userId:userId
    callId:callId
    deviceId:deviceId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to move
var callId = callId_example; // {{String}} The ID of the call to move
var deviceId = deviceId_example; // {{String}} The device to move the call to
var opts = { 
  'body': {
  "summary" : "Move without state token",
  "description" : "Move a call to another device.",
  "value" : { }
} // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.moveCall(domainuserIdcallIddeviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to move
            var callId = callId_example;  // String | The ID of the call to move
            var deviceId = deviceId_example;  // String | The device to move the call to
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Move call
                CallStateDTO result = apiInstance.moveCall(domain, userId, callId, deviceId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.moveCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to move
$callId = callId_example; // String | The ID of the call to move
$deviceId = deviceId_example; // String | The device to move the call to
$body = {
  "summary" : "Move without state token",
  "description" : "Move a call to another device.",
  "value" : { }
}; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to move
my $callId = callId_example; # String | The ID of the call to move
my $deviceId = deviceId_example; # String | The device to move the call to
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to move
callId = callId_example # String | The ID of the call to move
deviceId = deviceId_example # String | The device to move the call to
body = {
  "summary" : "Move without state token",
  "description" : "Move a call to another device.",
  "value" : { }
} # ExpectedStateTokenDTO |  (optional)

try: 
    # Move call
    api_response = api_instance.move_call(domain, userId, callId, deviceId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->moveCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to move
Required
callId*
String
The ID of the call to move
Required
deviceId*
String
The device to move the call to
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is moved

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or device was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


muteCall

Mute call

Mute an ongoing call. Depending on the type of call this action may or may not be available.


/call/control/v1/mute/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/mute/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to mute
        String callId = callId_example; // String | The ID of the call to mute
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.muteCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#muteCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to mute
        String callId = callId_example; // String | The ID of the call to mute
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.muteCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#muteCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to mute
String *callId = callId_example; // The ID of the call to mute
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Mute call
[apiInstance muteCallWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to mute
var callId = callId_example; // {{String}} The ID of the call to mute
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.muteCall(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to mute
            var callId = callId_example;  // String | The ID of the call to mute
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Mute call
                CallStateDTO result = apiInstance.muteCall(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.muteCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to mute
$callId = callId_example; // String | The ID of the call to mute
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to mute
my $callId = callId_example; # String | The ID of the call to mute
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to mute
callId = callId_example # String | The ID of the call to mute
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Mute call
    api_response = api_instance.mute_call(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->muteCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to mute
Required
callId*
String
The ID of the call to mute
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is muted

{"stateToken":487345453,"callId":"aaa111bbb","userId":"alice@organization.org","remoteParty":{"partyId":"bob@organization.org","type":"USER_ID","telUri":"tel:+46277464","displayName":"Bob Bobson","displayNumber":"7464"},"conference":false,"inbound":false,"intruded":false,"status":"ACTIVE","event":"MUTED","muted":true,"duration":50,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"RESUME"},{"action":"PARK"},{"action":"UNMUTE"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


parkCall

Park call

Park the call and make it available for other users, or the same user, to pick it up. The call is no longer belonging to the user, meaning that the Call ID is removed from the user's state.


/call/control/v1/park/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/park/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to park
        String callId = callId_example; // String | The ID of the call to park
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            apiInstance.parkCall(domain, userId, callId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#parkCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to park
        String callId = callId_example; // String | The ID of the call to park
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            apiInstance.parkCall(domain, userId, callId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#parkCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to park
String *callId = callId_example; // The ID of the call to park
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Park call
[apiInstance parkCallWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to park
var callId = callId_example; // {{String}} The ID of the call to park
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.parkCall(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to park
            var callId = callId_example;  // String | The ID of the call to park
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Park call
                apiInstance.parkCall(domain, userId, callId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.parkCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to park
$callId = callId_example; // String | The ID of the call to park
$body = ; // ExpectedStateTokenDTO | 

try {
    $api_instance->parkCall($domain, $userId, $callId, $body);
} catch (Exception $e) {
    echo 'Exception when calling CallControlApi->parkCall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallControlApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to park
my $callId = callId_example; # String | The ID of the call to park
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

eval { 
    $api_instance->parkCall(domain => $domain, userId => $userId, callId => $callId, body => $body);
};
if ($@) {
    warn "Exception when calling CallControlApi->parkCall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to park
callId = callId_example # String | The ID of the call to park
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Park call
    api_instance.park_call(domain, userId, callId, body=body)
except ApiException as e:
    print("Exception when calling CallControlApi->parkCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to park
Required
callId*
String
The ID of the call to park
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is parked

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


pickupSipCall

Pick up SIP call

Pickup a SIP call from a queue or a ringing call for another user using the specified device. The SIP dialog Id of the call must be known and the user must be configured to pick up another user calls.


/call/control/v1/pickup/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/pickup/{domain}/{userId}/{deviceId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user picking up the call
        String deviceId = deviceId_example; // String | The device to use to pickup the call
        ActionSIPCallPickupDTO body = ; // ActionSIPCallPickupDTO | 
        try {
            CallStateDTO result = apiInstance.pickupSipCall(domain, userId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#pickupSipCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user picking up the call
        String deviceId = deviceId_example; // String | The device to use to pickup the call
        ActionSIPCallPickupDTO body = ; // ActionSIPCallPickupDTO | 
        try {
            CallStateDTO result = apiInstance.pickupSipCall(domain, userId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#pickupSipCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user picking up the call
String *deviceId = deviceId_example; // The device to use to pickup the call
ActionSIPCallPickupDTO *body = ; //  (optional)

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

// Pick up SIP call
[apiInstance pickupSipCallWith:domain
    userId:userId
    deviceId:deviceId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user picking up the call
var deviceId = deviceId_example; // {{String}} The device to use to pickup the call
var opts = { 
  'body':  // {{ActionSIPCallPickupDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pickupSipCall(domainuserIddeviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user picking up the call
            var deviceId = deviceId_example;  // String | The device to use to pickup the call
            var body = new ActionSIPCallPickupDTO(); // ActionSIPCallPickupDTO |  (optional) 

            try
            {
                // Pick up SIP call
                CallStateDTO result = apiInstance.pickupSipCall(domain, userId, deviceId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.pickupSipCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user picking up the call
$deviceId = deviceId_example; // String | The device to use to pickup the call
$body = ; // ActionSIPCallPickupDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user picking up the call
my $deviceId = deviceId_example; # String | The device to use to pickup the call
my $body = WWW::SwaggerClient::Object::ActionSIPCallPickupDTO->new(); # ActionSIPCallPickupDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user picking up the call
deviceId = deviceId_example # String | The device to use to pickup the call
body =  # ActionSIPCallPickupDTO |  (optional)

try: 
    # Pick up SIP call
    api_response = api_instance.pickup_sip_call(domain, userId, deviceId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->pickupSipCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user picking up the call
Required
deviceId*
String
The device to use to pickup the call
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is picked up

Status: 202 - The call pickup has been initiated, but the processing has not been completed

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or device was not found

Status: 409 - The request was not allowed in the current state of the server


removeFromConference

Remove participant from ad-hoc conference

Removing the participant {participantId} from the ad-hoc conference specified by {callId}.


/call/control/v1/removefromconference/{domain}/{userId}/{callId}/{participantId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/removefromconference/{domain}/{userId}/{callId}/{participantId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user performing the call
        String callId = callId_example; // String | The ID of the ad-hoc conference call
        String participantId = participantId_example; // String | The ID of the participant to remove
        try {
            CallStateDTO result = apiInstance.removeFromConference(body, domain, userId, callId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#removeFromConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user performing the call
        String callId = callId_example; // String | The ID of the ad-hoc conference call
        String participantId = participantId_example; // String | The ID of the participant to remove
        try {
            CallStateDTO result = apiInstance.removeFromConference(body, domain, userId, callId, participantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#removeFromConference");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
ExpectedStateTokenDTO *body = ; // 
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user performing the call
String *callId = callId_example; // The ID of the ad-hoc conference call
String *participantId = participantId_example; // The ID of the participant to remove

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

// Remove participant from ad-hoc conference
[apiInstance removeFromConferenceWith:body
    domain:domain
    userId:userId
    callId:callId
    participantId:participantId
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var body = ; // {{ExpectedStateTokenDTO}} 
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user performing the call
var callId = callId_example; // {{String}} The ID of the ad-hoc conference call
var participantId = participantId_example; // {{String}} The ID of the participant to remove

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO | 
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user performing the call
            var callId = callId_example;  // String | The ID of the ad-hoc conference call
            var participantId = participantId_example;  // String | The ID of the participant to remove

            try
            {
                // Remove participant from ad-hoc conference
                CallStateDTO result = apiInstance.removeFromConference(body, domain, userId, callId, participantId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.removeFromConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$body = ; // ExpectedStateTokenDTO | 
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user performing the call
$callId = callId_example; // String | The ID of the ad-hoc conference call
$participantId = participantId_example; // String | The ID of the participant to remove

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user performing the call
my $callId = callId_example; # String | The ID of the ad-hoc conference call
my $participantId = participantId_example; # String | The ID of the participant to remove

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
body =  # ExpectedStateTokenDTO | 
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user performing the call
callId = callId_example # String | The ID of the ad-hoc conference call
participantId = participantId_example # String | The ID of the participant to remove

try: 
    # Remove participant from ad-hoc conference
    api_response = api_instance.remove_from_conference(body, domain, userId, callId, participantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->removeFromConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user performing the call
Required
callId*
String
The ID of the ad-hoc conference call
Required
participantId*
String
The ID of the participant to remove
Required
Body parameters
Name Description
body *
Query parameters
Name Description

Responses

Status: 200 - The participant was removed

{"stateToken":48738853,"callId":"xxx111yyy","userId":"alice@organization.org","remoteParty":{"partyId":"conference@organization.org","type":"SERVICE_ID","telUri":"tel:+46277100","displayName":"Conference","displayNumber":"7100"},"participants":[{"id":"xxx22yyy","remoteParty":{"partyId":"adhoc@organization.org","type":"USER_ID","telUri":"tel:+46277565","displayName":"Adrian Hocksley","displayNumber":"7565"},"historyInfo":{"subject":"Main Switchboad number","campOn":true,"initialParty":{"partyId":"daisy@organization.org","type":"USER_ID","telUri":"tel:+46277469","displayName":"Daisy Smith","displayNumber":"7469"},"previousParty":{"partyId":"1234@organization.org","type":"FUNCTION_NUMBER_ID","telUri":"tel:+46277400","displayName":"Switchboard","displayNumber":"7400"},"previousRetargetReason":"DISTRIBUTED"}}],"conference":true,"inbound":true,"intruded":false,"status":"ACTIVE","event":"PARTICIPANT_LEFT","muted":false,"duration":5,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"HOLD"},{"action":"SAVE_REC"},{"action":"PAUSE_REC"}]}

Status: 400 - The call is not a conference call

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or participant was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


resumeCall

Resume call

Resume a call that previously was put on hold.


/call/control/v1/resume/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/resume/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to resume
        String callId = callId_example; // String | The ID of the call to resume
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.resumeCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#resumeCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to resume
        String callId = callId_example; // String | The ID of the call to resume
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.resumeCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#resumeCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to resume
String *callId = callId_example; // The ID of the call to resume
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Resume call
[apiInstance resumeCallWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to resume
var callId = callId_example; // {{String}} The ID of the call to resume
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resumeCall(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to resume
            var callId = callId_example;  // String | The ID of the call to resume
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Resume call
                CallStateDTO result = apiInstance.resumeCall(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.resumeCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to resume
$callId = callId_example; // String | The ID of the call to resume
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to resume
my $callId = callId_example; # String | The ID of the call to resume
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to resume
callId = callId_example # String | The ID of the call to resume
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Resume call
    api_response = api_instance.resume_call(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->resumeCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to resume
Required
callId*
String
The ID of the call to resume
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is resumed

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":80,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"DISCARD_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or device was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


sendDtmf

Send DTMF digits

A string of DTMF digits is sent within the call.


/call/control/v1/senddtmf/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/senddtmf/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        DtmfDigitsDTO body = ; // DtmfDigitsDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user sending the DTMF digits
        String callId = callId_example; // String | The ID of the call to send the DTMF digits in
        try {
            apiInstance.sendDtmf(body, domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#sendDtmf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        DtmfDigitsDTO body = ; // DtmfDigitsDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user sending the DTMF digits
        String callId = callId_example; // String | The ID of the call to send the DTMF digits in
        try {
            apiInstance.sendDtmf(body, domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#sendDtmf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
DtmfDigitsDTO *body = ; // 
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user sending the DTMF digits
String *callId = callId_example; // The ID of the call to send the DTMF digits in

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

// Send DTMF digits
[apiInstance sendDtmfWith:body
    domain:domain
    userId:userId
    callId:callId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var body = ; // {{DtmfDigitsDTO}} 
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user sending the DTMF digits
var callId = callId_example; // {{String}} The ID of the call to send the DTMF digits in

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var body = new DtmfDigitsDTO(); // DtmfDigitsDTO | 
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user sending the DTMF digits
            var callId = callId_example;  // String | The ID of the call to send the DTMF digits in

            try
            {
                // Send DTMF digits
                apiInstance.sendDtmf(body, domain, userId, callId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.sendDtmf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$body = ; // DtmfDigitsDTO | 
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user sending the DTMF digits
$callId = callId_example; // String | The ID of the call to send the DTMF digits in

try {
    $api_instance->sendDtmf($body, $domain, $userId, $callId);
} catch (Exception $e) {
    echo 'Exception when calling CallControlApi->sendDtmf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallControlApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $body = WWW::SwaggerClient::Object::DtmfDigitsDTO->new(); # DtmfDigitsDTO | 
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user sending the DTMF digits
my $callId = callId_example; # String | The ID of the call to send the DTMF digits in

eval { 
    $api_instance->sendDtmf(body => $body, domain => $domain, userId => $userId, callId => $callId);
};
if ($@) {
    warn "Exception when calling CallControlApi->sendDtmf: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
body =  # DtmfDigitsDTO | 
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user sending the DTMF digits
callId = callId_example # String | The ID of the call to send the DTMF digits in

try: 
    # Send DTMF digits
    api_instance.send_dtmf(body, domain, userId, callId)
except ApiException as e:
    print("Exception when calling CallControlApi->sendDtmf: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user sending the DTMF digits
Required
callId*
String
The ID of the call to send the DTMF digits in
Required
Body parameters
Name Description
body *
Query parameters
Name Description

Responses

Status: 200 - The DTMF digits were successfully sent.

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request

Status: 503 - Not possibile to send the DTMF digits


singleStepTransferCall

Transfer call

Transfer a call to a new destination. The call will be automatically unheld if it is currently on hold.


/call/control/v1/singlesteptransfer/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/singlesteptransfer/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        ActionSingleStepTransferDTO body = ; // ActionSingleStepTransferDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to transfer
        String callId = callId_example; // String | The ID of the call to transfer
        try {
            apiInstance.singleStepTransferCall(body, domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#singleStepTransferCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        ActionSingleStepTransferDTO body = ; // ActionSingleStepTransferDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to transfer
        String callId = callId_example; // String | The ID of the call to transfer
        try {
            apiInstance.singleStepTransferCall(body, domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#singleStepTransferCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
ActionSingleStepTransferDTO *body = ; // 
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to transfer
String *callId = callId_example; // The ID of the call to transfer

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

// Transfer call
[apiInstance singleStepTransferCallWith:body
    domain:domain
    userId:userId
    callId:callId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var body = ; // {{ActionSingleStepTransferDTO}} 
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to transfer
var callId = callId_example; // {{String}} The ID of the call to transfer

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var body = new ActionSingleStepTransferDTO(); // ActionSingleStepTransferDTO | 
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to transfer
            var callId = callId_example;  // String | The ID of the call to transfer

            try
            {
                // Transfer call
                apiInstance.singleStepTransferCall(body, domain, userId, callId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.singleStepTransferCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$body = ; // ActionSingleStepTransferDTO | 
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to transfer
$callId = callId_example; // String | The ID of the call to transfer

try {
    $api_instance->singleStepTransferCall($body, $domain, $userId, $callId);
} catch (Exception $e) {
    echo 'Exception when calling CallControlApi->singleStepTransferCall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallControlApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $body = WWW::SwaggerClient::Object::ActionSingleStepTransferDTO->new(); # ActionSingleStepTransferDTO | 
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to transfer
my $callId = callId_example; # String | The ID of the call to transfer

eval { 
    $api_instance->singleStepTransferCall(body => $body, domain => $domain, userId => $userId, callId => $callId);
};
if ($@) {
    warn "Exception when calling CallControlApi->singleStepTransferCall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
body =  # ActionSingleStepTransferDTO | 
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to transfer
callId = callId_example # String | The ID of the call to transfer

try: 
    # Transfer call
    api_instance.single_step_transfer_call(body, domain, userId, callId)
except ApiException as e:
    print("Exception when calling CallControlApi->singleStepTransferCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to transfer
Required
callId*
String
The ID of the call to transfer
Required
Body parameters
Name Description
body *
Query parameters
Name Description

Responses

Status: 200 - Call is transfered

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


transferCall

Transfer call to another call that belongs to the user

A user having two seperate calls can use the transfer method to connect the two parties the user is talking to. The two calls does not need to be active on the same device. Should either of the calls be on hold, it will automatically be unheld as the calls are connected.


/call/control/v1/transfer/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/transfer/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        ActionTransferDTO body = ; // ActionTransferDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to transfer
        String callId = callId_example; // String | The ID of the call to transfer
        try {
            apiInstance.transferCall(body, domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#transferCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        ActionTransferDTO body = ; // ActionTransferDTO | 
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to transfer
        String callId = callId_example; // String | The ID of the call to transfer
        try {
            apiInstance.transferCall(body, domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#transferCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
ActionTransferDTO *body = ; // 
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to transfer
String *callId = callId_example; // The ID of the call to transfer

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

// Transfer call to another call that belongs to the user
[apiInstance transferCallWith:body
    domain:domain
    userId:userId
    callId:callId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var body = ; // {{ActionTransferDTO}} 
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to transfer
var callId = callId_example; // {{String}} The ID of the call to transfer

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var body = new ActionTransferDTO(); // ActionTransferDTO | 
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to transfer
            var callId = callId_example;  // String | The ID of the call to transfer

            try
            {
                // Transfer call to another call that belongs to the user
                apiInstance.transferCall(body, domain, userId, callId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.transferCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$body = ; // ActionTransferDTO | 
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to transfer
$callId = callId_example; // String | The ID of the call to transfer

try {
    $api_instance->transferCall($body, $domain, $userId, $callId);
} catch (Exception $e) {
    echo 'Exception when calling CallControlApi->transferCall: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallControlApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $body = WWW::SwaggerClient::Object::ActionTransferDTO->new(); # ActionTransferDTO | 
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to transfer
my $callId = callId_example; # String | The ID of the call to transfer

eval { 
    $api_instance->transferCall(body => $body, domain => $domain, userId => $userId, callId => $callId);
};
if ($@) {
    warn "Exception when calling CallControlApi->transferCall: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
body =  # ActionTransferDTO | 
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to transfer
callId = callId_example # String | The ID of the call to transfer

try: 
    # Transfer call to another call that belongs to the user
    api_instance.transfer_call(body, domain, userId, callId)
except ApiException as e:
    print("Exception when calling CallControlApi->transferCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to transfer
Required
callId*
String
The ID of the call to transfer
Required
Body parameters
Name Description
body *
Query parameters
Name Description

Responses

Status: 200 - Call is transfered

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token, either in the transfered call or in the target call, in the server differed from the expected token in the request


unmuteCall

Unmute call

Unmute a call that previously was muted.


/call/control/v1/unmute/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/control/v1/unmute/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallControlApi;

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

public class CallControlApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to unmute
        String callId = callId_example; // String | The ID of the call to unmute
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.unmuteCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#unmuteCall");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallControlApi;

public class CallControlApiExample {

    public static void main(String[] args) {
        CallControlApi apiInstance = new CallControlApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user having the call to unmute
        String callId = callId_example; // String | The ID of the call to unmute
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.unmuteCall(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallControlApi#unmuteCall");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user having the call to unmute
String *callId = callId_example; // The ID of the call to unmute
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Unmute call
[apiInstance unmuteCallWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallControlApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user having the call to unmute
var callId = callId_example; // {{String}} The ID of the call to unmute
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unmuteCall(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallControlApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user having the call to unmute
            var callId = callId_example;  // String | The ID of the call to unmute
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Unmute call
                CallStateDTO result = apiInstance.unmuteCall(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallControlApi.unmuteCall: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallControlApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user having the call to unmute
$callId = callId_example; // String | The ID of the call to unmute
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallControlApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user having the call to unmute
my $callId = callId_example; # String | The ID of the call to unmute
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallControlApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user having the call to unmute
callId = callId_example # String | The ID of the call to unmute
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Unmute call
    api_response = api_instance.unmute_call(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallControlApi->unmuteCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user having the call to unmute
Required
callId*
String
The ID of the call to unmute
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call is unmuted

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","event":"UNMUTED","muted":false,"duration":80,"externalRecording":true,"externalRecordingDuration":5,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"DISCARD_REC"},{"action":"MUTE"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user, call or device was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


CallRecording

discardRecording

Discard ongoing on-demand recording

If an ongoing on-demand call recording has been explicitly saved, the discard method should be invoked to revoke the save operation. Note that the call is still recorded but will be discarded at the end of the call unless the save operation is once again performed.


/call/recording/v1/discard/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/recording/v1/discard/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingApi;

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

public class CallRecordingApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user recording the call
        String callId = callId_example; // String | The ID of the call not to save
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.discardRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#discardRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingApi;

public class CallRecordingApiExample {

    public static void main(String[] args) {
        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user recording the call
        String callId = callId_example; // String | The ID of the call not to save
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.discardRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#discardRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user recording the call
String *callId = callId_example; // The ID of the call not to save
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Discard ongoing on-demand recording
[apiInstance discardRecordingWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallRecordingApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user recording the call
var callId = callId_example; // {{String}} The ID of the call not to save
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.discardRecording(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallRecordingApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user recording the call
            var callId = callId_example;  // String | The ID of the call not to save
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Discard ongoing on-demand recording
                CallStateDTO result = apiInstance.discardRecording(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingApi.discardRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallRecordingApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user recording the call
$callId = callId_example; // String | The ID of the call not to save
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallRecordingApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user recording the call
my $callId = callId_example; # String | The ID of the call not to save
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallRecordingApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user recording the call
callId = callId_example # String | The ID of the call not to save
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Discard ongoing on-demand recording
    api_response = api_instance.discard_recording(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingApi->discardRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user recording the call
Required
callId*
String
The ID of the call not to save
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call recording will not be saved

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":200,"externalRecording":true,"externalRecordingDuration":200,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"SAVE_REC"},{"action":"PAUSE_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


pauseRecording

Pause

Pause an ongoing on-demand call recording. It depends on the configuration of the call recording service if this option is available for this user.


/call/recording/v1/pause/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/recording/v1/pause/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingApi;

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

public class CallRecordingApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user recording the call
        String callId = callId_example; // String | The ID of the call to pause recording for
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.pauseRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#pauseRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingApi;

public class CallRecordingApiExample {

    public static void main(String[] args) {
        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user recording the call
        String callId = callId_example; // String | The ID of the call to pause recording for
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.pauseRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#pauseRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user recording the call
String *callId = callId_example; // The ID of the call to pause recording for
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Pause
[apiInstance pauseRecordingWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallRecordingApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user recording the call
var callId = callId_example; // {{String}} The ID of the call to pause recording for
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pauseRecording(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallRecordingApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user recording the call
            var callId = callId_example;  // String | The ID of the call to pause recording for
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Pause
                CallStateDTO result = apiInstance.pauseRecording(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingApi.pauseRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallRecordingApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user recording the call
$callId = callId_example; // String | The ID of the call to pause recording for
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallRecordingApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user recording the call
my $callId = callId_example; # String | The ID of the call to pause recording for
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallRecordingApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user recording the call
callId = callId_example # String | The ID of the call to pause recording for
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Pause
    api_response = api_instance.pause_recording(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingApi->pauseRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user recording the call
Required
callId*
String
The ID of the call to pause recording for
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call recording is paused

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":300,"externalRecording":true,"externalRecordingDuration":300,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"DISCARD_REC"},{"action":"RESUME_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


resumeRecording

Resume

Resume a paused recording.


/call/recording/v1/resume/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/recording/v1/resume/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingApi;

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

public class CallRecordingApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user that records the call
        String callId = callId_example; // String | The ID of the call to resume recording for
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.resumeRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#resumeRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingApi;

public class CallRecordingApiExample {

    public static void main(String[] args) {
        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user that records the call
        String callId = callId_example; // String | The ID of the call to resume recording for
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.resumeRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#resumeRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user that records the call
String *callId = callId_example; // The ID of the call to resume recording for
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Resume
[apiInstance resumeRecordingWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallRecordingApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user that records the call
var callId = callId_example; // {{String}} The ID of the call to resume recording for
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.resumeRecording(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallRecordingApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user that records the call
            var callId = callId_example;  // String | The ID of the call to resume recording for
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Resume
                CallStateDTO result = apiInstance.resumeRecording(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingApi.resumeRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallRecordingApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user that records the call
$callId = callId_example; // String | The ID of the call to resume recording for
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallRecordingApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user that records the call
my $callId = callId_example; # String | The ID of the call to resume recording for
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallRecordingApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user that records the call
callId = callId_example # String | The ID of the call to resume recording for
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Resume
    api_response = api_instance.resume_recording(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingApi->resumeRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user that records the call
Required
callId*
String
The ID of the call to resume recording for
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call recording is resumed

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":300,"externalRecording":true,"externalRecordingDuration":250,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"DISCARD_REC"},{"action":"PAUSE_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


saveRecording

Save ongoing on-demand recording

If on-demand call recording is enabled for this call, which depends on the configuration of the user, then the whole call will be recorded but the recording must be explicitly saved through the invocation of this method or the recording will be discarded at the end of the call.


/call/recording/v1/save/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/recording/v1/save/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingApi;

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

public class CallRecordingApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user recording the call
        String callId = callId_example; // String | The ID of the call to save
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.saveRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#saveRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingApi;

public class CallRecordingApiExample {

    public static void main(String[] args) {
        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user recording the call
        String callId = callId_example; // String | The ID of the call to save
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.saveRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#saveRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user recording the call
String *callId = callId_example; // The ID of the call to save
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Save ongoing on-demand recording
[apiInstance saveRecordingWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallRecordingApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user recording the call
var callId = callId_example; // {{String}} The ID of the call to save
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveRecording(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallRecordingApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user recording the call
            var callId = callId_example;  // String | The ID of the call to save
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Save ongoing on-demand recording
                CallStateDTO result = apiInstance.saveRecording(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingApi.saveRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallRecordingApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user recording the call
$callId = callId_example; // String | The ID of the call to save
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallRecordingApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user recording the call
my $callId = callId_example; # String | The ID of the call to save
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallRecordingApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user recording the call
callId = callId_example # String | The ID of the call to save
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Save ongoing on-demand recording
    api_response = api_instance.save_recording(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingApi->saveRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user recording the call
Required
callId*
String
The ID of the call to save
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call recording will be saved

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":80,"externalRecording":true,"externalRecordingDuration":80,"externalRecordingPaused":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"DISCARD_REC"},{"action":"PAUSE_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


startRecording

Start

If it's possible to record this call, which depends on the configuration of the user, then the start method will initate the recording. Any part of the call before the start method is performed will not be part of the recording.


/call/recording/v1/start/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/recording/v1/start/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingApi;

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

public class CallRecordingApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user that should record the call
        String callId = callId_example; // String | The ID of the call to record
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.startRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#startRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingApi;

public class CallRecordingApiExample {

    public static void main(String[] args) {
        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user that should record the call
        String callId = callId_example; // String | The ID of the call to record
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.startRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#startRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user that should record the call
String *callId = callId_example; // The ID of the call to record
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Start
[apiInstance startRecordingWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallRecordingApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user that should record the call
var callId = callId_example; // {{String}} The ID of the call to record
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startRecording(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallRecordingApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user that should record the call
            var callId = callId_example;  // String | The ID of the call to record
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Start
                CallStateDTO result = apiInstance.startRecording(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingApi.startRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallRecordingApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user that should record the call
$callId = callId_example; // String | The ID of the call to record
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallRecordingApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user that should record the call
my $callId = callId_example; # String | The ID of the call to record
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallRecordingApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user that should record the call
callId = callId_example # String | The ID of the call to record
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Start
    api_response = api_instance.start_recording(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingApi->startRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user that should record the call
Required
callId*
String
The ID of the call to record
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call recording started

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":100,"recording":true,"recordingDuration":5,"deviceIds":["+1555555"],"actions":[{"action":"TRANSFER"},{"action":"HOLD"},{"action":"STOP_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


stopRecording

Stop

If the start method has previously been performed to initiate call recording, then the stop method is available to end the call recording.


/call/recording/v1/stop/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/recording/v1/stop/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingApi;

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

public class CallRecordingApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user that should record the call
        String callId = callId_example; // String | The ID of the call to stop recording
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.stopRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#stopRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingApi;

public class CallRecordingApiExample {

    public static void main(String[] args) {
        CallRecordingApi apiInstance = new CallRecordingApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user that should record the call
        String callId = callId_example; // String | The ID of the call to stop recording
        ExpectedStateTokenDTO body = ; // ExpectedStateTokenDTO | 
        try {
            CallStateDTO result = apiInstance.stopRecording(domain, userId, callId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingApi#stopRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user that should record the call
String *callId = callId_example; // The ID of the call to stop recording
ExpectedStateTokenDTO *body = ; //  (optional)

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

// Stop
[apiInstance stopRecordingWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallRecordingApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user that should record the call
var callId = callId_example; // {{String}} The ID of the call to stop recording
var opts = { 
  'body':  // {{ExpectedStateTokenDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stopRecording(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallRecordingApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user that should record the call
            var callId = callId_example;  // String | The ID of the call to stop recording
            var body = new ExpectedStateTokenDTO(); // ExpectedStateTokenDTO |  (optional) 

            try
            {
                // Stop
                CallStateDTO result = apiInstance.stopRecording(domain, userId, callId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingApi.stopRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallRecordingApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user that should record the call
$callId = callId_example; // String | The ID of the call to stop recording
$body = ; // ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallRecordingApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user that should record the call
my $callId = callId_example; # String | The ID of the call to stop recording
my $body = WWW::SwaggerClient::Object::ExpectedStateTokenDTO->new(); # ExpectedStateTokenDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallRecordingApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user that should record the call
callId = callId_example # String | The ID of the call to stop recording
body =  # ExpectedStateTokenDTO |  (optional)

try: 
    # Stop
    api_response = api_instance.stop_recording(domain, userId, callId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingApi->stopRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user that should record the call
Required
callId*
String
The ID of the call to stop recording
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - Call recording stopped

{"stateToken":487345453,"callId":"aaa111bbb","userId":"bob@organization.org","remoteParty":{"partyId":"alice@organization.org","type":"USER_ID","telUri":"tel:+46277463","displayName":"Alice Alison","displayNumber":"7463"},"conference":false,"inbound":true,"intruded":false,"status":"ACTIVE","muted":false,"duration":200,"recording":false,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"HOLD"},{"action":"PARK"},{"action":"START_REC"}]}

Status: 403 - Not Authorized

Status: 404 - Domain, user or call was not found

Status: 409 - The request was not allowed in the current state of the server

Status: 410 - Request failed due to the state token in the server differed from the expected token in the request


CallRecordingControl

getCallRecordingList

List recordings

Returns a list of calls for the user which are being recorded.<br><br><i>NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.</i>


/call/recording/{domain}/{user}/list

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//call/recording/{domain}/{user}/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingControlApi;

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

public class CallRecordingControlApiExample {

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


        CallRecordingControlApi apiInstance = new CallRecordingControlApi();
        String domain = domain_example; // String | The organization domain.
        String user = user_example; // String | The user ID without domain suffix.
        try {
            CallRecordingListDTO result = apiInstance.getCallRecordingList(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingControlApi#getCallRecordingList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingControlApi;

public class CallRecordingControlApiExample {

    public static void main(String[] args) {
        CallRecordingControlApi apiInstance = new CallRecordingControlApi();
        String domain = domain_example; // String | The organization domain.
        String user = user_example; // String | The user ID without domain suffix.
        try {
            CallRecordingListDTO result = apiInstance.getCallRecordingList(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingControlApi#getCallRecordingList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain.
String *user = user_example; // The user ID without domain suffix.

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

// List recordings
[apiInstance getCallRecordingListWith:domain
    user:user
              completionHandler: ^(CallRecordingListDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CallRecordingControlApi()
var domain = domain_example; // {{String}} The organization domain.
var user = user_example; // {{String}} The user ID without domain suffix.

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

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


            var apiInstance = new CallRecordingControlApi();
            var domain = domain_example;  // String | The organization domain.
            var user = user_example;  // String | The user ID without domain suffix.

            try
            {
                // List recordings
                CallRecordingListDTO result = apiInstance.getCallRecordingList(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingControlApi.getCallRecordingList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCallRecordingControlApi();
$domain = domain_example; // String | The organization domain.
$user = user_example; // String | The user ID without domain suffix.

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


my $api_instance = WWW::SwaggerClient::CallRecordingControlApi->new();
my $domain = domain_example; # String | The organization domain.
my $user = user_example; # String | The user ID without domain suffix.

eval { 
    my $result = $api_instance->getCallRecordingList(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CallRecordingControlApi->getCallRecordingList: $@\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.CallRecordingControlApi()
domain = domain_example # String | The organization domain.
user = user_example # String | The user ID without domain suffix.

try: 
    # List recordings
    api_response = api_instance.get_call_recording_list(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallRecordingControlApi->getCallRecordingList: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain.
Required
user*
String
The user ID without domain suffix.
Required

Responses

Status: 200 - OK

[{"id":"173:8635322","deviceType":"MOBILE_VOIP","mobileNumber":"+4676123123","isLocalDevice":true,"displayName":"bob","number":"+466456456","calledNumber":"456456","contactId":"bob@bob.com","isSaved":true,"isPaused":true,"allowedActions":["PAUSE","SAVE"],"duration":15,"recordDuration":15,"callId":"Sei8BS7D02h0Sik3q1RoGw"},{"id":"177:8635322","deviceType":"EXTERNAL_PBX","mobileNumber":"+4676321321","isLocalDevice":true,"displayName":"john","number":"+468345345","calledNumber":"345345","contactId":"john@john.com","isSaved":true,"isPaused":true,"allowedActions":["PAUSE","SAVE"],"duration":15,"recordDuration":15,"callId":"Sei0BS8D02h0Sik3q1RoGw"}]

Status: 403 - Not Authorized


updateRecording

Update ongoing recording

The user is allowed to perform the action for the recording in its current state if the action, i.e. save/discard/pause/resume, is listed in the allowed actions of the recording state. A pause/resume action may conflict with an ongoing media session re-negotiation, in which case the action is rejected.<br><br><i>NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.</i>


/call/recording/{domain}/{user}/update/{id}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//call/recording/{domain}/{user}/update/{id}?action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallRecordingControlApi;

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

public class CallRecordingControlApiExample {

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


        CallRecordingControlApi apiInstance = new CallRecordingControlApi();
        String domain = domain_example; // String | The organization domain.
        String user = user_example; // String | The user ID without domain suffix.
        String id = id_example; // String | The ID of the call recording to update.
        String action = action_example; // String | The action to perform.
        try {
            apiInstance.updateRecording(domain, user, id, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingControlApi#updateRecording");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallRecordingControlApi;

public class CallRecordingControlApiExample {

    public static void main(String[] args) {
        CallRecordingControlApi apiInstance = new CallRecordingControlApi();
        String domain = domain_example; // String | The organization domain.
        String user = user_example; // String | The user ID without domain suffix.
        String id = id_example; // String | The ID of the call recording to update.
        String action = action_example; // String | The action to perform.
        try {
            apiInstance.updateRecording(domain, user, id, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallRecordingControlApi#updateRecording");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain.
String *user = user_example; // The user ID without domain suffix.
String *id = id_example; // The ID of the call recording to update.
String *action = action_example; // The action to perform.

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

// Update ongoing recording
[apiInstance updateRecordingWith:domain
    user:user
    id:id
    action:action
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CallRecordingControlApi()
var domain = domain_example; // {{String}} The organization domain.
var user = user_example; // {{String}} The user ID without domain suffix.
var id = id_example; // {{String}} The ID of the call recording to update.
var action = action_example; // {{String}} The action to perform.

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

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


            var apiInstance = new CallRecordingControlApi();
            var domain = domain_example;  // String | The organization domain.
            var user = user_example;  // String | The user ID without domain suffix.
            var id = id_example;  // String | The ID of the call recording to update.
            var action = action_example;  // String | The action to perform.

            try
            {
                // Update ongoing recording
                apiInstance.updateRecording(domain, user, id, action);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallRecordingControlApi.updateRecording: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCallRecordingControlApi();
$domain = domain_example; // String | The organization domain.
$user = user_example; // String | The user ID without domain suffix.
$id = id_example; // String | The ID of the call recording to update.
$action = action_example; // String | The action to perform.

try {
    $api_instance->updateRecording($domain, $user, $id, $action);
} catch (Exception $e) {
    echo 'Exception when calling CallRecordingControlApi->updateRecording: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallRecordingControlApi;


my $api_instance = WWW::SwaggerClient::CallRecordingControlApi->new();
my $domain = domain_example; # String | The organization domain.
my $user = user_example; # String | The user ID without domain suffix.
my $id = id_example; # String | The ID of the call recording to update.
my $action = action_example; # String | The action to perform.

eval { 
    $api_instance->updateRecording(domain => $domain, user => $user, id => $id, action => $action);
};
if ($@) {
    warn "Exception when calling CallRecordingControlApi->updateRecording: $@\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.CallRecordingControlApi()
domain = domain_example # String | The organization domain.
user = user_example # String | The user ID without domain suffix.
id = id_example # String | The ID of the call recording to update.
action = action_example # String | The action to perform.

try: 
    # Update ongoing recording
    api_instance.update_recording(domain, user, id, action)
except ApiException as e:
    print("Exception when calling CallRecordingControlApi->updateRecording: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain.
Required
user*
String
The user ID without domain suffix.
Required
id*
String
The ID of the call recording to update.
Required
Query parameters
Name Description
action*
String
The action to perform.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found

Status: 409 - Conflict


CallState

deleteCallWebHook

Unregister changes for call

Unregister an existing webhook registered for specific user call.


/call/state/v1/monitor/call/{domain}/{userId}/{callId}/{targetId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//call/state/v1/monitor/call/{domain}/{userId}/{callId}/{targetId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String callId = callId_example; // String | The ID of the call
        String targetId = targetId_example; // String | The unique id of the webhook that should be unregistered
        try {
            apiInstance.deleteCallWebHook(domain, userId, callId, targetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#deleteCallWebHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String callId = callId_example; // String | The ID of the call
        String targetId = targetId_example; // String | The unique id of the webhook that should be unregistered
        try {
            apiInstance.deleteCallWebHook(domain, userId, callId, targetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#deleteCallWebHook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
String *callId = callId_example; // The ID of the call
String *targetId = targetId_example; // The unique id of the webhook that should be unregistered

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

// Unregister changes for call
[apiInstance deleteCallWebHookWith:domain
    userId:userId
    callId:callId
    targetId:targetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var callId = callId_example; // {{String}} The ID of the call
var targetId = targetId_example; // {{String}} The unique id of the webhook that should be unregistered

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCallWebHook(domain, userId, callId, targetId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var callId = callId_example;  // String | The ID of the call
            var targetId = targetId_example;  // String | The unique id of the webhook that should be unregistered

            try
            {
                // Unregister changes for call
                apiInstance.deleteCallWebHook(domain, userId, callId, targetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.deleteCallWebHook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$callId = callId_example; // String | The ID of the call
$targetId = targetId_example; // String | The unique id of the webhook that should be unregistered

try {
    $api_instance->deleteCallWebHook($domain, $userId, $callId, $targetId);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->deleteCallWebHook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $callId = callId_example; # String | The ID of the call
my $targetId = targetId_example; # String | The unique id of the webhook that should be unregistered

eval { 
    $api_instance->deleteCallWebHook(domain => $domain, userId => $userId, callId => $callId, targetId => $targetId);
};
if ($@) {
    warn "Exception when calling CallStateApi->deleteCallWebHook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
callId = callId_example # String | The ID of the call
targetId = targetId_example # String | The unique id of the webhook that should be unregistered

try: 
    # Unregister changes for call
    api_instance.delete_call_web_hook(domain, userId, callId, targetId)
except ApiException as e:
    print("Exception when calling CallStateApi->deleteCallWebHook: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
callId*
String
The ID of the call
Required
targetId*
String
The unique id of the webhook that should be unregistered
Required
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteUserWebHook

Unregister changes for user

Unregister an existing webhook registered for the user.


/call/state/v1/monitor/{domain}/{userId}/{targetId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//call/state/v1/monitor/{domain}/{userId}/{targetId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String targetId = targetId_example; // String | The unique ID of the webhook that should be unregistered
        try {
            apiInstance.deleteUserWebHook(domain, userId, targetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#deleteUserWebHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String targetId = targetId_example; // String | The unique ID of the webhook that should be unregistered
        try {
            apiInstance.deleteUserWebHook(domain, userId, targetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#deleteUserWebHook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
String *targetId = targetId_example; // The unique ID of the webhook that should be unregistered

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

// Unregister changes for user
[apiInstance deleteUserWebHookWith:domain
    userId:userId
    targetId:targetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var targetId = targetId_example; // {{String}} The unique ID of the webhook that should be unregistered

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUserWebHook(domain, userId, targetId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var targetId = targetId_example;  // String | The unique ID of the webhook that should be unregistered

            try
            {
                // Unregister changes for user
                apiInstance.deleteUserWebHook(domain, userId, targetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.deleteUserWebHook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$targetId = targetId_example; // String | The unique ID of the webhook that should be unregistered

try {
    $api_instance->deleteUserWebHook($domain, $userId, $targetId);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->deleteUserWebHook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $targetId = targetId_example; # String | The unique ID of the webhook that should be unregistered

eval { 
    $api_instance->deleteUserWebHook(domain => $domain, userId => $userId, targetId => $targetId);
};
if ($@) {
    warn "Exception when calling CallStateApi->deleteUserWebHook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
targetId = targetId_example # String | The unique ID of the webhook that should be unregistered

try: 
    # Unregister changes for user
    api_instance.delete_user_web_hook(domain, userId, targetId)
except ApiException as e:
    print("Exception when calling CallStateApi->deleteUserWebHook: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
targetId*
String
The unique ID of the webhook that should be unregistered
Required
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getCallState

Read call state

Fetch a snapshot of the current state of a call.


/call/state/v1/snapshot/call/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"/api//call/state/v1/snapshot/call/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The username of the user accessing the API
        String callId = callId_example; // String | The ID of the call
        try {
            CallStateDTO result = apiInstance.getCallState(domain, userId, callId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#getCallState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The username of the user accessing the API
        String callId = callId_example; // String | The ID of the call
        try {
            CallStateDTO result = apiInstance.getCallState(domain, userId, callId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#getCallState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The username of the user accessing the API
String *callId = callId_example; // The ID of the call

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

// Read call state
[apiInstance getCallStateWith:domain
    userId:userId
    callId:callId
              completionHandler: ^(CallStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The username of the user accessing the API
var callId = callId_example; // {{String}} The ID of the call

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The username of the user accessing the API
            var callId = callId_example;  // String | The ID of the call

            try
            {
                // Read call state
                CallStateDTO result = apiInstance.getCallState(domain, userId, callId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.getCallState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The username of the user accessing the API
$callId = callId_example; // String | The ID of the call

try {
    $result = $api_instance->getCallState($domain, $userId, $callId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->getCallState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The username of the user accessing the API
my $callId = callId_example; # String | The ID of the call

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The username of the user accessing the API
callId = callId_example # String | The ID of the call

try: 
    # Read call state
    api_response = api_instance.get_call_state(domain, userId, callId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallStateApi->getCallState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The username of the user accessing the API
Required
callId*
String
The ID of the call
Required
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getUserState

Read user state

Fetch a snapshot of the current state of a user.


/call/state/v1/snapshot/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"/api//call/state/v1/snapshot/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The username of the user accessing the API
        try {
            UserStateDTO result = apiInstance.getUserState(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#getUserState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The username of the user accessing the API
        try {
            UserStateDTO result = apiInstance.getUserState(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#getUserState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The username of the user accessing the API

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

// Read user state
[apiInstance getUserStateWith:domain
    userId:userId
              completionHandler: ^(UserStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The username of the user accessing the API

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The username of the user accessing the API

            try
            {
                // Read user state
                UserStateDTO result = apiInstance.getUserState(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.getUserState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The username of the user accessing the API

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The username of the user accessing the API

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The username of the user accessing the API

try: 
    # Read user state
    api_response = api_instance.get_user_state(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallStateApi->getUserState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The username of the user accessing the API
Required
Query parameters
Name Description

Responses

Status: 200 - OK

{"fullState":true,"calls":[{"stateToken":487345453,"callId":"aaa111bbb","userId":"alice@organization.org","remoteParty":{"partyId":"bob@organization.org","type":"USER_ID","telUri":"tel:+46277464","displayName":"Bob Bobson","displayNumber":"7464"},"conference":false,"inbound":false,"intruded":false,"status":"HELD","muted":false,"duration":50,"deviceIds":["+1555555"],"actions":[{"action":"MOVE"},{"action":"TRANSFER"},{"action":"RESUME"},{"action":"PARK"}]}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


registerCallWebHook

Register for state changes for call

Register a webhook to be notified if the state of the call has been updated in the server. The new stateToken of the state will be posted to the registered URL allowing the CTI client to compare it to the token of any state it currently knows about and decide if it needs to fetch the latest state.


/call/state/v1/monitor/call/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Content-Type: application/json"\
"/api//call/state/v1/monitor/call/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String callId = callId_example; // String | The ID of the call
        WebhookDTO body = ; // WebhookDTO | 
        try {
            apiInstance.registerCallWebHook(domain, userId, callId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#registerCallWebHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String callId = callId_example; // String | The ID of the call
        WebhookDTO body = ; // WebhookDTO | 
        try {
            apiInstance.registerCallWebHook(domain, userId, callId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#registerCallWebHook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
String *callId = callId_example; // The ID of the call
WebhookDTO *body = ; //  (optional)

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

// Register for state changes for call
[apiInstance registerCallWebHookWith:domain
    userId:userId
    callId:callId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var callId = callId_example; // {{String}} The ID of the call
var opts = { 
  'body':  // {{WebhookDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.registerCallWebHook(domainuserIdcallId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var callId = callId_example;  // String | The ID of the call
            var body = new WebhookDTO(); // WebhookDTO |  (optional) 

            try
            {
                // Register for state changes for call
                apiInstance.registerCallWebHook(domain, userId, callId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.registerCallWebHook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$callId = callId_example; // String | The ID of the call
$body = ; // WebhookDTO | 

try {
    $api_instance->registerCallWebHook($domain, $userId, $callId, $body);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->registerCallWebHook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $callId = callId_example; # String | The ID of the call
my $body = WWW::SwaggerClient::Object::WebhookDTO->new(); # WebhookDTO | 

eval { 
    $api_instance->registerCallWebHook(domain => $domain, userId => $userId, callId => $callId, body => $body);
};
if ($@) {
    warn "Exception when calling CallStateApi->registerCallWebHook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
callId = callId_example # String | The ID of the call
body =  # WebhookDTO |  (optional)

try: 
    # Register for state changes for call
    api_instance.register_call_web_hook(domain, userId, callId, body=body)
except ApiException as e:
    print("Exception when calling CallStateApi->registerCallWebHook: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
callId*
String
The ID of the call
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


registerUserWebHook

Register for state changes for user

Register a webhook where notifications about new and deleted calls for the user will be pushed. The user must be CTI enabled, and the registration is valid for all the users devices.


/call/state/v1/monitor/{domain}/{userId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//call/state/v1/monitor/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        WebhookDTO body = ; // WebhookDTO | 
        try {
            ExpiresDTO result = apiInstance.registerUserWebHook(domain, userId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#registerUserWebHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        WebhookDTO body = ; // WebhookDTO | 
        try {
            ExpiresDTO result = apiInstance.registerUserWebHook(domain, userId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#registerUserWebHook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
WebhookDTO *body = ; //  (optional)

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

// Register for state changes for user
[apiInstance registerUserWebHookWith:domain
    userId:userId
    body:body
              completionHandler: ^(ExpiresDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var opts = { 
  'body':  // {{WebhookDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerUserWebHook(domainuserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var body = new WebhookDTO(); // WebhookDTO |  (optional) 

            try
            {
                // Register for state changes for user
                ExpiresDTO result = apiInstance.registerUserWebHook(domain, userId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.registerUserWebHook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$body = ; // WebhookDTO | 

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $body = WWW::SwaggerClient::Object::WebhookDTO->new(); # WebhookDTO | 

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
body =  # WebhookDTO |  (optional)

try: 
    # Register for state changes for user
    api_response = api_instance.register_user_web_hook(domain, userId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallStateApi->registerUserWebHook: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


subscribeCallState

Subscribe for state changes for user call

The method will produce a SSE stream of call state objects.


/call/state/v1/sse/call/{domain}/{userId}/{callId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: text/event-stream"\
"/api//call/state/v1/sse/call/{domain}/{userId}/{callId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String callId = callId_example; // String | The ID of the call
        try {
            apiInstance.subscribeCallState(domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#subscribeCallState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String callId = callId_example; // String | The ID of the call
        try {
            apiInstance.subscribeCallState(domain, userId, callId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#subscribeCallState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
String *callId = callId_example; // The ID of the call

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

// Subscribe for state changes for user call
[apiInstance subscribeCallStateWith:domain
    userId:userId
    callId:callId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var callId = callId_example; // {{String}} The ID of the call

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeCallState(domain, userId, callId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var callId = callId_example;  // String | The ID of the call

            try
            {
                // Subscribe for state changes for user call
                apiInstance.subscribeCallState(domain, userId, callId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.subscribeCallState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$callId = callId_example; // String | The ID of the call

try {
    $api_instance->subscribeCallState($domain, $userId, $callId);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->subscribeCallState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $callId = callId_example; # String | The ID of the call

eval { 
    $api_instance->subscribeCallState(domain => $domain, userId => $userId, callId => $callId);
};
if ($@) {
    warn "Exception when calling CallStateApi->subscribeCallState: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
callId = callId_example # String | The ID of the call

try: 
    # Subscribe for state changes for user call
    api_instance.subscribe_call_state(domain, userId, callId)
except ApiException as e:
    print("Exception when calling CallStateApi->subscribeCallState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
callId*
String
The ID of the call
Required
Query parameters
Name Description

Responses

Status: 200 - A document stream in 'application/json' format

Status: 403 - Not Authorized

Status: 404 - Not Found


subscribeRemoteEvents

Subscribe for remote SIP dialog events

The method will produce a SSE stream of remote SIP dialog events in the format described in RFC4235.


/call/state/v1/sse/remote/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: text/event-stream"\
"/api//call/state/v1/sse/remote/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        try {
            apiInstance.subscribeRemoteEvents(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#subscribeRemoteEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        try {
            apiInstance.subscribeRemoteEvents(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#subscribeRemoteEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user

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

// Subscribe for remote SIP dialog events
[apiInstance subscribeRemoteEventsWith:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeRemoteEvents(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user

            try
            {
                // Subscribe for remote SIP dialog events
                apiInstance.subscribeRemoteEvents(domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.subscribeRemoteEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user

try {
    $api_instance->subscribeRemoteEvents($domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->subscribeRemoteEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user

eval { 
    $api_instance->subscribeRemoteEvents(domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling CallStateApi->subscribeRemoteEvents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user

try: 
    # Subscribe for remote SIP dialog events
    api_instance.subscribe_remote_events(domain, userId)
except ApiException as e:
    print("Exception when calling CallStateApi->subscribeRemoteEvents: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
Query parameters
Name Description

Responses

Status: 200 - A document stream in 'application/dialog-info+xml' format

Status: 403 - Not Authorized

Status: 404 - Not Found


subscribeUserLevel

Subscribe for state changes for user

The method will produce a SSE stream of user state objects.


/call/state/v1/sse/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: text/event-stream"\
"/api//call/state/v1/sse/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallStateApi;

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

public class CallStateApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        try {
            apiInstance.subscribeUserLevel(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#subscribeUserLevel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallStateApi;

public class CallStateApiExample {

    public static void main(String[] args) {
        CallStateApi apiInstance = new CallStateApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        try {
            apiInstance.subscribeUserLevel(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallStateApi#subscribeUserLevel");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user

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

// Subscribe for state changes for user
[apiInstance subscribeUserLevelWith:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallStateApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeUserLevel(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallStateApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user

            try
            {
                // Subscribe for state changes for user
                apiInstance.subscribeUserLevel(domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallStateApi.subscribeUserLevel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallStateApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user

try {
    $api_instance->subscribeUserLevel($domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling CallStateApi->subscribeUserLevel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallStateApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallStateApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user

eval { 
    $api_instance->subscribeUserLevel(domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling CallStateApi->subscribeUserLevel: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallStateApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user

try: 
    # Subscribe for state changes for user
    api_instance.subscribe_user_level(domain, userId)
except ApiException as e:
    print("Exception when calling CallStateApi->subscribeUserLevel: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
Query parameters
Name Description

Responses

Status: 200 - A document stream in 'application/json' format

Status: 403 - Not Authorized

Status: 404 - Not Found


Calls

cancelCallTransfer

Cancel call transfer

Cancel an ongoing attended call transfer.


/calls/{domain}/{user}/transfer/{transferId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//calls/{domain}/{user}/transfer/{transferId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallsApi;

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

public class CallsApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the transfer.
        String transferId = transferId_example; // String | The call transfer ID of the transfer that will be cancelled.
        try {
            apiInstance.cancelCallTransfer(domain, user, transferId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallsApi#cancelCallTransfer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallsApi;

public class CallsApiExample {

    public static void main(String[] args) {
        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the transfer.
        String transferId = transferId_example; // String | The call transfer ID of the transfer that will be cancelled.
        try {
            apiInstance.cancelCallTransfer(domain, user, transferId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallsApi#cancelCallTransfer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to.
String *user = user_example; // The user performing the transfer.
String *transferId = transferId_example; // The call transfer ID of the transfer that will be cancelled.

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

// Cancel call transfer
[apiInstance cancelCallTransferWith:domain
    user:user
    transferId:transferId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallsApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to.
var user = user_example; // {{String}} The user performing the transfer.
var transferId = transferId_example; // {{String}} The call transfer ID of the transfer that will be cancelled.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.cancelCallTransfer(domain, user, transferId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallsApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to.
            var user = user_example;  // String | The user performing the transfer.
            var transferId = transferId_example;  // String | The call transfer ID of the transfer that will be cancelled.

            try
            {
                // Cancel call transfer
                apiInstance.cancelCallTransfer(domain, user, transferId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallsApi.cancelCallTransfer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallsApi();
$domain = domain_example; // String | The domain of the organization the user belongs to.
$user = user_example; // String | The user performing the transfer.
$transferId = transferId_example; // String | The call transfer ID of the transfer that will be cancelled.

try {
    $api_instance->cancelCallTransfer($domain, $user, $transferId);
} catch (Exception $e) {
    echo 'Exception when calling CallsApi->cancelCallTransfer: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallsApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallsApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to.
my $user = user_example; # String | The user performing the transfer.
my $transferId = transferId_example; # String | The call transfer ID of the transfer that will be cancelled.

eval { 
    $api_instance->cancelCallTransfer(domain => $domain, user => $user, transferId => $transferId);
};
if ($@) {
    warn "Exception when calling CallsApi->cancelCallTransfer: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallsApi()
domain = domain_example # String | The domain of the organization the user belongs to.
user = user_example # String | The user performing the transfer.
transferId = transferId_example # String | The call transfer ID of the transfer that will be cancelled.

try: 
    # Cancel call transfer
    api_instance.cancel_call_transfer(domain, user, transferId)
except ApiException as e:
    print("Exception when calling CallsApi->cancelCallTransfer: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to.
Required
user*
String
The user performing the transfer.
Required
transferId*
String
The call transfer ID of the transfer that will be cancelled.
Required
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 400 - Input parameters missing or invalid

Status: 403 - Not Authorized

Status: 404 - No call transfer in progress or the transfer is of type BLIND_TRANSFER


getCallTransferSessions

Get call transfer status

Get the status of an ongoing call transfer.


/calls/{domain}/{user}/transfer

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json,application/xml"\
"/api//calls/{domain}/{user}/transfer?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallsApi;

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

public class CallsApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the transfer.
        try {
            CallTransferDTO result = apiInstance.getCallTransferSessions(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallsApi#getCallTransferSessions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CallsApi;

public class CallsApiExample {

    public static void main(String[] args) {
        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the transfer.
        try {
            CallTransferDTO result = apiInstance.getCallTransferSessions(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CallsApi#getCallTransferSessions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to.
String *user = user_example; // The user performing the transfer.

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

// Get call transfer status
[apiInstance getCallTransferSessionsWith:domain
    user:user
              completionHandler: ^(CallTransferDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallsApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to.
var user = user_example; // {{String}} The user performing the transfer.

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

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallsApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to.
            var user = user_example;  // String | The user performing the transfer.

            try
            {
                // Get call transfer status
                CallTransferDTO result = apiInstance.getCallTransferSessions(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CallsApi.getCallTransferSessions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallsApi();
$domain = domain_example; // String | The domain of the organization the user belongs to.
$user = user_example; // String | The user performing the transfer.

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

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallsApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to.
my $user = user_example; # String | The user performing the transfer.

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

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallsApi()
domain = domain_example # String | The domain of the organization the user belongs to.
user = user_example # String | The user performing the transfer.

try: 
    # Get call transfer status
    api_response = api_instance.get_call_transfer_sessions(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CallsApi->getCallTransferSessions: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to.
Required
user*
String
The user performing the transfer.
Required
Query parameters
Name Description

Responses

Status: 200 - OK

{"transferId":{"transferStartTime":1649594445186,"type":"BLIND_TRANSFER","id":"5","destination":"+9633996603"}}
{"transferId":{"transferStartTime":1649594445186,"type":"ATTENDED_TRANSFER","id":"5","destination":"+9633996603"}}

Status: 403 - Not Authorized

Status: 404 - No call transfer in progress


setupCall

Set up call

Set up a call-back call to the contact with the specified ID. Examples: If user Alice want to make a call to Bob, and use her mobile as the call device and call with the role Private the following syntax could be used.<br><pre>POST http://bcs.mydomain.com/api/calls/current/foo.com/alice/mobile/bob@foo.com?role=PRIVATE</pre><br>Org-admin James wants to setup a call for Alice to call Bob, use Alice's mobile as the call device and call with the role Private. The same syntax as before can be used, but instead of using Alice's token. James should use his own token with access granted for Call setup and Call control.<br><pre>POST http://bcs.mydomain.com/api/calls/current/foo.com/alice/mobile/bob@foo.com?role=PRIVATE</pre><br>If Bob happens to be an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded):<br><pre>POST http://bcs.mydomain.com/api/calls/current/foo.com/alice/mobile/%2B468123456789?role=PRIVATE</pre>


/calls/current/{domain}/{user}/{aptype}/{cid}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json,application/xml"\
"/api//calls/current/{domain}/{user}/{aptype}/{cid}?role=&bypass=&intrude=&callback-via-gsm="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallsApi;

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

public class CallsApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the call setup.
        String aptype = aptype_example; // String | The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
String cid = cid_example; // String | can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
String role = role_example; // String | what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. String bypass = bypass_example; // String | Bypass call routing ('true' or 'false') String intrude = intrude_example; // String | Intrude the current call ('true' or 'false') Boolean callbackViaGsm = true; // Boolean | True if the callback should prefer GSM call. try { apiInstance.setupCall(domain, user, aptype, cid, role, bypass, intrude, callbackViaGsm); } catch (ApiException e) { System.err.println("Exception when calling CallsApi#setupCall"); e.printStackTrace(); } } }
import io.swagger.client.api.CallsApi;

public class CallsApiExample {

    public static void main(String[] args) {
        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the call setup.
        String aptype = aptype_example; // String | The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
String cid = cid_example; // String | can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
String role = role_example; // String | what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. String bypass = bypass_example; // String | Bypass call routing ('true' or 'false') String intrude = intrude_example; // String | Intrude the current call ('true' or 'false') Boolean callbackViaGsm = true; // Boolean | True if the callback should prefer GSM call. try { apiInstance.setupCall(domain, user, aptype, cid, role, bypass, intrude, callbackViaGsm); } catch (ApiException e) { System.err.println("Exception when calling CallsApi#setupCall"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to.
String *user = user_example; // The user performing the call setup.
String *aptype = aptype_example; // The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
String *cid = cid_example; // can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
String *role = role_example; // what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. (optional) String *bypass = bypass_example; // Bypass call routing ('true' or 'false') (optional) String *intrude = intrude_example; // Intrude the current call ('true' or 'false') (optional) Boolean *callbackViaGsm = true; // True if the callback should prefer GSM call. (optional) CallsApi *apiInstance = [[CallsApi alloc] init]; // Set up call [apiInstance setupCallWith:domain user:user aptype:aptype cid:cid role:role bypass:bypass intrude:intrude callbackViaGsm:callbackViaGsm completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallsApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to.
var user = user_example; // {{String}} The user performing the call setup.
var aptype = aptype_example; // {{String}} The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
var cid = cid_example; // {{String}} can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
var opts = { 'role': role_example, // {{String}} what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. 'bypass': bypass_example, // {{String}} Bypass call routing ('true' or 'false') 'intrude': intrude_example, // {{String}} Intrude the current call ('true' or 'false') 'callbackViaGsm': true // {{Boolean}} True if the callback should prefer GSM call. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.setupCall(domain, user, aptype, cid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallsApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to.
            var user = user_example;  // String | The user performing the call setup.
            var aptype = aptype_example;  // String | The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
var cid = cid_example; // String | can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
var role = role_example; // String | what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. (optional) var bypass = bypass_example; // String | Bypass call routing ('true' or 'false') (optional) var intrude = intrude_example; // String | Intrude the current call ('true' or 'false') (optional) var callbackViaGsm = true; // Boolean | True if the callback should prefer GSM call. (optional) try { // Set up call apiInstance.setupCall(domain, user, aptype, cid, role, bypass, intrude, callbackViaGsm); } catch (Exception e) { Debug.Print("Exception when calling CallsApi.setupCall: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallsApi();
$domain = domain_example; // String | The domain of the organization the user belongs to.
$user = user_example; // String | The user performing the call setup.
$aptype = aptype_example; // String | The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
$cid = cid_example; // String | can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
$role = role_example; // String | what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. $bypass = bypass_example; // String | Bypass call routing ('true' or 'false') $intrude = intrude_example; // String | Intrude the current call ('true' or 'false') $callbackViaGsm = true; // Boolean | True if the callback should prefer GSM call. try { $api_instance->setupCall($domain, $user, $aptype, $cid, $role, $bypass, $intrude, $callbackViaGsm); } catch (Exception $e) { echo 'Exception when calling CallsApi->setupCall: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallsApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallsApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to.
my $user = user_example; # String | The user performing the call setup.
my $aptype = aptype_example; # String | The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
my $cid = cid_example; # String | can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
my $role = role_example; # String | what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. my $bypass = bypass_example; # String | Bypass call routing ('true' or 'false') my $intrude = intrude_example; # String | Intrude the current call ('true' or 'false') my $callbackViaGsm = true; # Boolean | True if the callback should prefer GSM call. eval { $api_instance->setupCall(domain => $domain, user => $user, aptype => $aptype, cid => $cid, role => $role, bypass => $bypass, intrude => $intrude, callbackViaGsm => $callbackViaGsm); }; if ($@) { warn "Exception when calling CallsApi->setupCall: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallsApi()
domain = domain_example # String | The domain of the organization the user belongs to.
user = user_example # String | The user performing the call setup.
aptype = aptype_example # String | The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:
mobile - to set up the call to the mobile 
soft - to set up the call to the softphone
desktop - to set up the call to the desktop phone
fxs - to set up the call to an analog phone
external_pbx - to set up the call to a phone on an external pbx
cid = cid_example # String | can be one of the following:
receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.
phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)
role = role_example # String | what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules. (optional) bypass = bypass_example # String | Bypass call routing ('true' or 'false') (optional) intrude = intrude_example # String | Intrude the current call ('true' or 'false') (optional) callbackViaGsm = true # Boolean | True if the callback should prefer GSM call. (optional) try: # Set up call api_instance.setup_call(domain, user, aptype, cid, role=role, bypass=bypass, intrude=intrude, callbackViaGsm=callbackViaGsm) except ApiException as e: print("Exception when calling CallsApi->setupCall: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to.
Required
user*
String
The user performing the call setup.
Required
aptype*
String
The 'aptype' defines where the callback will be connected. It should be a valid answerplace for the specified user. Valid values are:<br><pre>mobile - to set up the call to the mobile <br>soft - to set up the call to the softphone <br>desktop - to set up the call to the desktop phone <br>fxs - to set up the call to an analog phone <br>external_pbx - to set up the call to a phone on an external pbx</pre>
Required
cid*
String
can be one of the following:<br><pre>receiving_user - the receiving users URL encoded answerplace. For instance: targetname@yourdomain.com.<br>phone_number - If the answerplace is an external party, the parameter needs to be URL encoded and the phone number in international format, i.e a leading "+" ("%2B" when URL encoded)</pre>
Required
Query parameters
Name Description
role
String
what role to call with. The roles PRIVATE and BUSINESS are always possible to set, but additional roles may be specified. If no role is specified as a parameter, then it will be set to a default according to the call rules.
bypass
String
Bypass call routing ('true' or 'false')
intrude
String
Intrude the current call ('true' or 'false')
callback-via-gsm
Boolean
True if the callback should prefer GSM call.

Responses

Status: 200 - OK

Status: 400 - Input parameters missing or invalid

Status: 403 - Not Authorized

Status: 404 - Failed to set up the call


transferCall1

Transfer call

Transfer a mobile call to the specified number.


/calls/{domain}/{user}/transfer

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json,application/xml"\
"/api//calls/{domain}/{user}/transfer?transferType=&destination="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CallsApi;

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

public class CallsApiExample {

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


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the transfer.
        String transferType = transferType_example; // String | The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. String destination = destination_example; // String | The destination number for the transfer. try { CallTransferDTO result = apiInstance.transferCall1(domain, user, transferType, destination); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CallsApi#transferCall1"); e.printStackTrace(); } } }
import io.swagger.client.api.CallsApi;

public class CallsApiExample {

    public static void main(String[] args) {
        CallsApi apiInstance = new CallsApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to.
        String user = user_example; // String | The user performing the transfer.
        String transferType = transferType_example; // String | The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. String destination = destination_example; // String | The destination number for the transfer. try { CallTransferDTO result = apiInstance.transferCall1(domain, user, transferType, destination); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CallsApi#transferCall1"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to.
String *user = user_example; // The user performing the transfer.
String *transferType = transferType_example; // The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. String *destination = destination_example; // The destination number for the transfer. CallsApi *apiInstance = [[CallsApi alloc] init]; // Transfer call [apiInstance transferCall1With:domain user:user transferType:transferType destination:destination completionHandler: ^(CallTransferDTO output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.CallsApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to.
var user = user_example; // {{String}} The user performing the transfer.
var transferType = transferType_example; // {{String}} The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. var destination = destination_example; // {{String}} The destination number for the transfer. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.transferCall1(domain, user, transferType, destination, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new CallsApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to.
            var user = user_example;  // String | The user performing the transfer.
            var transferType = transferType_example;  // String | The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. var destination = destination_example; // String | The destination number for the transfer. try { // Transfer call CallTransferDTO result = apiInstance.transferCall1(domain, user, transferType, destination); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling CallsApi.transferCall1: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiCallsApi();
$domain = domain_example; // String | The domain of the organization the user belongs to.
$user = user_example; // String | The user performing the transfer.
$transferType = transferType_example; // String | The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. $destination = destination_example; // String | The destination number for the transfer. try { $result = $api_instance->transferCall1($domain, $user, $transferType, $destination); print_r($result); } catch (Exception $e) { echo 'Exception when calling CallsApi->transferCall1: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CallsApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CallsApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to.
my $user = user_example; # String | The user performing the transfer.
my $transferType = transferType_example; # String | The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. my $destination = destination_example; # String | The destination number for the transfer. eval { my $result = $api_instance->transferCall1(domain => $domain, user => $user, transferType => $transferType, destination => $destination); print Dumper($result); }; if ($@) { warn "Exception when calling CallsApi->transferCall1: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CallsApi()
domain = domain_example # String | The domain of the organization the user belongs to.
user = user_example # String | The user performing the transfer.
transferType = transferType_example # String | The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,
ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer. destination = destination_example # String | The destination number for the transfer. try: # Transfer call api_response = api_instance.transfer_call1(domain, user, transferType, destination) pprint(api_response) except ApiException as e: print("Exception when calling CallsApi->transferCall1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to.
Required
user*
String
The user performing the transfer.
Required
Query parameters
Name Description
transferType*
String
The type of transfer to be performed: BLIND_TRANSFER - transfer the call directly to the specified number,<br>ATTENDED_TRANSFER - Attended transfer allowing the user to communicate with the destination before the transfer.
Required
destination*
String
The destination number for the transfer.
Required

Responses

Status: 200 - OK

{"transferId":{"transferStartTime":0,"id":"5"}}
{"transferId":{"transferStartTime":0,"id":"5"}}

Status: 400 - Input parameters missing or invalid

Status: 403 - Not Authorized

Status: 404 - No transferable call found

Status: 409 - Call transfer already in progress for user


CommunicationLog

deleteAndUndeleteVoicemail

Update deletion time

Set or unset the deletion time for a communication log item. Setting deletion time moves an item to the trash, and clearing it moves it back to the inbox.


/communicationlog/{domain}/{userId}/{itemId}/deletedTime

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//communicationlog/{domain}/{userId}/{itemId}/deletedTime?delete="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        Boolean delete = true; // Boolean | Indicates if an item should be marked or unmarked for deletion
        try {
            apiInstance.deleteAndUndeleteVoicemail(itemId, userId, domain, delete);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#deleteAndUndeleteVoicemail");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        Boolean delete = true; // Boolean | Indicates if an item should be marked or unmarked for deletion
        try {
            apiInstance.deleteAndUndeleteVoicemail(itemId, userId, domain, delete);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#deleteAndUndeleteVoicemail");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *itemId = itemId_example; // The id of the item
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
Boolean *delete = true; // Indicates if an item should be marked or unmarked for deletion (optional)

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

// Update deletion time
[apiInstance deleteAndUndeleteVoicemailWith:itemId
    userId:userId
    domain:domain
    delete:delete
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var itemId = itemId_example; // {{String}} The id of the item
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var opts = { 
  'delete': true // {{Boolean}} Indicates if an item should be marked or unmarked for deletion
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAndUndeleteVoicemail(itemId, userId, domain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var itemId = itemId_example;  // String | The id of the item
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var delete = true;  // Boolean | Indicates if an item should be marked or unmarked for deletion (optional) 

            try
            {
                // Update deletion time
                apiInstance.deleteAndUndeleteVoicemail(itemId, userId, domain, delete);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.deleteAndUndeleteVoicemail: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$itemId = itemId_example; // String | The id of the item
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$delete = true; // Boolean | Indicates if an item should be marked or unmarked for deletion

try {
    $api_instance->deleteAndUndeleteVoicemail($itemId, $userId, $domain, $delete);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->deleteAndUndeleteVoicemail: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $itemId = itemId_example; # String | The id of the item
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $delete = true; # Boolean | Indicates if an item should be marked or unmarked for deletion

eval { 
    $api_instance->deleteAndUndeleteVoicemail(itemId => $itemId, userId => $userId, domain => $domain, delete => $delete);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->deleteAndUndeleteVoicemail: $@\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.CommunicationLogApi()
itemId = itemId_example # String | The id of the item
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
delete = true # Boolean | Indicates if an item should be marked or unmarked for deletion (optional)

try: 
    # Update deletion time
    api_instance.delete_and_undelete_voicemail(itemId, userId, domain, delete=delete)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->deleteAndUndeleteVoicemail: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
String
The id of the item
Required
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Query parameters
Name Description
delete
Boolean
Indicates if an item should be marked or unmarked for deletion

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteHistoryItem

Delete log item

Delete a specific communication log item.


/communicationlog/{domain}/{userId}/{itemId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//communicationlog/{domain}/{userId}/{itemId}?updateCallItem="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        Boolean updateCallItem = true; // Boolean | Indicates if the related call item should be deleted too
        try {
            apiInstance.deleteHistoryItem(itemId, userId, domain, updateCallItem);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#deleteHistoryItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        Boolean updateCallItem = true; // Boolean | Indicates if the related call item should be deleted too
        try {
            apiInstance.deleteHistoryItem(itemId, userId, domain, updateCallItem);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#deleteHistoryItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *itemId = itemId_example; // The id of the item
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
Boolean *updateCallItem = true; // Indicates if the related call item should be deleted too

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

// Delete log item
[apiInstance deleteHistoryItemWith:itemId
    userId:userId
    domain:domain
    updateCallItem:updateCallItem
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var itemId = itemId_example; // {{String}} The id of the item
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var updateCallItem = true; // {{Boolean}} Indicates if the related call item should be deleted too

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteHistoryItem(itemId, userId, domain, updateCallItem, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var itemId = itemId_example;  // String | The id of the item
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var updateCallItem = true;  // Boolean | Indicates if the related call item should be deleted too

            try
            {
                // Delete log item
                apiInstance.deleteHistoryItem(itemId, userId, domain, updateCallItem);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.deleteHistoryItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$itemId = itemId_example; // String | The id of the item
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$updateCallItem = true; // Boolean | Indicates if the related call item should be deleted too

try {
    $api_instance->deleteHistoryItem($itemId, $userId, $domain, $updateCallItem);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->deleteHistoryItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $itemId = itemId_example; # String | The id of the item
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $updateCallItem = true; # Boolean | Indicates if the related call item should be deleted too

eval { 
    $api_instance->deleteHistoryItem(itemId => $itemId, userId => $userId, domain => $domain, updateCallItem => $updateCallItem);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->deleteHistoryItem: $@\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.CommunicationLogApi()
itemId = itemId_example # String | The id of the item
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
updateCallItem = true # Boolean | Indicates if the related call item should be deleted too

try: 
    # Delete log item
    api_instance.delete_history_item(itemId, userId, domain, updateCallItem)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->deleteHistoryItem: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
String
The id of the item
Required
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Query parameters
Name Description
updateCallItem*
Boolean
Indicates if the related call item should be deleted too
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteHistoryItems

Delete log items

Delete a number of specific communication log items.


/communicationlog/{domain}/{userId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//communicationlog/{domain}/{userId}?itemId=&untilItemId=&itemType=&updateCallItem="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        array[String] itemId = ; // array[String] | The ids of the item
        String untilItemId = untilItemId_example; // String | Delete all items until this id
        String itemType = itemType_example; // String | Delete items of these types. The parameter can be repeated.
        Boolean updateCallItem = true; // Boolean | Indicates if the related call item should be deleted too
        try {
            apiInstance.deleteHistoryItems(userId, domain, itemId, untilItemId, itemType, updateCallItem);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#deleteHistoryItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        array[String] itemId = ; // array[String] | The ids of the item
        String untilItemId = untilItemId_example; // String | Delete all items until this id
        String itemType = itemType_example; // String | Delete items of these types. The parameter can be repeated.
        Boolean updateCallItem = true; // Boolean | Indicates if the related call item should be deleted too
        try {
            apiInstance.deleteHistoryItems(userId, domain, itemId, untilItemId, itemType, updateCallItem);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#deleteHistoryItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
array[String] *itemId = ; // The ids of the item (optional)
String *untilItemId = untilItemId_example; // Delete all items until this id (optional)
String *itemType = itemType_example; // Delete items of these types. The parameter can be repeated. (optional)
Boolean *updateCallItem = true; // Indicates if the related call item should be deleted too (optional)

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

// Delete log items
[apiInstance deleteHistoryItemsWith:userId
    domain:domain
    itemId:itemId
    untilItemId:untilItemId
    itemType:itemType
    updateCallItem:updateCallItem
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var opts = { 
  'itemId': , // {{array[String]}} The ids of the item
  'untilItemId': untilItemId_example, // {{String}} Delete all items until this id
  'itemType': itemType_example, // {{String}} Delete items of these types. The parameter can be repeated.
  'updateCallItem': true // {{Boolean}} Indicates if the related call item should be deleted too
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteHistoryItems(userId, domain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var itemId = new array[String](); // array[String] | The ids of the item (optional) 
            var untilItemId = untilItemId_example;  // String | Delete all items until this id (optional) 
            var itemType = itemType_example;  // String | Delete items of these types. The parameter can be repeated. (optional) 
            var updateCallItem = true;  // Boolean | Indicates if the related call item should be deleted too (optional) 

            try
            {
                // Delete log items
                apiInstance.deleteHistoryItems(userId, domain, itemId, untilItemId, itemType, updateCallItem);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.deleteHistoryItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$itemId = ; // array[String] | The ids of the item
$untilItemId = untilItemId_example; // String | Delete all items until this id
$itemType = itemType_example; // String | Delete items of these types. The parameter can be repeated.
$updateCallItem = true; // Boolean | Indicates if the related call item should be deleted too

try {
    $api_instance->deleteHistoryItems($userId, $domain, $itemId, $untilItemId, $itemType, $updateCallItem);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->deleteHistoryItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $itemId = []; # array[String] | The ids of the item
my $untilItemId = untilItemId_example; # String | Delete all items until this id
my $itemType = itemType_example; # String | Delete items of these types. The parameter can be repeated.
my $updateCallItem = true; # Boolean | Indicates if the related call item should be deleted too

eval { 
    $api_instance->deleteHistoryItems(userId => $userId, domain => $domain, itemId => $itemId, untilItemId => $untilItemId, itemType => $itemType, updateCallItem => $updateCallItem);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->deleteHistoryItems: $@\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.CommunicationLogApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
itemId =  # array[String] | The ids of the item (optional)
untilItemId = untilItemId_example # String | Delete all items until this id (optional)
itemType = itemType_example # String | Delete items of these types. The parameter can be repeated. (optional)
updateCallItem = true # Boolean | Indicates if the related call item should be deleted too (optional)

try: 
    # Delete log items
    api_instance.delete_history_items(userId, domain, itemId=itemId, untilItemId=untilItemId, itemType=itemType, updateCallItem=updateCallItem)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->deleteHistoryItems: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Query parameters
Name Description
itemId
array[String]
The ids of the item
untilItemId
String
Delete all items until this id
itemType
String
Delete items of these types. The parameter can be repeated.
updateCallItem
Boolean
Indicates if the related call item should be deleted too

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


fetchGroupInboxHistoryItems

List group inbox items

Read group inbox messages.


/communicationlog/groupinbox/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//communicationlog/groupinbox/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String userId = userId_example; // String | The username of the user accessing the API
        try {
            CommunicationHistoryDTO result = apiInstance.fetchGroupInboxHistoryItems(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#fetchGroupInboxHistoryItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String userId = userId_example; // String | The username of the user accessing the API
        try {
            CommunicationHistoryDTO result = apiInstance.fetchGroupInboxHistoryItems(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#fetchGroupInboxHistoryItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *userId = userId_example; // The username of the user accessing the API

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

// List group inbox items
[apiInstance fetchGroupInboxHistoryItemsWith:domain
    userId:userId
              completionHandler: ^(CommunicationHistoryDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var userId = userId_example; // {{String}} The username of the user accessing the API

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

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


            var apiInstance = new CommunicationLogApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var userId = userId_example;  // String | The username of the user accessing the API

            try
            {
                // List group inbox items
                CommunicationHistoryDTO result = apiInstance.fetchGroupInboxHistoryItems(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.fetchGroupInboxHistoryItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$domain = domain_example; // String | The domain of the user accessing the API
$userId = userId_example; // String | The username of the user accessing the API

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


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $userId = userId_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->fetchGroupInboxHistoryItems(domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->fetchGroupInboxHistoryItems: $@\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.CommunicationLogApi()
domain = domain_example # String | The domain of the user accessing the API
userId = userId_example # String | The username of the user accessing the API

try: 
    # List group inbox items
    api_response = api_instance.fetch_group_inbox_history_items(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->fetchGroupInboxHistoryItems: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
userId*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

{"historyItems":[{".GroupInboxVoiceMailDTO":{"itemId":370,"startTime":"2020-01-30T17:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":true,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/370?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":true,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/370?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","playDate":"2020-01-31T09:38:14Z","inboxName":"Group Inbox 1","playedTo":"John Smith"}}],"flushCache":true,"generatedAt":"2020-01-31T09:38:21Z","hintCount":1}
{"historyItems":[{".GroupInboxVoiceMailDTO":{"itemId":370,"startTime":"2020-01-30T17:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":true,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/370?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":false,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/370?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","inboxName":"Group Inbox 1"}}],"flushCache":true,"generatedAt":"2020-01-31T09:28:21Z","hintCount":1}
{"historyItems":[],"flushCache":true,"generatedAt":"2020-01-31T09:48:21Z","hintCount":0}

Status: 403 - Not Authorized

Status: 404 - Organization domain not found


fetchHistoryItem

Get log item

Read a specific communication log item.


/communicationlog/{domain}/{userId}/{itemId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//communicationlog/{domain}/{userId}/{itemId}?deleted=&markAsDelete="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String userId = userId_example; // String | The username of the user accessing the API
        String itemId = itemId_example; // String | The id of the item
        Boolean deleted = true; // Boolean | If true, fetch deleted items only
        Boolean markAsDelete = true; // Boolean | If true, fetch items that are marked as deleted only
        try {
            CommunicationHistoryDTO result = apiInstance.fetchHistoryItem(domain, userId, itemId, deleted, markAsDelete);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#fetchHistoryItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String userId = userId_example; // String | The username of the user accessing the API
        String itemId = itemId_example; // String | The id of the item
        Boolean deleted = true; // Boolean | If true, fetch deleted items only
        Boolean markAsDelete = true; // Boolean | If true, fetch items that are marked as deleted only
        try {
            CommunicationHistoryDTO result = apiInstance.fetchHistoryItem(domain, userId, itemId, deleted, markAsDelete);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#fetchHistoryItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *userId = userId_example; // The username of the user accessing the API
String *itemId = itemId_example; // The id of the item
Boolean *deleted = true; // If true, fetch deleted items only (optional)
Boolean *markAsDelete = true; // If true, fetch items that are marked as deleted only (optional)

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

// Get log item
[apiInstance fetchHistoryItemWith:domain
    userId:userId
    itemId:itemId
    deleted:deleted
    markAsDelete:markAsDelete
              completionHandler: ^(CommunicationHistoryDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var userId = userId_example; // {{String}} The username of the user accessing the API
var itemId = itemId_example; // {{String}} The id of the item
var opts = { 
  'deleted': true, // {{Boolean}} If true, fetch deleted items only
  'markAsDelete': true // {{Boolean}} If true, fetch items that are marked as deleted only
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fetchHistoryItem(domain, userId, itemId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var userId = userId_example;  // String | The username of the user accessing the API
            var itemId = itemId_example;  // String | The id of the item
            var deleted = true;  // Boolean | If true, fetch deleted items only (optional) 
            var markAsDelete = true;  // Boolean | If true, fetch items that are marked as deleted only (optional) 

            try
            {
                // Get log item
                CommunicationHistoryDTO result = apiInstance.fetchHistoryItem(domain, userId, itemId, deleted, markAsDelete);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.fetchHistoryItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$domain = domain_example; // String | The domain of the user accessing the API
$userId = userId_example; // String | The username of the user accessing the API
$itemId = itemId_example; // String | The id of the item
$deleted = true; // Boolean | If true, fetch deleted items only
$markAsDelete = true; // Boolean | If true, fetch items that are marked as deleted only

try {
    $result = $api_instance->fetchHistoryItem($domain, $userId, $itemId, $deleted, $markAsDelete);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->fetchHistoryItem: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $userId = userId_example; # String | The username of the user accessing the API
my $itemId = itemId_example; # String | The id of the item
my $deleted = true; # Boolean | If true, fetch deleted items only
my $markAsDelete = true; # Boolean | If true, fetch items that are marked as deleted only

eval { 
    my $result = $api_instance->fetchHistoryItem(domain => $domain, userId => $userId, itemId => $itemId, deleted => $deleted, markAsDelete => $markAsDelete);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->fetchHistoryItem: $@\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.CommunicationLogApi()
domain = domain_example # String | The domain of the user accessing the API
userId = userId_example # String | The username of the user accessing the API
itemId = itemId_example # String | The id of the item
deleted = true # Boolean | If true, fetch deleted items only (optional)
markAsDelete = true # Boolean | If true, fetch items that are marked as deleted only (optional)

try: 
    # Get log item
    api_response = api_instance.fetch_history_item(domain, userId, itemId, deleted=deleted, markAsDelete=markAsDelete)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->fetchHistoryItem: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
userId*
String
The username of the user accessing the API
Required
itemId*
String
The id of the item
Required
Query parameters
Name Description
deleted
Boolean
If true, fetch deleted items only
markAsDelete
Boolean
If true, fetch items that are marked as deleted only

Responses

Status: 200 - OK

{"historyItems":[{".RecordingDTO":{"itemId":572075557,"startTime":"2020-01-31T19:55:21Z","remoteParty":{"contactId":"3595110@internal","number":"+46890510","displayName":"Fröken Ur"},"itemType":"RECORDING","isSeen":true,"callItemId":572075560,"url":"http://example.com/api/fileStorage/test.com/agent1/recording/572075560","isPlayed":false}}],"flushCache":true,"generatedAt":"2020-01-31T19:58:21Z","hintCount":1}
{"historyItems":[{".CallDTO":{"itemId":1246,"startTime":"2020-10-05T14:06:20Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"OUTGOING_CALL","isSeen":true,"duration":25}}],"flushCache":true,"generatedAt":"2020-10-05T19:57:21Z","hintCount":1}
{"historyItems":[{".VoiceMailDTO":{"itemId":39,"startTime":"2020-01-30T18:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":false,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/39?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":false,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/39?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H"}}],"flushCache":true,"generatedAt":"2020-01-31T19:59:21Z","hintCount":1}
{"historyItems":[{".VoiceMailDTO":{"itemId":37,"startTime":"2020-01-30T07:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":true,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/37?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":true,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/37?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H"}}],"flushCache":true,"generatedAt":"2020-01-31T19:57:21Z","hintCount":1}
{"historyItems":[{".CallDTO":{"itemId":1247,"startTime":"2020-10-05T15:16:54Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"MISSED_CALL","isSeen":false,"duration":0}}],"flushCache":true,"generatedAt":"2020-10-05T19:56:21Z","hintCount":1}
{"historyItems":[{".VoiceMailDTO":{"itemId":38,"startTime":"2020-01-30T17:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":true,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/38?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":false,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/38?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H"}}],"flushCache":true,"generatedAt":"2020-01-31T19:58:21Z","hintCount":1}
{"historyItems":[],"flushCache":true,"generatedAt":"2020-01-31T09:48:21Z","hintCount":0}
{"historyItems":[{".CallDTO":{"itemId":1245,"startTime":"2020-10-05T11:09:29Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"INCOMING_CALL","isSeen":true,"duration":145}}],"flushCache":true,"generatedAt":"2020-10-05T19:59:21Z","hintCount":1}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization domain not found


fetchHistoryItems

List log items

List communication log items for a user.


/communicationlog/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//communicationlog/{domain}/{userId}?since=&olderThan=&limit=&itemType=&contactId=&number=&deleted=&markAsDelete=&count="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String userId = userId_example; // String | The username of the user accessing the API
        String since = since_example; // String | Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned.
        String olderThan = olderThan_example; // String | Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned.
        String limit = limit_example; // String | The maximum number of items that should be fetched
        String itemType = itemType_example; // String | The type of items that should be fetched. This parameter can be repeated for each type to be fetched.
        String contactId = contactId_example; // String | If specified, fetch items for this specific contact only
        String number = number_example; // String | If specified, fetch items for the specified phone number only
        Boolean deleted = true; // Boolean | If true, fetch deleted items only
        Boolean markAsDelete = true; // Boolean | If true, fetch items that are marked as deleted only
        Boolean count = true; // Boolean | If true, return the number of items instead of the items in the response body
        try {
            inline_response_200 result = apiInstance.fetchHistoryItems(domain, userId, since, olderThan, limit, itemType, contactId, number, deleted, markAsDelete, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#fetchHistoryItems");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String userId = userId_example; // String | The username of the user accessing the API
        String since = since_example; // String | Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned.
        String olderThan = olderThan_example; // String | Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned.
        String limit = limit_example; // String | The maximum number of items that should be fetched
        String itemType = itemType_example; // String | The type of items that should be fetched. This parameter can be repeated for each type to be fetched.
        String contactId = contactId_example; // String | If specified, fetch items for this specific contact only
        String number = number_example; // String | If specified, fetch items for the specified phone number only
        Boolean deleted = true; // Boolean | If true, fetch deleted items only
        Boolean markAsDelete = true; // Boolean | If true, fetch items that are marked as deleted only
        Boolean count = true; // Boolean | If true, return the number of items instead of the items in the response body
        try {
            inline_response_200 result = apiInstance.fetchHistoryItems(domain, userId, since, olderThan, limit, itemType, contactId, number, deleted, markAsDelete, count);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#fetchHistoryItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *userId = userId_example; // The username of the user accessing the API
String *since = since_example; // Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned. (optional)
String *olderThan = olderThan_example; // Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned. (optional)
String *limit = limit_example; // The maximum number of items that should be fetched (optional)
String *itemType = itemType_example; // The type of items that should be fetched. This parameter can be repeated for each type to be fetched. (optional)
String *contactId = contactId_example; // If specified, fetch items for this specific contact only (optional)
String *number = number_example; // If specified, fetch items for the specified phone number only (optional)
Boolean *deleted = true; // If true, fetch deleted items only (optional)
Boolean *markAsDelete = true; // If true, fetch items that are marked as deleted only (optional)
Boolean *count = true; // If true, return the number of items instead of the items in the response body (optional)

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

// List log items
[apiInstance fetchHistoryItemsWith:domain
    userId:userId
    since:since
    olderThan:olderThan
    limit:limit
    itemType:itemType
    contactId:contactId
    number:number
    deleted:deleted
    markAsDelete:markAsDelete
    count:count
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var userId = userId_example; // {{String}} The username of the user accessing the API
var opts = { 
  'since': since_example, // {{String}} Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned.
  'olderThan': olderThan_example, // {{String}} Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned.
  'limit': limit_example, // {{String}} The maximum number of items that should be fetched
  'itemType': itemType_example, // {{String}} The type of items that should be fetched. This parameter can be repeated for each type to be fetched.
  'contactId': contactId_example, // {{String}} If specified, fetch items for this specific contact only
  'number': number_example, // {{String}} If specified, fetch items for the specified phone number only
  'deleted': true, // {{Boolean}} If true, fetch deleted items only
  'markAsDelete': true, // {{Boolean}} If true, fetch items that are marked as deleted only
  'count': true // {{Boolean}} If true, return the number of items instead of the items in the response body
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fetchHistoryItems(domain, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var userId = userId_example;  // String | The username of the user accessing the API
            var since = since_example;  // String | Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned. (optional) 
            var olderThan = olderThan_example;  // String | Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned. (optional) 
            var limit = limit_example;  // String | The maximum number of items that should be fetched (optional) 
            var itemType = itemType_example;  // String | The type of items that should be fetched. This parameter can be repeated for each type to be fetched. (optional) 
            var contactId = contactId_example;  // String | If specified, fetch items for this specific contact only (optional) 
            var number = number_example;  // String | If specified, fetch items for the specified phone number only (optional) 
            var deleted = true;  // Boolean | If true, fetch deleted items only (optional) 
            var markAsDelete = true;  // Boolean | If true, fetch items that are marked as deleted only (optional) 
            var count = true;  // Boolean | If true, return the number of items instead of the items in the response body (optional) 

            try
            {
                // List log items
                inline_response_200 result = apiInstance.fetchHistoryItems(domain, userId, since, olderThan, limit, itemType, contactId, number, deleted, markAsDelete, count);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.fetchHistoryItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$domain = domain_example; // String | The domain of the user accessing the API
$userId = userId_example; // String | The username of the user accessing the API
$since = since_example; // String | Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned.
$olderThan = olderThan_example; // String | Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned.
$limit = limit_example; // String | The maximum number of items that should be fetched
$itemType = itemType_example; // String | The type of items that should be fetched. This parameter can be repeated for each type to be fetched.
$contactId = contactId_example; // String | If specified, fetch items for this specific contact only
$number = number_example; // String | If specified, fetch items for the specified phone number only
$deleted = true; // Boolean | If true, fetch deleted items only
$markAsDelete = true; // Boolean | If true, fetch items that are marked as deleted only
$count = true; // Boolean | If true, return the number of items instead of the items in the response body

try {
    $result = $api_instance->fetchHistoryItems($domain, $userId, $since, $olderThan, $limit, $itemType, $contactId, $number, $deleted, $markAsDelete, $count);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->fetchHistoryItems: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $userId = userId_example; # String | The username of the user accessing the API
my $since = since_example; # String | Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned.
my $olderThan = olderThan_example; # String | Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned.
my $limit = limit_example; # String | The maximum number of items that should be fetched
my $itemType = itemType_example; # String | The type of items that should be fetched. This parameter can be repeated for each type to be fetched.
my $contactId = contactId_example; # String | If specified, fetch items for this specific contact only
my $number = number_example; # String | If specified, fetch items for the specified phone number only
my $deleted = true; # Boolean | If true, fetch deleted items only
my $markAsDelete = true; # Boolean | If true, fetch items that are marked as deleted only
my $count = true; # Boolean | If true, return the number of items instead of the items in the response body

eval { 
    my $result = $api_instance->fetchHistoryItems(domain => $domain, userId => $userId, since => $since, olderThan => $olderThan, limit => $limit, itemType => $itemType, contactId => $contactId, number => $number, deleted => $deleted, markAsDelete => $markAsDelete, count => $count);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->fetchHistoryItems: $@\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.CommunicationLogApi()
domain = domain_example # String | The domain of the user accessing the API
userId = userId_example # String | The username of the user accessing the API
since = since_example # String | Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned. (optional)
olderThan = olderThan_example # String | Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned. (optional)
limit = limit_example # String | The maximum number of items that should be fetched (optional)
itemType = itemType_example # String | The type of items that should be fetched. This parameter can be repeated for each type to be fetched. (optional)
contactId = contactId_example # String | If specified, fetch items for this specific contact only (optional)
number = number_example # String | If specified, fetch items for the specified phone number only (optional)
deleted = true # Boolean | If true, fetch deleted items only (optional)
markAsDelete = true # Boolean | If true, fetch items that are marked as deleted only (optional)
count = true # Boolean | If true, return the number of items instead of the items in the response body (optional)

try: 
    # List log items
    api_response = api_instance.fetch_history_items(domain, userId, since=since, olderThan=olderThan, limit=limit, itemType=itemType, contactId=contactId, number=number, deleted=deleted, markAsDelete=markAsDelete, count=count)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->fetchHistoryItems: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
userId*
String
The username of the user accessing the API
Required
Query parameters
Name Description
since
String
Fetch items whose ID is larger than this value. For example, if since=10 is provided in the query string, items with ID 11 and upwards are returned.
olderThan
String
Fetch items whose ID is less than this value. For example, if olderThan=20 is provided, call log items with IDs from 19 and downwards are returned.
limit
String
The maximum number of items that should be fetched
itemType
String
The type of items that should be fetched. This parameter can be repeated for each type to be fetched.
contactId
String
If specified, fetch items for this specific contact only
number
String
If specified, fetch items for the specified phone number only
deleted
Boolean
If true, fetch deleted items only
markAsDelete
Boolean
If true, fetch items that are marked as deleted only
count
Boolean
If true, return the number of items instead of the items in the response body

Responses

Status: 200 - OK

{"historyItems":[{".VoiceMailDTO":{"itemId":37,"startTime":"2020-01-30T07:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":true,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/37?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":true,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/37?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H"}},{".VoiceMailDTO":{"itemId":38,"startTime":"2020-01-30T17:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":true,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/38?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":false,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/38?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H"}},{".VoiceMailDTO":{"itemId":39,"startTime":"2020-01-30T18:11:13Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"VOICEMAIL","isSeen":false,"callItemId":0,"url":"http://example.com/api/fileStorage/test.com/agent1/voicemail/39?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H","isPlayed":false,"click2CallUrl":"http://example.com/api/calls/voicemail/test.com/agent1/39?ginorgid=123&t=123.ABCdEFGhIJklMNOpQrG1R15H"}}],"flushCache":true,"generatedAt":"2020-01-31T19:48:21Z","hintCount":3}
{"historyItems":[{".RecordingDTO":{"itemId":572075557,"startTime":"2020-01-31T19:55:21Z","remoteParty":{"contactId":"3595110@internal","number":"+46890510","displayName":"Fröken Ur"},"itemType":"RECORDING","isSeen":true,"callItemId":572075560,"url":"http://example.com/api/fileStorage/test.com/agent1/recording/572075560","isPlayed":false}}],"flushCache":true,"generatedAt":"2020-01-31T19:58:21Z","hintCount":1}
12
{"historyItems":[{".CallDTO":{"itemId":1245,"startTime":"2020-10-05T11:09:29Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"INCOMING_CALL","isSeen":true,"duration":145}},{".CallDTO":{"itemId":1246,"startTime":"2020-10-05T14:06:20Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"OUTGOING_CALL","isSeen":true,"duration":25}},{".CallDTO":{"itemId":1247,"startTime":"2020-10-05T15:16:54Z","remoteParty":{"contactId":"jane.doe@example.com","number":"+1555123001","displayName":"Jane Doe"},"itemType":"MISSED_CALL","isSeen":false,"duration":0}}],"flushCache":true,"generatedAt":"2020-10-05T19:58:21Z","hintCount":3}
{"historyItems":[],"flushCache":true,"generatedAt":"2020-01-31T09:48:21Z","hintCount":0}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization domain not found


markAsSeenAndPlayed

Mark item as seen/played

Mark a specific communication log item as seen and/or played.


/communicationlog/{domain}/{userId}/{itemId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//communicationlog/{domain}/{userId}/{itemId}?isSeen=&isPlayed=&updateCallItem="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        Boolean isSeen = true; // Boolean | Indicates if the seen state should be set
        Boolean isPlayed = true; // Boolean | Indicates if the played state should be set
        Boolean updateCallItem = true; // Boolean | Indicates if the call item should be updated too
        try {
            apiInstance.markAsSeenAndPlayed(itemId, userId, domain, isSeen, isPlayed, updateCallItem);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#markAsSeenAndPlayed");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        Boolean isSeen = true; // Boolean | Indicates if the seen state should be set
        Boolean isPlayed = true; // Boolean | Indicates if the played state should be set
        Boolean updateCallItem = true; // Boolean | Indicates if the call item should be updated too
        try {
            apiInstance.markAsSeenAndPlayed(itemId, userId, domain, isSeen, isPlayed, updateCallItem);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#markAsSeenAndPlayed");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *itemId = itemId_example; // The id of the item
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
Boolean *isSeen = true; // Indicates if the seen state should be set
Boolean *isPlayed = true; // Indicates if the played state should be set
Boolean *updateCallItem = true; // Indicates if the call item should be updated too

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

// Mark item as seen/played
[apiInstance markAsSeenAndPlayedWith:itemId
    userId:userId
    domain:domain
    isSeen:isSeen
    isPlayed:isPlayed
    updateCallItem:updateCallItem
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var itemId = itemId_example; // {{String}} The id of the item
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var isSeen = true; // {{Boolean}} Indicates if the seen state should be set
var isPlayed = true; // {{Boolean}} Indicates if the played state should be set
var updateCallItem = true; // {{Boolean}} Indicates if the call item should be updated too

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.markAsSeenAndPlayed(itemId, userId, domain, isSeen, isPlayed, updateCallItem, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var itemId = itemId_example;  // String | The id of the item
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var isSeen = true;  // Boolean | Indicates if the seen state should be set
            var isPlayed = true;  // Boolean | Indicates if the played state should be set
            var updateCallItem = true;  // Boolean | Indicates if the call item should be updated too

            try
            {
                // Mark item as seen/played
                apiInstance.markAsSeenAndPlayed(itemId, userId, domain, isSeen, isPlayed, updateCallItem);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.markAsSeenAndPlayed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$itemId = itemId_example; // String | The id of the item
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$isSeen = true; // Boolean | Indicates if the seen state should be set
$isPlayed = true; // Boolean | Indicates if the played state should be set
$updateCallItem = true; // Boolean | Indicates if the call item should be updated too

try {
    $api_instance->markAsSeenAndPlayed($itemId, $userId, $domain, $isSeen, $isPlayed, $updateCallItem);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->markAsSeenAndPlayed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $itemId = itemId_example; # String | The id of the item
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $isSeen = true; # Boolean | Indicates if the seen state should be set
my $isPlayed = true; # Boolean | Indicates if the played state should be set
my $updateCallItem = true; # Boolean | Indicates if the call item should be updated too

eval { 
    $api_instance->markAsSeenAndPlayed(itemId => $itemId, userId => $userId, domain => $domain, isSeen => $isSeen, isPlayed => $isPlayed, updateCallItem => $updateCallItem);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->markAsSeenAndPlayed: $@\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.CommunicationLogApi()
itemId = itemId_example # String | The id of the item
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
isSeen = true # Boolean | Indicates if the seen state should be set
isPlayed = true # Boolean | Indicates if the played state should be set
updateCallItem = true # Boolean | Indicates if the call item should be updated too

try: 
    # Mark item as seen/played
    api_instance.mark_as_seen_and_played(itemId, userId, domain, isSeen, isPlayed, updateCallItem)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->markAsSeenAndPlayed: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
String
The id of the item
Required
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Query parameters
Name Description
isSeen*
Boolean
Indicates if the seen state should be set
Required
isPlayed*
Boolean
Indicates if the played state should be set
Required
updateCallItem*
Boolean
Indicates if the call item should be updated too
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


markAsSeenPlayedBatchUpdate

Mark items as seen/played

Mark specific communication log items as seen and/or played. In case if some of the items are existing, they are deleted and the items that are not found are added in the response body as a string. If all items are found, nothing is returned.


/communicationlog/{domain}/{userId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//communicationlog/{domain}/{userId}?itemId=&untilItemId=&itemType=&isSeen=&isPlayed=&updateCallItem="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        array[String] itemId = ; // array[String] | The ids of the items
        String untilItemId = untilItemId_example; // String | Indicates if all items until this id should be updated
        String itemType = itemType_example; // String | Indicates that only item types of these types should be updated. The parameter can be repeated.
        Boolean isSeen = true; // Boolean | Indicates if the seen state should be set
        Boolean isPlayed = true; // Boolean | Indicates if the played state should be set
        Boolean updateCallItem = true; // Boolean | Indicates if the call items should be updated too
        try {
            'String' result = apiInstance.markAsSeenPlayedBatchUpdate(userId, domain, itemId, untilItemId, itemType, isSeen, isPlayed, updateCallItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#markAsSeenPlayedBatchUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        array[String] itemId = ; // array[String] | The ids of the items
        String untilItemId = untilItemId_example; // String | Indicates if all items until this id should be updated
        String itemType = itemType_example; // String | Indicates that only item types of these types should be updated. The parameter can be repeated.
        Boolean isSeen = true; // Boolean | Indicates if the seen state should be set
        Boolean isPlayed = true; // Boolean | Indicates if the played state should be set
        Boolean updateCallItem = true; // Boolean | Indicates if the call items should be updated too
        try {
            'String' result = apiInstance.markAsSeenPlayedBatchUpdate(userId, domain, itemId, untilItemId, itemType, isSeen, isPlayed, updateCallItem);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#markAsSeenPlayedBatchUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
array[String] *itemId = ; // The ids of the items
String *untilItemId = untilItemId_example; // Indicates if all items until this id should be updated
String *itemType = itemType_example; // Indicates that only item types of these types should be updated. The parameter can be repeated.
Boolean *isSeen = true; // Indicates if the seen state should be set
Boolean *isPlayed = true; // Indicates if the played state should be set
Boolean *updateCallItem = true; // Indicates if the call items should be updated too

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

// Mark items as seen/played
[apiInstance markAsSeenPlayedBatchUpdateWith:userId
    domain:domain
    itemId:itemId
    untilItemId:untilItemId
    itemType:itemType
    isSeen:isSeen
    isPlayed:isPlayed
    updateCallItem:updateCallItem
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var itemId = ; // {{array[String]}} The ids of the items
var untilItemId = untilItemId_example; // {{String}} Indicates if all items until this id should be updated
var itemType = itemType_example; // {{String}} Indicates that only item types of these types should be updated. The parameter can be repeated.
var isSeen = true; // {{Boolean}} Indicates if the seen state should be set
var isPlayed = true; // {{Boolean}} Indicates if the played state should be set
var updateCallItem = true; // {{Boolean}} Indicates if the call items should be updated too

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.markAsSeenPlayedBatchUpdate(userId, domain, itemId, untilItemId, itemType, isSeen, isPlayed, updateCallItem, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var itemId = new array[String](); // array[String] | The ids of the items
            var untilItemId = untilItemId_example;  // String | Indicates if all items until this id should be updated
            var itemType = itemType_example;  // String | Indicates that only item types of these types should be updated. The parameter can be repeated.
            var isSeen = true;  // Boolean | Indicates if the seen state should be set
            var isPlayed = true;  // Boolean | Indicates if the played state should be set
            var updateCallItem = true;  // Boolean | Indicates if the call items should be updated too

            try
            {
                // Mark items as seen/played
                'String' result = apiInstance.markAsSeenPlayedBatchUpdate(userId, domain, itemId, untilItemId, itemType, isSeen, isPlayed, updateCallItem);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.markAsSeenPlayedBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$itemId = ; // array[String] | The ids of the items
$untilItemId = untilItemId_example; // String | Indicates if all items until this id should be updated
$itemType = itemType_example; // String | Indicates that only item types of these types should be updated. The parameter can be repeated.
$isSeen = true; // Boolean | Indicates if the seen state should be set
$isPlayed = true; // Boolean | Indicates if the played state should be set
$updateCallItem = true; // Boolean | Indicates if the call items should be updated too

try {
    $result = $api_instance->markAsSeenPlayedBatchUpdate($userId, $domain, $itemId, $untilItemId, $itemType, $isSeen, $isPlayed, $updateCallItem);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->markAsSeenPlayedBatchUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $itemId = []; # array[String] | The ids of the items
my $untilItemId = untilItemId_example; # String | Indicates if all items until this id should be updated
my $itemType = itemType_example; # String | Indicates that only item types of these types should be updated. The parameter can be repeated.
my $isSeen = true; # Boolean | Indicates if the seen state should be set
my $isPlayed = true; # Boolean | Indicates if the played state should be set
my $updateCallItem = true; # Boolean | Indicates if the call items should be updated too

eval { 
    my $result = $api_instance->markAsSeenPlayedBatchUpdate(userId => $userId, domain => $domain, itemId => $itemId, untilItemId => $untilItemId, itemType => $itemType, isSeen => $isSeen, isPlayed => $isPlayed, updateCallItem => $updateCallItem);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->markAsSeenPlayedBatchUpdate: $@\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.CommunicationLogApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
itemId =  # array[String] | The ids of the items
untilItemId = untilItemId_example # String | Indicates if all items until this id should be updated
itemType = itemType_example # String | Indicates that only item types of these types should be updated. The parameter can be repeated.
isSeen = true # Boolean | Indicates if the seen state should be set
isPlayed = true # Boolean | Indicates if the played state should be set
updateCallItem = true # Boolean | Indicates if the call items should be updated too

try: 
    # Mark items as seen/played
    api_response = api_instance.mark_as_seen_played_batch_update(userId, domain, itemId, untilItemId, itemType, isSeen, isPlayed, updateCallItem)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->markAsSeenPlayedBatchUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Query parameters
Name Description
itemId*
array[String]
The ids of the items
Required
untilItemId*
String
Indicates if all items until this id should be updated
Required
itemType*
String
Indicates that only item types of these types should be updated. The parameter can be repeated.
Required
isSeen*
Boolean
Indicates if the seen state should be set
Required
isPlayed*
Boolean
Indicates if the played state should be set
Required
updateCallItem*
Boolean
Indicates if the call items should be updated too
Required

Responses

Status: 200 - OK

[1276, 1786, 1965]

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


markVoicemailAsDelete

Mark item as deleted

Set the deleted flag on a specific communication log item. The delete flag is used for further expunging of voicemail items.


/communicationlog/{domain}/{userId}/{itemId}/deleteFlag

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//communicationlog/{domain}/{userId}/{itemId}/deleteFlag"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommunicationLogApi;

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

public class CommunicationLogApiExample {

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


        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.markVoicemailAsDelete(itemId, userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#markVoicemailAsDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommunicationLogApi;

public class CommunicationLogApiExample {

    public static void main(String[] args) {
        CommunicationLogApi apiInstance = new CommunicationLogApi();
        String itemId = itemId_example; // String | The id of the item
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.markVoicemailAsDelete(itemId, userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommunicationLogApi#markVoicemailAsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *itemId = itemId_example; // The id of the item
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Mark item as deleted
[apiInstance markVoicemailAsDeleteWith:itemId
    userId:userId
    domain:domain
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.CommunicationLogApi()
var itemId = itemId_example; // {{String}} The id of the item
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.markVoicemailAsDelete(itemId, userId, domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new CommunicationLogApi();
            var itemId = itemId_example;  // String | The id of the item
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Mark item as deleted
                apiInstance.markVoicemailAsDelete(itemId, userId, domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommunicationLogApi.markVoicemailAsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCommunicationLogApi();
$itemId = itemId_example; // String | The id of the item
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $api_instance->markVoicemailAsDelete($itemId, $userId, $domain);
} catch (Exception $e) {
    echo 'Exception when calling CommunicationLogApi->markVoicemailAsDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommunicationLogApi;


my $api_instance = WWW::SwaggerClient::CommunicationLogApi->new();
my $itemId = itemId_example; # String | The id of the item
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    $api_instance->markVoicemailAsDelete(itemId => $itemId, userId => $userId, domain => $domain);
};
if ($@) {
    warn "Exception when calling CommunicationLogApi->markVoicemailAsDelete: $@\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.CommunicationLogApi()
itemId = itemId_example # String | The id of the item
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Mark item as deleted
    api_instance.mark_voicemail_as_delete(itemId, userId, domain)
except ApiException as e:
    print("Exception when calling CommunicationLogApi->markVoicemailAsDelete: %s\n" % e)

Parameters

Path parameters
Name Description
itemId*
String
The id of the item
Required
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


Conference

deleteConference

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/{confId}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}/{confId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        try {
            apiInstance.deleteConference(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#deleteConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        try {
            apiInstance.deleteConference(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#deleteConference");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 
Long *confId = 789; // 

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

[apiInstance deleteConferenceWith:domain
    userId:userId
    confId:confId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 
var confId = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConference(domain, userId, confId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 
            var confId = 789;  // Long | 

            try
            {
                apiInstance.deleteConference(domain, userId, confId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.deleteConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 
$confId = 789; // Long | 

try {
    $api_instance->deleteConference($domain, $userId, $confId);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->deleteConference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 
my $confId = 789; # Long | 

eval { 
    $api_instance->deleteConference(domain => $domain, userId => $userId, confId => $confId);
};
if ($@) {
    warn "Exception when calling ConferenceApi->deleteConference: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 
confId = 789 # Long | 

try: 
    api_instance.delete_conference(domain, userId, confId)
except ApiException as e:
    print("Exception when calling ConferenceApi->deleteConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required
confId*
Long (int64)
Required

Responses

Status: default - default response


getConference

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/{confId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}/{confId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        try {
            apiInstance.getConference(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        try {
            apiInstance.getConference(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getConference");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 
Long *confId = 789; // 

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

[apiInstance getConferenceWith:domain
    userId:userId
    confId:confId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 
var confId = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getConference(domain, userId, confId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 
            var confId = 789;  // Long | 

            try
            {
                apiInstance.getConference(domain, userId, confId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.getConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 
$confId = 789; // Long | 

try {
    $api_instance->getConference($domain, $userId, $confId);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->getConference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 
my $confId = 789; # Long | 

eval { 
    $api_instance->getConference(domain => $domain, userId => $userId, confId => $confId);
};
if ($@) {
    warn "Exception when calling ConferenceApi->getConference: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 
confId = 789 # Long | 

try: 
    api_instance.get_conference(domain, userId, confId)
except ApiException as e:
    print("Exception when calling ConferenceApi->getConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required
confId*
Long (int64)
Required

Responses

Status: default - default response


getConferences

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        try {
            apiInstance.getConferences(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getConferences");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        try {
            apiInstance.getConferences(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getConferences");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 

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

[apiInstance getConferencesWith:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getConferences(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 

            try
            {
                apiInstance.getConferences(domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.getConferences: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 

try {
    $api_instance->getConferences($domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->getConferences: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 

eval { 
    $api_instance->getConferences(domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling ConferenceApi->getConferences: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 

try: 
    api_instance.get_conferences(domain, userId)
except ApiException as e:
    print("Exception when calling ConferenceApi->getConferences: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required

Responses

Status: default - default response


getConferencesForBinder

<i>NOTE: This method is DEPRECATED.</i>


/conference/streams

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/streams?binder_id=&unique_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String binderId = binderId_example; // String | 
        String uniqueId = uniqueId_example; // String | 
        try {
            ConferencesDTO result = apiInstance.getConferencesForBinder(binderId, uniqueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getConferencesForBinder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String binderId = binderId_example; // String | 
        String uniqueId = uniqueId_example; // String | 
        try {
            ConferencesDTO result = apiInstance.getConferencesForBinder(binderId, uniqueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getConferencesForBinder");
            e.printStackTrace();
        }
    }
}
String *binderId = binderId_example; //  (optional)
String *uniqueId = uniqueId_example; //  (optional)

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

[apiInstance getConferencesForBinderWith:binderId
    uniqueId:uniqueId
              completionHandler: ^(ConferencesDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var opts = { 
  'binderId': binderId_example, // {{String}} 
  'uniqueId': uniqueId_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConferencesForBinder(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var binderId = binderId_example;  // String |  (optional) 
            var uniqueId = uniqueId_example;  // String |  (optional) 

            try
            {
                ConferencesDTO result = apiInstance.getConferencesForBinder(binderId, uniqueId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.getConferencesForBinder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$binderId = binderId_example; // String | 
$uniqueId = uniqueId_example; // String | 

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

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $binderId = binderId_example; # String | 
my $uniqueId = uniqueId_example; # String | 

eval { 
    my $result = $api_instance->getConferencesForBinder(binderId => $binderId, uniqueId => $uniqueId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConferenceApi->getConferencesForBinder: $@\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.ConferenceApi()
binderId = binderId_example # String |  (optional)
uniqueId = uniqueId_example # String |  (optional)

try: 
    api_response = api_instance.get_conferences_for_binder(binderId=binderId, uniqueId=uniqueId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConferenceApi->getConferencesForBinder: %s\n" % e)

Parameters

Query parameters
Name Description
binder_id
String
unique_id
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not authorized


getDialInNumbers

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/dialInNumbers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}/dialInNumbers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        try {
            apiInstance.getDialInNumbers(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getDialInNumbers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        try {
            apiInstance.getDialInNumbers(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getDialInNumbers");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 

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

[apiInstance getDialInNumbersWith:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDialInNumbers(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 

            try
            {
                apiInstance.getDialInNumbers(domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.getDialInNumbers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 

try {
    $api_instance->getDialInNumbers($domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->getDialInNumbers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 

eval { 
    $api_instance->getDialInNumbers(domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling ConferenceApi->getDialInNumbers: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 

try: 
    api_instance.get_dial_in_numbers(domain, userId)
except ApiException as e:
    print("Exception when calling ConferenceApi->getDialInNumbers: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required

Responses

Status: default - default response


getWebmeetForConference

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/{confId}/webmeet

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}/{confId}/webmeet"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        try {
            apiInstance.getWebmeetForConference(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getWebmeetForConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        try {
            apiInstance.getWebmeetForConference(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#getWebmeetForConference");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 
Long *confId = 789; // 

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

[apiInstance getWebmeetForConferenceWith:domain
    userId:userId
    confId:confId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 
var confId = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getWebmeetForConference(domain, userId, confId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 
            var confId = 789;  // Long | 

            try
            {
                apiInstance.getWebmeetForConference(domain, userId, confId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.getWebmeetForConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 
$confId = 789; // Long | 

try {
    $api_instance->getWebmeetForConference($domain, $userId, $confId);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->getWebmeetForConference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 
my $confId = 789; # Long | 

eval { 
    $api_instance->getWebmeetForConference(domain => $domain, userId => $userId, confId => $confId);
};
if ($@) {
    warn "Exception when calling ConferenceApi->getWebmeetForConference: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 
confId = 789 # Long | 

try: 
    api_instance.get_webmeet_for_conference(domain, userId, confId)
except ApiException as e:
    print("Exception when calling ConferenceApi->getWebmeetForConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required
confId*
Long (int64)
Required

Responses

Status: default - default response


initializeConferenceWithNumber

Join conference call on user's answer place.

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/{confId}/join

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}/{confId}/join?answerPlace=&sipInstance=&autoAnswer="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | Organization domain
        String userId = userId_example; // String | User Identification
        Long confId = 789; // Long | Conference Id to join
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        String autoAnswer = autoAnswer_example; // String | Auto answer on user device
        try {
            apiInstance.initializeConferenceWithNumber(domain, userId, confId, answerPlace, sipInstance, autoAnswer);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#initializeConferenceWithNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | Organization domain
        String userId = userId_example; // String | User Identification
        Long confId = 789; // Long | Conference Id to join
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        String autoAnswer = autoAnswer_example; // String | Auto answer on user device
        try {
            apiInstance.initializeConferenceWithNumber(domain, userId, confId, answerPlace, sipInstance, autoAnswer);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#initializeConferenceWithNumber");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // Organization domain
String *userId = userId_example; // User Identification
Long *confId = 789; // Conference Id to join
String *answerPlace = answerPlace_example; // The register user device name (optional)
String *sipInstance = sipInstance_example; // Instance Id (sipInstance) of the user agent (optional)
String *autoAnswer = autoAnswer_example; // Auto answer on user device (optional)

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

// Join conference call on user's answer place.
[apiInstance initializeConferenceWithNumberWith:domain
    userId:userId
    confId:confId
    answerPlace:answerPlace
    sipInstance:sipInstance
    autoAnswer:autoAnswer
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} Organization domain
var userId = userId_example; // {{String}} User Identification
var confId = 789; // {{Long}} Conference Id to join
var opts = { 
  'answerPlace': answerPlace_example, // {{String}} The register user device name
  'sipInstance': sipInstance_example, // {{String}} Instance Id (sipInstance) of the user agent
  'autoAnswer': autoAnswer_example // {{String}} Auto answer on user device
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.initializeConferenceWithNumber(domain, userId, confId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | Organization domain
            var userId = userId_example;  // String | User Identification
            var confId = 789;  // Long | Conference Id to join
            var answerPlace = answerPlace_example;  // String | The register user device name (optional) 
            var sipInstance = sipInstance_example;  // String | Instance Id (sipInstance) of the user agent (optional) 
            var autoAnswer = autoAnswer_example;  // String | Auto answer on user device (optional) 

            try
            {
                // Join conference call on user's answer place.
                apiInstance.initializeConferenceWithNumber(domain, userId, confId, answerPlace, sipInstance, autoAnswer);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.initializeConferenceWithNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | Organization domain
$userId = userId_example; // String | User Identification
$confId = 789; // Long | Conference Id to join
$answerPlace = answerPlace_example; // String | The register user device name
$sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
$autoAnswer = autoAnswer_example; // String | Auto answer on user device

try {
    $api_instance->initializeConferenceWithNumber($domain, $userId, $confId, $answerPlace, $sipInstance, $autoAnswer);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->initializeConferenceWithNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | Organization domain
my $userId = userId_example; # String | User Identification
my $confId = 789; # Long | Conference Id to join
my $answerPlace = answerPlace_example; # String | The register user device name
my $sipInstance = sipInstance_example; # String | Instance Id (sipInstance) of the user agent
my $autoAnswer = autoAnswer_example; # String | Auto answer on user device

eval { 
    $api_instance->initializeConferenceWithNumber(domain => $domain, userId => $userId, confId => $confId, answerPlace => $answerPlace, sipInstance => $sipInstance, autoAnswer => $autoAnswer);
};
if ($@) {
    warn "Exception when calling ConferenceApi->initializeConferenceWithNumber: $@\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.ConferenceApi()
domain = domain_example # String | Organization domain
userId = userId_example # String | User Identification
confId = 789 # Long | Conference Id to join
answerPlace = answerPlace_example # String | The register user device name (optional)
sipInstance = sipInstance_example # String | Instance Id (sipInstance) of the user agent (optional)
autoAnswer = autoAnswer_example # String | Auto answer on user device (optional)

try: 
    # Join conference call on user's answer place.
    api_instance.initialize_conference_with_number(domain, userId, confId, answerPlace=answerPlace, sipInstance=sipInstance, autoAnswer=autoAnswer)
except ApiException as e:
    print("Exception when calling ConferenceApi->initializeConferenceWithNumber: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Organization domain
Required
userId*
String
User Identification
Required
confId*
Long (int64)
Conference Id to join
Required
Query parameters
Name Description
answerPlace
String
The register user device name
sipInstance
String
Instance Id (sipInstance) of the user agent
autoAnswer
String
Auto answer on user device

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not a valid conference to join


leaveConference1

Hangs up conference call on user's answer place.

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/{confId}/leave

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json,application/xml"\
"/api//conference/{domain}/{userId}/{confId}/leave?answerPlace=&sipInstance="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | Organization domain
        String userId = userId_example; // String | User Identification
        Long confId = 789; // Long | Conference Id to hang up call
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        try {
            apiInstance.leaveConference1(domain, userId, confId, answerPlace, sipInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#leaveConference1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | Organization domain
        String userId = userId_example; // String | User Identification
        Long confId = 789; // Long | Conference Id to hang up call
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        try {
            apiInstance.leaveConference1(domain, userId, confId, answerPlace, sipInstance);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#leaveConference1");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // Organization domain
String *userId = userId_example; // User Identification
Long *confId = 789; // Conference Id to hang up call
String *answerPlace = answerPlace_example; // The register user device name (optional)
String *sipInstance = sipInstance_example; // Instance Id (sipInstance) of the user agent (optional)

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

// Hangs up conference call on user's answer place.
[apiInstance leaveConference1With:domain
    userId:userId
    confId:confId
    answerPlace:answerPlace
    sipInstance:sipInstance
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} Organization domain
var userId = userId_example; // {{String}} User Identification
var confId = 789; // {{Long}} Conference Id to hang up call
var opts = { 
  'answerPlace': answerPlace_example, // {{String}} The register user device name
  'sipInstance': sipInstance_example // {{String}} Instance Id (sipInstance) of the user agent
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.leaveConference1(domain, userId, confId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | Organization domain
            var userId = userId_example;  // String | User Identification
            var confId = 789;  // Long | Conference Id to hang up call
            var answerPlace = answerPlace_example;  // String | The register user device name (optional) 
            var sipInstance = sipInstance_example;  // String | Instance Id (sipInstance) of the user agent (optional) 

            try
            {
                // Hangs up conference call on user's answer place.
                apiInstance.leaveConference1(domain, userId, confId, answerPlace, sipInstance);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.leaveConference1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | Organization domain
$userId = userId_example; // String | User Identification
$confId = 789; // Long | Conference Id to hang up call
$answerPlace = answerPlace_example; // String | The register user device name
$sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent

try {
    $api_instance->leaveConference1($domain, $userId, $confId, $answerPlace, $sipInstance);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->leaveConference1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | Organization domain
my $userId = userId_example; # String | User Identification
my $confId = 789; # Long | Conference Id to hang up call
my $answerPlace = answerPlace_example; # String | The register user device name
my $sipInstance = sipInstance_example; # String | Instance Id (sipInstance) of the user agent

eval { 
    $api_instance->leaveConference1(domain => $domain, userId => $userId, confId => $confId, answerPlace => $answerPlace, sipInstance => $sipInstance);
};
if ($@) {
    warn "Exception when calling ConferenceApi->leaveConference1: $@\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.ConferenceApi()
domain = domain_example # String | Organization domain
userId = userId_example # String | User Identification
confId = 789 # Long | Conference Id to hang up call
answerPlace = answerPlace_example # String | The register user device name (optional)
sipInstance = sipInstance_example # String | Instance Id (sipInstance) of the user agent (optional)

try: 
    # Hangs up conference call on user's answer place.
    api_instance.leave_conference1(domain, userId, confId, answerPlace=answerPlace, sipInstance=sipInstance)
except ApiException as e:
    print("Exception when calling ConferenceApi->leaveConference1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Organization domain
Required
userId*
String
User Identification
Required
confId*
Long (int64)
Conference Id to hang up call
Required
Query parameters
Name Description
answerPlace
String
The register user device name
sipInstance
String
Instance Id (sipInstance) of the user agent

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not a valid conference to hang up call


scheduleConference

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//conference/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        ConferenceDTO body = ; // ConferenceDTO | 
        try {
            apiInstance.scheduleConference(domain, userId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#scheduleConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        ConferenceDTO body = ; // ConferenceDTO | 
        try {
            apiInstance.scheduleConference(domain, userId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#scheduleConference");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 
ConferenceDTO *body = ; //  (optional)

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

[apiInstance scheduleConferenceWith:domain
    userId:userId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 
var opts = { 
  'body':  // {{ConferenceDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.scheduleConference(domainuserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 
            var body = new ConferenceDTO(); // ConferenceDTO |  (optional) 

            try
            {
                apiInstance.scheduleConference(domain, userId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.scheduleConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 
$body = ; // ConferenceDTO | 

try {
    $api_instance->scheduleConference($domain, $userId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->scheduleConference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 
my $body = WWW::SwaggerClient::Object::ConferenceDTO->new(); # ConferenceDTO | 

eval { 
    $api_instance->scheduleConference(domain => $domain, userId => $userId, body => $body);
};
if ($@) {
    warn "Exception when calling ConferenceApi->scheduleConference: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 
body =  # ConferenceDTO |  (optional)

try: 
    api_instance.schedule_conference(domain, userId, body=body)
except ApiException as e:
    print("Exception when calling ConferenceApi->scheduleConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required
Body parameters
Name Description
body

Responses

Status: default - default response


updateConference

<i>NOTE: This method is DEPRECATED.</i>


/conference/{domain}/{userId}/{confId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//conference/{domain}/{userId}/{confId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConferenceApi;

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

public class ConferenceApiExample {

    public static void main(String[] args) {
        
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        ConferenceDTO body = ; // ConferenceDTO | 
        try {
            apiInstance.updateConference(domain, userId, confId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#updateConference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConferenceApi;

public class ConferenceApiExample {

    public static void main(String[] args) {
        ConferenceApi apiInstance = new ConferenceApi();
        String domain = domain_example; // String | 
        String userId = userId_example; // String | 
        Long confId = 789; // Long | 
        ConferenceDTO body = ; // ConferenceDTO | 
        try {
            apiInstance.updateConference(domain, userId, confId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConferenceApi#updateConference");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // 
String *userId = userId_example; // 
Long *confId = 789; // 
ConferenceDTO *body = ; //  (optional)

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

[apiInstance updateConferenceWith:domain
    userId:userId
    confId:confId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.ConferenceApi()
var domain = domain_example; // {{String}} 
var userId = userId_example; // {{String}} 
var confId = 789; // {{Long}} 
var opts = { 
  'body':  // {{ConferenceDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateConference(domainuserIdconfId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ConferenceApi();
            var domain = domain_example;  // String | 
            var userId = userId_example;  // String | 
            var confId = 789;  // Long | 
            var body = new ConferenceDTO(); // ConferenceDTO |  (optional) 

            try
            {
                apiInstance.updateConference(domain, userId, confId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConferenceApi.updateConference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConferenceApi();
$domain = domain_example; // String | 
$userId = userId_example; // String | 
$confId = 789; // Long | 
$body = ; // ConferenceDTO | 

try {
    $api_instance->updateConference($domain, $userId, $confId, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConferenceApi->updateConference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConferenceApi;

my $api_instance = WWW::SwaggerClient::ConferenceApi->new();
my $domain = domain_example; # String | 
my $userId = userId_example; # String | 
my $confId = 789; # Long | 
my $body = WWW::SwaggerClient::Object::ConferenceDTO->new(); # ConferenceDTO | 

eval { 
    $api_instance->updateConference(domain => $domain, userId => $userId, confId => $confId, body => $body);
};
if ($@) {
    warn "Exception when calling ConferenceApi->updateConference: $@\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.ConferenceApi()
domain = domain_example # String | 
userId = userId_example # String | 
confId = 789 # Long | 
body =  # ConferenceDTO |  (optional)

try: 
    api_instance.update_conference(domain, userId, confId, body=body)
except ApiException as e:
    print("Exception when calling ConferenceApi->updateConference: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Required
userId*
String
Required
confId*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: default - default response


Contacts

addContact

Add contact

Add a contact to a user's contact list.


/contacts/list/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/list/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

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


        ContactsApi apiInstance = new ContactsApi();
        String domain = domain_example; // String | The domain of the user accessing the API.
        String user = user_example; // String | The username of the user accessing the API.
        String cid = cid_example; // String | The ID of the contact to be added to the contact list.
        try {
            ContactsDTO result = apiInstance.addContact(domain, user, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#addContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String domain = domain_example; // String | The domain of the user accessing the API.
        String user = user_example; // String | The username of the user accessing the API.
        String cid = cid_example; // String | The ID of the contact to be added to the contact list.
        try {
            ContactsDTO result = apiInstance.addContact(domain, user, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#addContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API.
String *user = user_example; // The username of the user accessing the API.
String *cid = cid_example; // The ID of the contact to be added to the contact list.

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

// Add contact
[apiInstance addContactWith:domain
    user:user
    cid:cid
              completionHandler: ^(ContactsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API.
var user = user_example; // {{String}} The username of the user accessing the API.
var cid = cid_example; // {{String}} The ID of the contact to be added to the contact list.

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

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


            var apiInstance = new ContactsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API.
            var user = user_example;  // String | The username of the user accessing the API.
            var cid = cid_example;  // String | The ID of the contact to be added to the contact list.

            try
            {
                // Add contact
                ContactsDTO result = apiInstance.addContact(domain, user, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.addContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsApi();
$domain = domain_example; // String | The domain of the user accessing the API.
$user = user_example; // String | The username of the user accessing the API.
$cid = cid_example; // String | The ID of the contact to be added to the contact list.

try {
    $result = $api_instance->addContact($domain, $user, $cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->addContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;


my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API.
my $user = user_example; # String | The username of the user accessing the API.
my $cid = cid_example; # String | The ID of the contact to be added to the contact list.

eval { 
    my $result = $api_instance->addContact(domain => $domain, user => $user, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->addContact: $@\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.ContactsApi()
domain = domain_example # String | The domain of the user accessing the API.
user = user_example # String | The username of the user accessing the API.
cid = cid_example # String | The ID of the contact to be added to the contact list.

try: 
    # Add contact
    api_response = api_instance.add_contact(domain, user, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->addContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API.
Required
user*
String
The username of the user accessing the API.
Required
cid*
String
The ID of the contact to be added to the contact list.
Required

Responses

Status: 200 - OK

{"query":"query","contact":[{"id":"user2@abc.com","firstname":"Jack","lastname":"Jill","company":"abc","presence":{"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","role":"Business","note":"Vacation","activity":{"id":"1231141551161","expiration":"NEVER","available":true},"idle":false,"available":true,"capabilities":["MESSAGE","PARTIAL_COLLABORATION","SMS"]},"incall":false,"inlist":true,"diversionAccess":"NONE","type":"DIRECTORY","image":12,"vcard":113,"contactStatus":"FAVORITE","preferredNumber":"+1231231","collaboration":true}]}
{"query":"query","contact":[{"id":"user2@abc.com","firstname":"Jack","lastname":"Jill","company":"abc","presence":{"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","role":"Business","note":"Vacation","activity":{"id":"1231141551161","expiration":"NEVER","available":true},"idle":false,"available":true,"capabilities":["MESSAGE","PARTIAL_COLLABORATION","SMS"]},"incall":false,"inlist":true,"diversionAccess":"NONE","type":"DIRECTORY","image":12,"vcard":113,"contactStatus":"FAVORITE","preferredNumber":"+1231231","collaboration":true}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


addContacts

Add contacts

Add multiple contacts to a user's contact list.


/contacts/list/{domain}/{user}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/list/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

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


        ContactsApi apiInstance = new ContactsApi();
        ContactsDTO body = {
  "query" : "query",
  "contact" : [ {
    "id" : "user2@abc.com",
    "firstname" : "Jack",
    "lastname" : "Jill",
    "company" : "abc",
    "presence" : {
      "futurePresenceAccess" : "NONE",
      "activityAccess" : "NONE",
      "roleAccess" : "NONE",
      "noteAccess" : "NONE",
      "role" : "Business",
      "note" : "Vacation",
      "activity" : {
        "id" : "1231141551161",
        "expiration" : "NEVER",
        "available" : true
      },
      "capabilities" : [ "MESSAGE", "PARTIAL_COLLABORATION", "SMS" ]
    },
    "incall" : false,
    "inlist" : true,
    "type" : "DIRECTORY",
    "image" : 12,
    "vcard" : 113,
    "contactStatus" : "FAVORITE",
    "collaboration" : true
  } ]
}; // ContactsDTO | 
        String domain = domain_example; // String | The domain of the user accessing the API.
        String user = user_example; // String | The username of the user accessing the API.
        try {
            ContactsDTO result = apiInstance.addContacts(body, domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#addContacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        ContactsDTO body = {
  "query" : "query",
  "contact" : [ {
    "id" : "user2@abc.com",
    "firstname" : "Jack",
    "lastname" : "Jill",
    "company" : "abc",
    "presence" : {
      "futurePresenceAccess" : "NONE",
      "activityAccess" : "NONE",
      "roleAccess" : "NONE",
      "noteAccess" : "NONE",
      "role" : "Business",
      "note" : "Vacation",
      "activity" : {
        "id" : "1231141551161",
        "expiration" : "NEVER",
        "available" : true
      },
      "capabilities" : [ "MESSAGE", "PARTIAL_COLLABORATION", "SMS" ]
    },
    "incall" : false,
    "inlist" : true,
    "type" : "DIRECTORY",
    "image" : 12,
    "vcard" : 113,
    "contactStatus" : "FAVORITE",
    "collaboration" : true
  } ]
}; // ContactsDTO | 
        String domain = domain_example; // String | The domain of the user accessing the API.
        String user = user_example; // String | The username of the user accessing the API.
        try {
            ContactsDTO result = apiInstance.addContacts(body, domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#addContacts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ContactsDTO *body = {
  "query" : "query",
  "contact" : [ {
    "id" : "user2@abc.com",
    "firstname" : "Jack",
    "lastname" : "Jill",
    "company" : "abc",
    "presence" : {
      "futurePresenceAccess" : "NONE",
      "activityAccess" : "NONE",
      "roleAccess" : "NONE",
      "noteAccess" : "NONE",
      "role" : "Business",
      "note" : "Vacation",
      "activity" : {
        "id" : "1231141551161",
        "expiration" : "NEVER",
        "available" : true
      },
      "capabilities" : [ "MESSAGE", "PARTIAL_COLLABORATION", "SMS" ]
    },
    "incall" : false,
    "inlist" : true,
    "type" : "DIRECTORY",
    "image" : 12,
    "vcard" : 113,
    "contactStatus" : "FAVORITE",
    "collaboration" : true
  } ]
}; // 
String *domain = domain_example; // The domain of the user accessing the API.
String *user = user_example; // The username of the user accessing the API.

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

// Add contacts
[apiInstance addContactsWith:body
    domain:domain
    user:user
              completionHandler: ^(ContactsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsApi()
var body = {
  "query" : "query",
  "contact" : [ {
    "id" : "user2@abc.com",
    "firstname" : "Jack",
    "lastname" : "Jill",
    "company" : "abc",
    "presence" : {
      "futurePresenceAccess" : "NONE",
      "activityAccess" : "NONE",
      "roleAccess" : "NONE",
      "noteAccess" : "NONE",
      "role" : "Business",
      "note" : "Vacation",
      "activity" : {
        "id" : "1231141551161",
        "expiration" : "NEVER",
        "available" : true
      },
      "capabilities" : [ "MESSAGE", "PARTIAL_COLLABORATION", "SMS" ]
    },
    "incall" : false,
    "inlist" : true,
    "type" : "DIRECTORY",
    "image" : 12,
    "vcard" : 113,
    "contactStatus" : "FAVORITE",
    "collaboration" : true
  } ]
}; // {{ContactsDTO}} 
var domain = domain_example; // {{String}} The domain of the user accessing the API.
var user = user_example; // {{String}} The username of the user accessing the API.

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

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


            var apiInstance = new ContactsApi();
            var body = new ContactsDTO(); // ContactsDTO | 
            var domain = domain_example;  // String | The domain of the user accessing the API.
            var user = user_example;  // String | The username of the user accessing the API.

            try
            {
                // Add contacts
                ContactsDTO result = apiInstance.addContacts(body, domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.addContacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsApi();
$body = {
  "query" : "query",
  "contact" : [ {
    "id" : "user2@abc.com",
    "firstname" : "Jack",
    "lastname" : "Jill",
    "company" : "abc",
    "presence" : {
      "futurePresenceAccess" : "NONE",
      "activityAccess" : "NONE",
      "roleAccess" : "NONE",
      "noteAccess" : "NONE",
      "role" : "Business",
      "note" : "Vacation",
      "activity" : {
        "id" : "1231141551161",
        "expiration" : "NEVER",
        "available" : true
      },
      "capabilities" : [ "MESSAGE", "PARTIAL_COLLABORATION", "SMS" ]
    },
    "incall" : false,
    "inlist" : true,
    "type" : "DIRECTORY",
    "image" : 12,
    "vcard" : 113,
    "contactStatus" : "FAVORITE",
    "collaboration" : true
  } ]
}; // ContactsDTO | 
$domain = domain_example; // String | The domain of the user accessing the API.
$user = user_example; // String | The username of the user accessing the API.

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


my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $body = WWW::SwaggerClient::Object::ContactsDTO->new(); # ContactsDTO | 
my $domain = domain_example; # String | The domain of the user accessing the API.
my $user = user_example; # String | The username of the user accessing the API.

eval { 
    my $result = $api_instance->addContacts(body => $body, domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->addContacts: $@\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.ContactsApi()
body = {
  "query" : "query",
  "contact" : [ {
    "id" : "user2@abc.com",
    "firstname" : "Jack",
    "lastname" : "Jill",
    "company" : "abc",
    "presence" : {
      "futurePresenceAccess" : "NONE",
      "activityAccess" : "NONE",
      "roleAccess" : "NONE",
      "noteAccess" : "NONE",
      "role" : "Business",
      "note" : "Vacation",
      "activity" : {
        "id" : "1231141551161",
        "expiration" : "NEVER",
        "available" : true
      },
      "capabilities" : [ "MESSAGE", "PARTIAL_COLLABORATION", "SMS" ]
    },
    "incall" : false,
    "inlist" : true,
    "type" : "DIRECTORY",
    "image" : 12,
    "vcard" : 113,
    "contactStatus" : "FAVORITE",
    "collaboration" : true
  } ]
} # ContactsDTO | 
domain = domain_example # String | The domain of the user accessing the API.
user = user_example # String | The username of the user accessing the API.

try: 
    # Add contacts
    api_response = api_instance.add_contacts(body, domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->addContacts: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API.
Required
user*
String
The username of the user accessing the API.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"query":"query","contact":[{"id":"user2@abc.com","firstname":"Jack","lastname":"Jill","company":"abc","presence":{"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","role":"Business","note":"Vacation","activity":{"id":"1231141551161","expiration":"NEVER","available":true},"idle":false,"available":true,"capabilities":["MESSAGE","PARTIAL_COLLABORATION","SMS"]},"incall":false,"inlist":true,"diversionAccess":"NONE","type":"DIRECTORY","image":12,"vcard":113,"contactStatus":"FAVORITE","preferredNumber":"+1231231","collaboration":true}]}
{"query":"query","contact":[{"id":"user2@abc.com","firstname":"Jack","lastname":"Jill","company":"abc","presence":{"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","role":"Business","note":"Vacation","activity":{"id":"1231141551161","expiration":"NEVER","available":true},"idle":false,"available":true,"capabilities":["MESSAGE","PARTIAL_COLLABORATION","SMS"]},"incall":false,"inlist":true,"diversionAccess":"NONE","type":"DIRECTORY","image":12,"vcard":113,"contactStatus":"FAVORITE","preferredNumber":"+1231231","collaboration":true}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteContact

Delete contact

Remove a contact from a user's contact list


/contacts/list/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/list/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

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


        ContactsApi apiInstance = new ContactsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String cid = cid_example; // String | The ID of the contact to be deleted
        try {
            apiInstance.deleteContact(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#deleteContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String cid = cid_example; // String | The ID of the contact to be deleted
        try {
            apiInstance.deleteContact(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#deleteContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API
String *cid = cid_example; // The ID of the contact to be deleted

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

// Delete contact
[apiInstance deleteContactWith:domain
    user:user
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API
var cid = cid_example; // {{String}} The ID of the contact to be deleted

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteContact(domain, user, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API
            var cid = cid_example;  // String | The ID of the contact to be deleted

            try
            {
                // Delete contact
                apiInstance.deleteContact(domain, user, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.deleteContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API
$cid = cid_example; // String | The ID of the contact to be deleted

try {
    $api_instance->deleteContact($domain, $user, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->deleteContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;


my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API
my $cid = cid_example; # String | The ID of the contact to be deleted

eval { 
    $api_instance->deleteContact(domain => $domain, user => $user, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsApi->deleteContact: $@\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.ContactsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API
cid = cid_example # String | The ID of the contact to be deleted

try: 
    # Delete contact
    api_instance.delete_contact(domain, user, cid)
except ApiException as e:
    print("Exception when calling ContactsApi->deleteContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required
cid*
String
The ID of the contact to be deleted
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getContacts

List contacts

Get a list of matching contacts for a user. By default contacts are ordered alphabetically by name. The user of the API is expected to reorder them as needed.


/contacts/list/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/list/{domain}/{user}?query=&maxResults=&dontIncludeFnrs="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

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


        ContactsApi apiInstance = new ContactsApi();
        String domain = domain_example; // String | The domain of the user accessing the API.
        String user = user_example; // String | The username of the user accessing the API.
        String query = query_example; // String | If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned.
        String maxResults = maxResults_example; // String | Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned.
        Boolean dontIncludeFnrs = true; // Boolean | Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included.
        try {
            ContactsDTO result = apiInstance.getContacts(domain, user, query, maxResults, dontIncludeFnrs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String domain = domain_example; // String | The domain of the user accessing the API.
        String user = user_example; // String | The username of the user accessing the API.
        String query = query_example; // String | If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned.
        String maxResults = maxResults_example; // String | Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned.
        Boolean dontIncludeFnrs = true; // Boolean | Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included.
        try {
            ContactsDTO result = apiInstance.getContacts(domain, user, query, maxResults, dontIncludeFnrs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContacts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API.
String *user = user_example; // The username of the user accessing the API.
String *query = query_example; // If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned. (optional)
String *maxResults = maxResults_example; // Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned. (optional)
Boolean *dontIncludeFnrs = true; // Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included. (optional)

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

// List contacts
[apiInstance getContactsWith:domain
    user:user
    query:query
    maxResults:maxResults
    dontIncludeFnrs:dontIncludeFnrs
              completionHandler: ^(ContactsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API.
var user = user_example; // {{String}} The username of the user accessing the API.
var opts = { 
  'query': query_example, // {{String}} If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned.
  'maxResults': maxResults_example, // {{String}} Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned.
  'dontIncludeFnrs': true // {{Boolean}} Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContacts(domain, user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API.
            var user = user_example;  // String | The username of the user accessing the API.
            var query = query_example;  // String | If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned. (optional) 
            var maxResults = maxResults_example;  // String | Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned. (optional) 
            var dontIncludeFnrs = true;  // Boolean | Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included. (optional) 

            try
            {
                // List contacts
                ContactsDTO result = apiInstance.getContacts(domain, user, query, maxResults, dontIncludeFnrs);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.getContacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsApi();
$domain = domain_example; // String | The domain of the user accessing the API.
$user = user_example; // String | The username of the user accessing the API.
$query = query_example; // String | If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned.
$maxResults = maxResults_example; // String | Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned.
$dontIncludeFnrs = true; // Boolean | Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included.

try {
    $result = $api_instance->getContacts($domain, $user, $query, $maxResults, $dontIncludeFnrs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->getContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;


my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API.
my $user = user_example; # String | The username of the user accessing the API.
my $query = query_example; # String | If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned.
my $maxResults = maxResults_example; # String | Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned.
my $dontIncludeFnrs = true; # Boolean | Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included.

eval { 
    my $result = $api_instance->getContacts(domain => $domain, user => $user, query => $query, maxResults => $maxResults, dontIncludeFnrs => $dontIncludeFnrs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->getContacts: $@\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.ContactsApi()
domain = domain_example # String | The domain of the user accessing the API.
user = user_example # String | The username of the user accessing the API.
query = query_example # String | If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned. (optional)
maxResults = maxResults_example # String | Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned. (optional)
dontIncludeFnrs = true # Boolean | Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included. (optional)

try: 
    # List contacts
    api_response = api_instance.get_contacts(domain, user, query=query, maxResults=maxResults, dontIncludeFnrs=dontIncludeFnrs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->getContacts: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API.
Required
user*
String
The username of the user accessing the API.
Required
Query parameters
Name Description
query
String
If stated, contacts where any word in a searchable field starts with the stated query will be returned. If not stated, only user's favourites will be returned.
maxResults
String
Limit the amount of results when searching with a provided filter. If omitted, a maximum of 25 matching contacts will be returned.
dontIncludeFnrs
Boolean
Exclude function numbers from the search result by providing this parameter with value 'true'. Otherwise, function numbers are included.

Responses

Status: 200 - OK

{"query":"query","contact":[{"id":"user1@abc.com","firstname":"Alice","lastname":"Bob","company":"abc","presence":{"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","role":"Business","note":"Example Note","activity":{"id":"1230040550060","expiration":"NEVER","available":true},"idle":false,"available":true,"capabilities":["MESSAGE","PARTIAL_COLLABORATION","SMS"]},"incall":false,"inlist":true,"diversionAccess":"NONE","type":"SHORTCUT","image":12,"vcard":168,"contactStatus":"FAVORITE","preferredNumber":"+1234567","collaboration":true}]}
{"query":"query","contact":[{"id":"user1@abc.com","firstname":"Alice","lastname":"Bob","company":"abc","presence":{"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","role":"Business","note":"Example Note","activity":{"id":"1230040550060","expiration":"NEVER","available":true},"idle":false,"available":true,"capabilities":["MESSAGE","PARTIAL_COLLABORATION","SMS"]},"incall":false,"inlist":true,"diversionAccess":"NONE","type":"SHORTCUT","image":12,"vcard":168,"contactStatus":"FAVORITE","preferredNumber":"+1234567","collaboration":true}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateContact

Add contact status

Add contact status for a user in contact list


/contacts/update/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/update/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

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


        ContactsApi apiInstance = new ContactsApi();
        ContactStatusDto body = {
  "contactStatus" : "FAVORITE"
}; // ContactStatusDto | 
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.updateContact(body, domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#updateContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        ContactStatusDto body = {
  "contactStatus" : "FAVORITE"
}; // ContactStatusDto | 
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.updateContact(body, domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#updateContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ContactStatusDto *body = {
  "contactStatus" : "FAVORITE"
}; // 
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API
String *cid = cid_example; // The ID of the contact

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

// Add contact status
[apiInstance updateContactWith:body
    domain:domain
    user:user
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsApi()
var body = {
  "contactStatus" : "FAVORITE"
}; // {{ContactStatusDto}} 
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsApi();
            var body = new ContactStatusDto(); // ContactStatusDto | 
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Add contact status
                apiInstance.updateContact(body, domain, user, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.updateContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsApi();
$body = {
  "contactStatus" : "FAVORITE"
}; // ContactStatusDto | 
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->updateContact($body, $domain, $user, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->updateContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;


my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $body = WWW::SwaggerClient::Object::ContactStatusDto->new(); # ContactStatusDto | 
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->updateContact(body => $body, domain => $domain, user => $user, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsApi->updateContact: $@\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.ContactsApi()
body = {
  "contactStatus" : "FAVORITE"
} # ContactStatusDto | 
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API
cid = cid_example # String | The ID of the contact

try: 
    # Add contact status
    api_instance.update_contact(body, domain, user, cid)
except ApiException as e:
    print("Exception when calling ContactsApi->updateContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found


ContactsInformation

getContact

Get contact

Retrieve a contact's information.


/contacts/info/{domain}/{cid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/info/{domain}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            ContactDTO result = apiInstance.getContact(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            ContactDTO result = apiInstance.getContact(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get contact
[apiInstance getContactWith:domain
    cid:cid
              completionHandler: ^(ContactDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get contact
                ContactDTO result = apiInstance.getContact(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContact(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContact: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get contact
    api_response = api_instance.get_contact(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"id":"jane@example.org","firstname":"Jane","lastname":"Doe","company":"Example organization","presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION","SMS"]},"inlist":true,"diversionAccess":"NONE","type":"SHORTCUT","vcard":15,"contactStatus":"FAVORITE","preferredNumber":"+46812345001","collaboration":true}
{"id":"john@example.org","firstname":"John","lastname":"Doe","company":"Example organization","presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION","SMS"]},"inlist":false,"diversionAccess":"NONE","type":"DIRECTORY","vcard":22,"contactStatus":"CONTACT","preferredNumber":"+46812345001","collaboration":true}

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactAvailable

Get availability

Retrieve a contact's availability. Response will be 'true' if the contact is available.


/contacts/info/{domain}/{cid}/available

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/available"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactAvailable(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactAvailable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactAvailable(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get availability
[apiInstance getContactAvailableWith:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get availability
                'String' result = apiInstance.getContactAvailable(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactAvailable(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactAvailable: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get availability
    api_response = api_instance.get_contact_available(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactAvailable: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactImage

Get image

Fetches the contact image of the specified user in an organization.


/contacts/info/{domain}/{cid}/image

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//contacts/info/{domain}/{cid}/image?ver=&prefWidth=&prefHeight="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String ver = ver_example; // String | The image version
        Integer prefWidth = 56; // Integer | Preferred width (pixels)
        Integer prefHeight = 56; // Integer | Preferred height (pixels)
        try {
            apiInstance.getContactImage(domain, cid, ver, prefWidth, prefHeight);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactImage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String ver = ver_example; // String | The image version
        Integer prefWidth = 56; // Integer | Preferred width (pixels)
        Integer prefHeight = 56; // Integer | Preferred height (pixels)
        try {
            apiInstance.getContactImage(domain, cid, ver, prefWidth, prefHeight);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *ver = ver_example; // The image version
Integer *prefWidth = 56; // Preferred width (pixels) (optional)
Integer *prefHeight = 56; // Preferred height (pixels) (optional)

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

// Get image
[apiInstance getContactImageWith:domain
    cid:cid
    ver:ver
    prefWidth:prefWidth
    prefHeight:prefHeight
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var ver = ver_example; // {{String}} The image version
var opts = { 
  'prefWidth': 56, // {{Integer}} Preferred width (pixels)
  'prefHeight': 56 // {{Integer}} Preferred height (pixels)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getContactImage(domain, cid, ver, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var ver = ver_example;  // String | The image version
            var prefWidth = 56;  // Integer | Preferred width (pixels) (optional) 
            var prefHeight = 56;  // Integer | Preferred height (pixels) (optional) 

            try
            {
                // Get image
                apiInstance.getContactImage(domain, cid, ver, prefWidth, prefHeight);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$ver = ver_example; // String | The image version
$prefWidth = 56; // Integer | Preferred width (pixels)
$prefHeight = 56; // Integer | Preferred height (pixels)

try {
    $api_instance->getContactImage($domain, $cid, $ver, $prefWidth, $prefHeight);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationApi->getContactImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $ver = ver_example; # String | The image version
my $prefWidth = 56; # Integer | Preferred width (pixels)
my $prefHeight = 56; # Integer | Preferred height (pixels)

eval { 
    $api_instance->getContactImage(domain => $domain, cid => $cid, ver => $ver, prefWidth => $prefWidth, prefHeight => $prefHeight);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactImage: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
ver = ver_example # String | The image version
prefWidth = 56 # Integer | Preferred width (pixels) (optional)
prefHeight = 56 # Integer | Preferred height (pixels) (optional)

try: 
    # Get image
    api_instance.get_contact_image(domain, cid, ver, prefWidth=prefWidth, prefHeight=prefHeight)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactImage: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Query parameters
Name Description
ver*
String
The image version
Required
prefWidth
Integer (int32)
Preferred width (pixels)
prefHeight
Integer (int32)
Preferred height (pixels)

Responses

Status: 200 - The image in JPEG format

Status: 403 - Not Authorized

Status: 404 - Domain, contact or image is not found


getContactLineState

Get call state

Retrieve a contact's call state. Response will be 'true' if the contact is in a call.


/contacts/info/{domain}/{cid}/incall

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/incall"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'Boolean' result = apiInstance.getContactLineState(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactLineState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'Boolean' result = apiInstance.getContactLineState(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactLineState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get call state
[apiInstance getContactLineStateWith:domain
    cid:cid
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get call state
                'Boolean' result = apiInstance.getContactLineState(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactLineState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactLineState(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactLineState: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get call state
    api_response = api_instance.get_contact_line_state(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactLineState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactPidf

Get presence in PIDF

Retrieve a contact's presence in PIDF format.


/contacts/info/{domain}/{cid}/presence

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/pidf+xml"\
"/api//contacts/info/{domain}/{cid}/presence"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPidf(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPidf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPidf(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPidf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get presence in PIDF
[apiInstance getContactPidfWith:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get presence in PIDF
                'String' result = apiInstance.getContactPidf(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactPidf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPidf(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactPidf: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get presence in PIDF
    api_response = api_instance.get_contact_pidf(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactPidf: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceActivity

Get activity

Retrieve a contact's activity.


/contacts/info/{domain}/{cid}/activity

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/activity"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivity(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceActivity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivity(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceActivity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get activity
[apiInstance getContactPresenceActivityWith:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get activity
                'String' result = apiInstance.getContactPresenceActivity(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactPresenceActivity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceActivity(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactPresenceActivity: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get activity
    api_response = api_instance.get_contact_presence_activity(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactPresenceActivity: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactPresenceActivityExpiration

Get activity expiration

Retrieve a contact's activity expiration. <br>The response will be presented in UTC time format, yyyy-MM-dd'T'HH:mm:ss'Z'.


/contacts/info/{domain}/{cid}/activityexpiration

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/activityexpiration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivityExpiration(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceActivityExpiration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivityExpiration(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceActivityExpiration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get activity expiration
[apiInstance getContactPresenceActivityExpirationWith:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get activity expiration
                'String' result = apiInstance.getContactPresenceActivityExpiration(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactPresenceActivityExpiration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceActivityExpiration(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactPresenceActivityExpiration: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get activity expiration
    api_response = api_instance.get_contact_presence_activity_expiration(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactPresenceActivityExpiration: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain, contact or expiration time is not found


getContactPresenceNote

Get note

Retrieve a contact's presence note.


/contacts/info/{domain}/{cid}/note

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/note"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceNote(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceNote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceNote(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceNote");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get note
[apiInstance getContactPresenceNoteWith:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get note
                'String' result = apiInstance.getContactPresenceNote(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactPresenceNote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceNote(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactPresenceNote: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get note
    api_response = api_instance.get_contact_presence_note(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactPresenceNote: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactPresencePartial

Get presence

Retrieve a contact's presence information.


/contacts/info/{domain}/{cid}/presence/partial

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/info/{domain}/{cid}/presence/partial"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PartialPresenceDTO result = apiInstance.getContactPresencePartial(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresencePartial");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PartialPresenceDTO result = apiInstance.getContactPresencePartial(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresencePartial");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get presence
[apiInstance getContactPresencePartialWith:domain
    cid:cid
              completionHandler: ^(PartialPresenceDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get presence
                PartialPresenceDTO result = apiInstance.getContactPresencePartial(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactPresencePartial: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresencePartial(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactPresencePartial: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get presence
    api_response = api_instance.get_contact_presence_partial(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactPresencePartial: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION"]},"forbidden":["role","activity","note"]}
{"presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION"]},"forbidden":["role","activity","note"]}

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceRole

Get role

Retrieve a contact's presence role.


/contacts/info/{domain}/{cid}/role

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact.
        try {
            'String' result = apiInstance.getContactPresenceRole(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact.
        try {
            'String' result = apiInstance.getContactPresenceRole(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getContactPresenceRole");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact.

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

// Get role
[apiInstance getContactPresenceRoleWith:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact.

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact.

            try
            {
                // Get role
                'String' result = apiInstance.getContactPresenceRole(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getContactPresenceRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact.

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact.

eval { 
    my $result = $api_instance->getContactPresenceRole(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getContactPresenceRole: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact.

try: 
    # Get role
    api_response = api_instance.get_contact_presence_role(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getContactPresenceRole: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact.
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactVcard

Get vCard

Retrieve a contact's vCard information.


/contacts/info/{domain}/{cid}/vcard

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/info/{domain}/{cid}/vcard?ver="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber String ver = ver_example; // String | The vCard version try { VcardDTO result = apiInstance.getContactVcard(domain, cid, ver); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#getContactVcard"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber String ver = ver_example; // String | The vCard version try { VcardDTO result = apiInstance.getContactVcard(domain, cid, ver); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#getContactVcard"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber String *ver = ver_example; // The vCard version (optional) ContactsInformationApi *apiInstance = [[ContactsInformationApi alloc] init]; // Get vCard [apiInstance getContactVcardWith:domain cid:cid ver:ver completionHandler: ^(VcardDTO output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber var opts = { 'ver': ver_example // {{String}} The vCard version }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getContactVcard(domain, cid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber var ver = ver_example; // String | The vCard version (optional) try { // Get vCard VcardDTO result = apiInstance.getContactVcard(domain, cid, ver); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationApi.getContactVcard: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber $ver = ver_example; // String | The vCard version try { $result = $api_instance->getContactVcard($domain, $cid, $ver); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationApi->getContactVcard: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber my $ver = ver_example; # String | The vCard version eval { my $result = $api_instance->getContactVcard(domain => $domain, cid => $cid, ver => $ver); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationApi->getContactVcard: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
The ID can be in 2 formats: user@domain or phonenumber ver = ver_example # String | The vCard version (optional) try: # Get vCard api_response = api_instance.get_contact_vcard(domain, cid, ver=ver) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationApi->getContactVcard: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact<br>The ID can be in 2 formats: user@domain or phonenumber
Required
Query parameters
Name Description
ver
String
The vCard version

Responses

Status: 200 - OK

{"Description":{"TEL":[{"value":"+46812345001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"}]},{"value":"5001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"},{"resource":"http://www.telepo.com/telepo-rdf/#shortnumber"}]}],"group":[{"value":"Support","parseType":"Resource"},{"value":"Technical Support","parseType":"Resource"}],"field":[{"id":"field1","value":"Field1 content"},{"id":"field2","value":"Field2 content"},{"id":"field3","value":"Field3 content"},{"id":"field4","value":"Field4 content"}],"ORG":{"parseType":"Resource","Orgname":"Example Organisation","Orgunit":"Support"},"EMAIL":{"value":"john.doe@example.org","type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#internet"},"parseType":"Resource"},"ADR":{"type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},"parseType":"Resource","Country":"Sweden","Locality":"111 11","Street":"Example Street 1","Pcode":"Stockholm"},"N":{"parseType":"Resource","Family":"Doe","Given":"John"},"FN":"John Doe"}}
{"Description":{"TEL":[{"value":"+46812345001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"}]},{"value":"5001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"},{"resource":"http://www.telepo.com/telepo-rdf/#shortnumber"}]}],"group":[{"value":"Support","parseType":"Resource"},{"value":"Technical Support","parseType":"Resource"}],"field":[{"id":"field1","value":"Field1 content"},{"id":"field2","value":"Field2 content"},{"id":"field3","value":"Field3 content"},{"id":"field4","value":"Field4 content"}],"ORG":{"parseType":"Resource","Orgname":"Example Organisation","Orgunit":"Support"},"EMAIL":{"value":"john.doe@example.org","type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#internet"},"parseType":"Resource"},"ADR":{"type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},"parseType":"Resource","Country":"Sweden","Locality":"111 11","Street":"Example Street 1","Pcode":"Stockholm"},"N":{"parseType":"Resource","Family":"Doe","Given":"John"},"FN":"John Doe"}}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getUserDirectoryFields

Get directory fields

Retrieve a contact's directory fields.


/contacts/info/{domain}/{cid}/fields

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/info/{domain}/{cid}/fields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            FieldsDTO result = apiInstance.getUserDirectoryFields(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getUserDirectoryFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            FieldsDTO result = apiInstance.getUserDirectoryFields(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#getUserDirectoryFields");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get directory fields
[apiInstance getUserDirectoryFieldsWith:domain
    cid:cid
              completionHandler: ^(FieldsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get directory fields
                FieldsDTO result = apiInstance.getUserDirectoryFields(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.getUserDirectoryFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getUserDirectoryFields(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->getUserDirectoryFields: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get directory fields
    api_response = api_instance.get_user_directory_fields(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->getUserDirectoryFields: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"field":[{"id":"field1","label":"Label1","currentValue":"Field1","editable":true},{"id":"field2","currentValue":"Field2","editable":true},{"id":"field3","label":"Field3","currentValue":"Field3","editable":true},{"id":"field4","currentValue":"Field4","editable":true}]}
{"field":[{"id":"field1","label":"Label1","currentValue":"Field1","editable":true},{"id":"field2","currentValue":"Field2","editable":true},{"id":"field3","label":"Field3","currentValue":"Field3","editable":true},{"id":"field4","currentValue":"Field4","editable":true}]}

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


setContactDirectoryFields

Set directory fields

Update a contact's directory fields.


/contacts/info/{domain}/{cid}/fields

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: */*"\
"/api//contacts/info/{domain}/{cid}/fields"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        FieldsDTO body = {
  "field" : [ {
    "id" : "field1",
    "currentValue" : "Field1",
    "requestedValue" : "Field1"
  }, {
    "id" : "field2",
    "currentValue" : "Field2",
    "requestedValue" : "Field2"
  }, {
    "id" : "field3",
    "currentValue" : "Field3",
    "requestedValue" : "Field3"
  }, {
    "id" : "field4",
    "currentValue" : "Field4",
    "requestedValue" : "Field4"
  } ]
}; // FieldsDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact.
        try {
            FieldsDTO result = apiInstance.setContactDirectoryFields(body, domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#setContactDirectoryFields");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        FieldsDTO body = {
  "field" : [ {
    "id" : "field1",
    "currentValue" : "Field1",
    "requestedValue" : "Field1"
  }, {
    "id" : "field2",
    "currentValue" : "Field2",
    "requestedValue" : "Field2"
  }, {
    "id" : "field3",
    "currentValue" : "Field3",
    "requestedValue" : "Field3"
  }, {
    "id" : "field4",
    "currentValue" : "Field4",
    "requestedValue" : "Field4"
  } ]
}; // FieldsDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact.
        try {
            FieldsDTO result = apiInstance.setContactDirectoryFields(body, domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#setContactDirectoryFields");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
FieldsDTO *body = {
  "field" : [ {
    "id" : "field1",
    "currentValue" : "Field1",
    "requestedValue" : "Field1"
  }, {
    "id" : "field2",
    "currentValue" : "Field2",
    "requestedValue" : "Field2"
  }, {
    "id" : "field3",
    "currentValue" : "Field3",
    "requestedValue" : "Field3"
  }, {
    "id" : "field4",
    "currentValue" : "Field4",
    "requestedValue" : "Field4"
  } ]
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact.

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

// Set directory fields
[apiInstance setContactDirectoryFieldsWith:body
    domain:domain
    cid:cid
              completionHandler: ^(FieldsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var body = {
  "field" : [ {
    "id" : "field1",
    "currentValue" : "Field1",
    "requestedValue" : "Field1"
  }, {
    "id" : "field2",
    "currentValue" : "Field2",
    "requestedValue" : "Field2"
  }, {
    "id" : "field3",
    "currentValue" : "Field3",
    "requestedValue" : "Field3"
  }, {
    "id" : "field4",
    "currentValue" : "Field4",
    "requestedValue" : "Field4"
  } ]
}; // {{FieldsDTO}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact.

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

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


            var apiInstance = new ContactsInformationApi();
            var body = new FieldsDTO(); // FieldsDTO | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact.

            try
            {
                // Set directory fields
                FieldsDTO result = apiInstance.setContactDirectoryFields(body, domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.setContactDirectoryFields: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$body = {
  "field" : [ {
    "id" : "field1",
    "currentValue" : "Field1",
    "requestedValue" : "Field1"
  }, {
    "id" : "field2",
    "currentValue" : "Field2",
    "requestedValue" : "Field2"
  }, {
    "id" : "field3",
    "currentValue" : "Field3",
    "requestedValue" : "Field3"
  }, {
    "id" : "field4",
    "currentValue" : "Field4",
    "requestedValue" : "Field4"
  } ]
}; // FieldsDTO | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact.

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $body = WWW::SwaggerClient::Object::FieldsDTO->new(); # FieldsDTO | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact.

eval { 
    my $result = $api_instance->setContactDirectoryFields(body => $body, domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->setContactDirectoryFields: $@\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.ContactsInformationApi()
body = {
  "field" : [ {
    "id" : "field1",
    "currentValue" : "Field1",
    "requestedValue" : "Field1"
  }, {
    "id" : "field2",
    "currentValue" : "Field2",
    "requestedValue" : "Field2"
  }, {
    "id" : "field3",
    "currentValue" : "Field3",
    "requestedValue" : "Field3"
  }, {
    "id" : "field4",
    "currentValue" : "Field4",
    "requestedValue" : "Field4"
  } ]
} # FieldsDTO | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact.

try: 
    # Set directory fields
    api_response = api_instance.set_contact_directory_fields(body, domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->setContactDirectoryFields: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - The response payload echoes the accepted update.

{"field":[{"id":"field1","currentValue":"Field1","requestedValue":"Field1"},{"id":"field2","currentValue":"Field2","requestedValue":"Field2"},{"id":"field3","currentValue":"Field3","requestedValue":"Field3"},{"id":"field4","currentValue":"Field4","requestedValue":"Field4"}]}
{"field":[{"id":"field1","currentValue":"Field1","requestedValue":"Field1"},{"id":"field2","currentValue":"Field2","requestedValue":"Field2"},{"id":"field3","currentValue":"Field3","requestedValue":"Field3"},{"id":"field4","currentValue":"Field4","requestedValue":"Field4"}]}

Status: 400 - The input is not correct, see response for details

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceActivity

Set activity

Update a contact's activity.


/contacts/info/{domain}/{cid}/activity/{activity}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/activity/{activity}?available="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String activity = activity_example; // String | The presence activity
Available values can be listed by using the Configuration API. Boolean available = true; // Boolean | The availability try { 'String' result = apiInstance.setContactPresenceActivity(domain, cid, activity, available); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#setContactPresenceActivity"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String activity = activity_example; // String | The presence activity
Available values can be listed by using the Configuration API. Boolean available = true; // Boolean | The availability try { 'String' result = apiInstance.setContactPresenceActivity(domain, cid, activity, available); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#setContactPresenceActivity"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *activity = activity_example; // The presence activity
Available values can be listed by using the Configuration API. Boolean *available = true; // The availability (optional) ContactsInformationApi *apiInstance = [[ContactsInformationApi alloc] init]; // Set activity [apiInstance setContactPresenceActivityWith:domain cid:cid activity:activity available:available completionHandler: ^('String' output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var activity = activity_example; // {{String}} The presence activity
Available values can be listed by using the Configuration API. var opts = { 'available': true // {{Boolean}} The availability }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.setContactPresenceActivity(domain, cid, activity, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var activity = activity_example;  // String | The presence activity
Available values can be listed by using the Configuration API. var available = true; // Boolean | The availability (optional) try { // Set activity 'String' result = apiInstance.setContactPresenceActivity(domain, cid, activity, available); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationApi.setContactPresenceActivity: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$activity = activity_example; // String | The presence activity
Available values can be listed by using the Configuration API. $available = true; // Boolean | The availability try { $result = $api_instance->setContactPresenceActivity($domain, $cid, $activity, $available); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationApi->setContactPresenceActivity: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $activity = activity_example; # String | The presence activity
Available values can be listed by using the Configuration API. my $available = true; # Boolean | The availability eval { my $result = $api_instance->setContactPresenceActivity(domain => $domain, cid => $cid, activity => $activity, available => $available); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationApi->setContactPresenceActivity: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
activity = activity_example # String | The presence activity
Available values can be listed by using the Configuration API. available = true # Boolean | The availability (optional) try: # Set activity api_response = api_instance.set_contact_presence_activity(domain, cid, activity, available=available) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationApi->setContactPresenceActivity: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
activity*
String
The presence activity<br>Available values can be listed by using the Configuration API.
Required
Query parameters
Name Description
available
Boolean
The availability

Responses

Status: 200 - The activity in string format

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


setContactPresenceActivityExpiration

Set activity expiration

Update a contact's activity expiration.


/contacts/info/{domain}/{cid}/activityexpiration/{expires}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/activityexpiration/{expires}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String expires = expires_example; // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { apiInstance.setContactPresenceActivityExpiration(domain, cid, expires); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#setContactPresenceActivityExpiration"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String expires = expires_example; // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { apiInstance.setContactPresenceActivityExpiration(domain, cid, expires); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#setContactPresenceActivityExpiration"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *expires = expires_example; // The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. ContactsInformationApi *apiInstance = [[ContactsInformationApi alloc] init]; // Set activity expiration [apiInstance setContactPresenceActivityExpirationWith:domain cid:cid expires:expires completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var expires = expires_example; // {{String}} The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.setContactPresenceActivityExpiration(domain, cid, expires, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var expires = expires_example;  // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { // Set activity expiration apiInstance.setContactPresenceActivityExpiration(domain, cid, expires); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationApi.setContactPresenceActivityExpiration: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$expires = expires_example; // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { $api_instance->setContactPresenceActivityExpiration($domain, $cid, $expires); } catch (Exception $e) { echo 'Exception when calling ContactsInformationApi->setContactPresenceActivityExpiration: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $expires = expires_example; # String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. eval { $api_instance->setContactPresenceActivityExpiration(domain => $domain, cid => $cid, expires => $expires); }; if ($@) { warn "Exception when calling ContactsInformationApi->setContactPresenceActivityExpiration: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
expires = expires_example # String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try: # Set activity expiration api_instance.set_contact_presence_activity_expiration(domain, cid, expires) except ApiException as e: print("Exception when calling ContactsInformationApi->setContactPresenceActivityExpiration: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
expires*
String
The activity expires string, or 'never' if the activity should not have an expiry time.<br>The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss ,for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used.
Required

Responses

Status: 200 - OK

Status: 400 - The input is not correct, see response for details

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


setContactPresenceNote

Set note

Update a contact's presence note.


/contacts/info/{domain}/{cid}/note

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//contacts/info/{domain}/{cid}/note?note="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String note = note_example; // String | The note
        try {
            apiInstance.setContactPresenceNote(domain, cid, note);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#setContactPresenceNote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String note = note_example; // String | The note
        try {
            apiInstance.setContactPresenceNote(domain, cid, note);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#setContactPresenceNote");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *note = note_example; // The note

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

// Set note
[apiInstance setContactPresenceNoteWith:domain
    cid:cid
    note:note
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var note = note_example; // {{String}} The note

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setContactPresenceNote(domain, cid, note, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var note = note_example;  // String | The note

            try
            {
                // Set note
                apiInstance.setContactPresenceNote(domain, cid, note);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.setContactPresenceNote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$note = note_example; // String | The note

try {
    $api_instance->setContactPresenceNote($domain, $cid, $note);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationApi->setContactPresenceNote: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $note = note_example; # String | The note

eval { 
    $api_instance->setContactPresenceNote(domain => $domain, cid => $cid, note => $note);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->setContactPresenceNote: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
note = note_example # String | The note

try: 
    # Set note
    api_instance.set_contact_presence_note(domain, cid, note)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->setContactPresenceNote: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Query parameters
Name Description
note*
String
The note
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


setContactPresenceRole

Set role

Set a contact's presence role.


/contacts/info/{domain}/{cid}/role/{role}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/info/{domain}/{cid}/role/{role}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String role = role_example; // String | The presence role
Available values can be listed by using the Configuration API. try { 'String' result = apiInstance.setContactPresenceRole(domain, cid, role); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#setContactPresenceRole"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String role = role_example; // String | The presence role
Available values can be listed by using the Configuration API. try { 'String' result = apiInstance.setContactPresenceRole(domain, cid, role); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#setContactPresenceRole"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *role = role_example; // The presence role
Available values can be listed by using the Configuration API. ContactsInformationApi *apiInstance = [[ContactsInformationApi alloc] init]; // Set role [apiInstance setContactPresenceRoleWith:domain cid:cid role:role completionHandler: ^('String' output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var role = role_example; // {{String}} The presence role
Available values can be listed by using the Configuration API. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.setContactPresenceRole(domain, cid, role, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var role = role_example;  // String | The presence role
Available values can be listed by using the Configuration API. try { // Set role 'String' result = apiInstance.setContactPresenceRole(domain, cid, role); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationApi.setContactPresenceRole: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$role = role_example; // String | The presence role
Available values can be listed by using the Configuration API. try { $result = $api_instance->setContactPresenceRole($domain, $cid, $role); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationApi->setContactPresenceRole: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $role = role_example; # String | The presence role
Available values can be listed by using the Configuration API. eval { my $result = $api_instance->setContactPresenceRole(domain => $domain, cid => $cid, role => $role); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationApi->setContactPresenceRole: $@\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.ContactsInformationApi()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
role = role_example # String | The presence role
Available values can be listed by using the Configuration API. try: # Set role api_response = api_instance.set_contact_presence_role(domain, cid, role) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationApi->setContactPresenceRole: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
role*
String
The presence role<br>Available values can be listed by using the Configuration API.
Required

Responses

Status: 200 - The role in a string format

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


updateContactPresence

Update presence, silent mode or PIDF

Update a contact's presence information. If the user has no permission to change particular field, it will reply with an old field, without producing forbidden error(silent mode).<br>If PIDF format is used as input, the response will be empty.


/contacts/info/{domain}/{cid}/presence

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/pidf+xml"\
"/api//contacts/info/{domain}/{cid}/presence?forcePremappedDiversion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        Presence body = {
  "activity" : {
    "id" : "meeting",
    "expiration" : "2010-10-11T05:30:00Z",
    "available" : false
  },
  "available" : false
}; // Presence | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String forcePremappedDiversion = forcePremappedDiversion_example; // String | If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. try { presence result = apiInstance.updateContactPresence(body, domain, cid, forcePremappedDiversion); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#updateContactPresence"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        Presence body = {
  "activity" : {
    "id" : "meeting",
    "expiration" : "2010-10-11T05:30:00Z",
    "available" : false
  },
  "available" : false
}; // Presence | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String forcePremappedDiversion = forcePremappedDiversion_example; // String | If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. try { presence result = apiInstance.updateContactPresence(body, domain, cid, forcePremappedDiversion); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationApi#updateContactPresence"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
Presence *body = {
  "activity" : {
    "id" : "meeting",
    "expiration" : "2010-10-11T05:30:00Z",
    "available" : false
  },
  "available" : false
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *forcePremappedDiversion = forcePremappedDiversion_example; // If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. (optional) ContactsInformationApi *apiInstance = [[ContactsInformationApi alloc] init]; // Update presence, silent mode or PIDF [apiInstance updateContactPresenceWith:body domain:domain cid:cid forcePremappedDiversion:forcePremappedDiversion completionHandler: ^(presence output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var body = {
  "activity" : {
    "id" : "meeting",
    "expiration" : "2010-10-11T05:30:00Z",
    "available" : false
  },
  "available" : false
}; // {{Presence}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'forcePremappedDiversion': forcePremappedDiversion_example // {{String}} If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.updateContactPresence(bodydomaincid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var body = new Presence(); // Presence | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var forcePremappedDiversion = forcePremappedDiversion_example;  // String | If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. (optional) try { // Update presence, silent mode or PIDF presence result = apiInstance.updateContactPresence(body, domain, cid, forcePremappedDiversion); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationApi.updateContactPresence: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$body = {
  "activity" : {
    "id" : "meeting",
    "expiration" : "2010-10-11T05:30:00Z",
    "available" : false
  },
  "available" : false
}; // Presence | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$forcePremappedDiversion = forcePremappedDiversion_example; // String | If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. try { $result = $api_instance->updateContactPresence($body, $domain, $cid, $forcePremappedDiversion); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationApi->updateContactPresence: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $body = WWW::SwaggerClient::Object::Presence->new(); # Presence | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $forcePremappedDiversion = forcePremappedDiversion_example; # String | If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. eval { my $result = $api_instance->updateContactPresence(body => $body, domain => $domain, cid => $cid, forcePremappedDiversion => $forcePremappedDiversion); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationApi->updateContactPresence: $@\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.ContactsInformationApi()
body = {
  "activity" : {
    "id" : "meeting",
    "expiration" : "2010-10-11T05:30:00Z",
    "available" : false
  },
  "available" : false
} # Presence | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
forcePremappedDiversion = forcePremappedDiversion_example # String | If set to 'true', activity diversion will override the premapped diversion.
Not applicable for update using PIDF format. (optional) try: # Update presence, silent mode or PIDF api_response = api_instance.update_contact_presence(body, domain, cid, forcePremappedDiversion=forcePremappedDiversion) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationApi->updateContactPresence: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body *
Query parameters
Name Description
forcePremappedDiversion
String
If set to 'true', activity diversion will override the premapped diversion.<br>Not applicable for update using PIDF format.

Responses

Status: 200 - OK

{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION"]}
{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION"]}

Status: 400 - The input is not correct, see response for details

Status: 403 - Not Authorized

Status: 404 - Not Found


updateContactPresencePartial

Update presence

Update the presence information for a directory contact, with information returned on which fields that failed to update. Note this is not an atomic API. The response will contain a set of fields (in forbidden tag) that were not allowed to change for a particular user. The response will also contain the new presence result. The fields that were allowed to change have their new values and the fields that was forbidden have their old value.


/contacts/info/{domain}/{cid}/presence/partial

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/info/{domain}/{cid}/presence/partial?forcePremappedDiversion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        PartialPresenceDTO body = {
  "summary" : "Unsuccessful update",
  "description" : "Unsuccessful",
  "value" : {
    "activity" : {
      "id" : "meeting",
      "expiration" : "2010-10-11T05:30:00Z",
      "available" : false
    },
    "available" : false
  }
}; // PartialPresenceDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String forcePremappedDiversion = forcePremappedDiversion_example; // String | If set to 'true', activity diversion will override the premapped diversion
        try {
            PartialPresenceDTO result = apiInstance.updateContactPresencePartial(body, domain, cid, forcePremappedDiversion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#updateContactPresencePartial");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        PartialPresenceDTO body = {
  "summary" : "Unsuccessful update",
  "description" : "Unsuccessful",
  "value" : {
    "activity" : {
      "id" : "meeting",
      "expiration" : "2010-10-11T05:30:00Z",
      "available" : false
    },
    "available" : false
  }
}; // PartialPresenceDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String forcePremappedDiversion = forcePremappedDiversion_example; // String | If set to 'true', activity diversion will override the premapped diversion
        try {
            PartialPresenceDTO result = apiInstance.updateContactPresencePartial(body, domain, cid, forcePremappedDiversion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#updateContactPresencePartial");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
PartialPresenceDTO *body = {
  "summary" : "Unsuccessful update",
  "description" : "Unsuccessful",
  "value" : {
    "activity" : {
      "id" : "meeting",
      "expiration" : "2010-10-11T05:30:00Z",
      "available" : false
    },
    "available" : false
  }
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *forcePremappedDiversion = forcePremappedDiversion_example; // If set to 'true', activity diversion will override the premapped diversion (optional)

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

// Update presence
[apiInstance updateContactPresencePartialWith:body
    domain:domain
    cid:cid
    forcePremappedDiversion:forcePremappedDiversion
              completionHandler: ^(PartialPresenceDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var body = {
  "summary" : "Unsuccessful update",
  "description" : "Unsuccessful",
  "value" : {
    "activity" : {
      "id" : "meeting",
      "expiration" : "2010-10-11T05:30:00Z",
      "available" : false
    },
    "available" : false
  }
}; // {{PartialPresenceDTO}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'forcePremappedDiversion': forcePremappedDiversion_example // {{String}} If set to 'true', activity diversion will override the premapped diversion
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateContactPresencePartial(bodydomaincid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationApi();
            var body = new PartialPresenceDTO(); // PartialPresenceDTO | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var forcePremappedDiversion = forcePremappedDiversion_example;  // String | If set to 'true', activity diversion will override the premapped diversion (optional) 

            try
            {
                // Update presence
                PartialPresenceDTO result = apiInstance.updateContactPresencePartial(body, domain, cid, forcePremappedDiversion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.updateContactPresencePartial: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$body = {
  "summary" : "Unsuccessful update",
  "description" : "Unsuccessful",
  "value" : {
    "activity" : {
      "id" : "meeting",
      "expiration" : "2010-10-11T05:30:00Z",
      "available" : false
    },
    "available" : false
  }
}; // PartialPresenceDTO | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$forcePremappedDiversion = forcePremappedDiversion_example; // String | If set to 'true', activity diversion will override the premapped diversion

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


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $body = WWW::SwaggerClient::Object::PartialPresenceDTO->new(); # PartialPresenceDTO | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $forcePremappedDiversion = forcePremappedDiversion_example; # String | If set to 'true', activity diversion will override the premapped diversion

eval { 
    my $result = $api_instance->updateContactPresencePartial(body => $body, domain => $domain, cid => $cid, forcePremappedDiversion => $forcePremappedDiversion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->updateContactPresencePartial: $@\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.ContactsInformationApi()
body = {
  "summary" : "Unsuccessful update",
  "description" : "Unsuccessful",
  "value" : {
    "activity" : {
      "id" : "meeting",
      "expiration" : "2010-10-11T05:30:00Z",
      "available" : false
    },
    "available" : false
  }
} # PartialPresenceDTO | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
forcePremappedDiversion = forcePremappedDiversion_example # String | If set to 'true', activity diversion will override the premapped diversion (optional)

try: 
    # Update presence
    api_response = api_instance.update_contact_presence_partial(body, domain, cid, forcePremappedDiversion=forcePremappedDiversion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->updateContactPresencePartial: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body *
Query parameters
Name Description
forcePremappedDiversion
String
If set to 'true', activity diversion will override the premapped diversion

Responses

Status: 200 - OK

{"presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION"]},"forbidden":["role","activity","note"]}
{"presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION"]},"forbidden":["role","activity","note"]}

Status: 400 - The input is not correct, see response for details

Status: 403 - Not Authorized

Status: 404 - Not Found


updateContactVcard

Update vCard

Update a contact's vCard information.


/contacts/info/{domain}/{cid}/vcard

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/info/{domain}/{cid}/vcard"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationApi;

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

public class ContactsInformationApiExample {

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


        ContactsInformationApi apiInstance = new ContactsInformationApi();
        VcardDTO body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // VcardDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.updateContactVcard(body, domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#updateContactVcard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationApi;

public class ContactsInformationApiExample {

    public static void main(String[] args) {
        ContactsInformationApi apiInstance = new ContactsInformationApi();
        VcardDTO body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // VcardDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.updateContactVcard(body, domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationApi#updateContactVcard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
VcardDTO *body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Update vCard
[apiInstance updateContactVcardWith:body
    domain:domain
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationApi()
var body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // {{VcardDTO}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationApi();
            var body = new VcardDTO(); // VcardDTO | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Update vCard
                apiInstance.updateContactVcard(body, domain, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationApi.updateContactVcard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationApi();
$body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // VcardDTO | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->updateContactVcard($body, $domain, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationApi->updateContactVcard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationApi;


my $api_instance = WWW::SwaggerClient::ContactsInformationApi->new();
my $body = WWW::SwaggerClient::Object::VcardDTO->new(); # VcardDTO | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->updateContactVcard(body => $body, domain => $domain, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsInformationApi->updateContactVcard: $@\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.ContactsInformationApi()
body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
} # VcardDTO | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Update vCard
    api_instance.update_contact_vcard(body, domain, cid)
except ApiException as e:
    print("Exception when calling ContactsInformationApi->updateContactVcard: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - The input is not correct, see response for details

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


ContactsInformationV1

addContactPresence

Add scheduled presence

Add scheduled presence change for a contact.


/contacts/v1/info/{domain}/{cid}/presence

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/presence"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        ScheduledPresenceDTO body = {
  "role" : "business",
  "note" : "Coffee time",
  "activity" : "out_of_office",
  "priority" : 0,
  "name" : "Coffe break",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-01-10T14:30:00Z",
  "dt-end" : "2021-01-10T14:45:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // ScheduledPresenceDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            ScheduledPresenceDTO result = apiInstance.addContactPresence(body, domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#addContactPresence");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        ScheduledPresenceDTO body = {
  "role" : "business",
  "note" : "Coffee time",
  "activity" : "out_of_office",
  "priority" : 0,
  "name" : "Coffe break",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-01-10T14:30:00Z",
  "dt-end" : "2021-01-10T14:45:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // ScheduledPresenceDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            ScheduledPresenceDTO result = apiInstance.addContactPresence(body, domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#addContactPresence");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ScheduledPresenceDTO *body = {
  "role" : "business",
  "note" : "Coffee time",
  "activity" : "out_of_office",
  "priority" : 0,
  "name" : "Coffe break",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-01-10T14:30:00Z",
  "dt-end" : "2021-01-10T14:45:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Add scheduled presence
[apiInstance addContactPresenceWith:body
    domain:domain
    cid:cid
              completionHandler: ^(ScheduledPresenceDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var body = {
  "role" : "business",
  "note" : "Coffee time",
  "activity" : "out_of_office",
  "priority" : 0,
  "name" : "Coffe break",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-01-10T14:30:00Z",
  "dt-end" : "2021-01-10T14:45:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // {{ScheduledPresenceDTO}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var body = new ScheduledPresenceDTO(); // ScheduledPresenceDTO | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Add scheduled presence
                ScheduledPresenceDTO result = apiInstance.addContactPresence(body, domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.addContactPresence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$body = {
  "role" : "business",
  "note" : "Coffee time",
  "activity" : "out_of_office",
  "priority" : 0,
  "name" : "Coffe break",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-01-10T14:30:00Z",
  "dt-end" : "2021-01-10T14:45:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // ScheduledPresenceDTO | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $body = WWW::SwaggerClient::Object::ScheduledPresenceDTO->new(); # ScheduledPresenceDTO | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->addContactPresence(body => $body, domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->addContactPresence: $@\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.ContactsInformationV1Api()
body = {
  "role" : "business",
  "note" : "Coffee time",
  "activity" : "out_of_office",
  "priority" : 0,
  "name" : "Coffe break",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-01-10T14:30:00Z",
  "dt-end" : "2021-01-10T14:45:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
} # ScheduledPresenceDTO | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Add scheduled presence
    api_response = api_instance.add_contact_presence(body, domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->addContactPresence: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"role":"business","note":"Coffee time","presenceId":"4","activity":"out_of_office","priority":0,"name":"Coffe break","source":"INTERNAL","modifiable":true,"deleted":false,"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","dt-start":"2021-01-10T14:30:00Z","dt-end":"2021-01-10T14:45:00Z","tzid":"Europe/Stockholm","recur":{"freq":"WEEKLY","byday":"MO,TU,WE,TH"}}
{"role":"business","note":"Coffee time","presenceId":"4","activity":"out_of_office","priority":0,"name":"Coffe break","source":"INTERNAL","modifiable":true,"deleted":false,"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","dt-start":"2021-01-10T14:30:00Z","dt-end":"2021-01-10T14:45:00Z","tzid":"Europe/Stockholm","recur":{"freq":"WEEKLY","byday":"MO,TU,WE,TH"}}

Status: 400 - Not Found


deleteScheduledPresence

Delete scheduled presence

Remove a contact's scheduled presence change.


/contacts/v1/info/{domain}/{cid}/presence/{presenceId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/presence/{presenceId}?startDate=&untilDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
        String startDate = startDate_example; // String | Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z
        String untilDate = untilDate_example; // String | Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z
        try {
            apiInstance.deleteScheduledPresence(domain, cid, presenceId, startDate, untilDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#deleteScheduledPresence");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
        String startDate = startDate_example; // String | Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z
        String untilDate = untilDate_example; // String | Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z
        try {
            apiInstance.deleteScheduledPresence(domain, cid, presenceId, startDate, untilDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#deleteScheduledPresence");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *presenceId = presenceId_example; // The presence ID that identifies scheduled presence
String *startDate = startDate_example; // Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z (optional)
String *untilDate = untilDate_example; // Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z (optional)

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

// Delete scheduled presence
[apiInstance deleteScheduledPresenceWith:domain
    cid:cid
    presenceId:presenceId
    startDate:startDate
    untilDate:untilDate
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var presenceId = presenceId_example; // {{String}} The presence ID that identifies scheduled presence
var opts = { 
  'startDate': startDate_example, // {{String}} Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z
  'untilDate': untilDate_example // {{String}} Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteScheduledPresence(domain, cid, presenceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var presenceId = presenceId_example;  // String | The presence ID that identifies scheduled presence
            var startDate = startDate_example;  // String | Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z (optional) 
            var untilDate = untilDate_example;  // String | Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z (optional) 

            try
            {
                // Delete scheduled presence
                apiInstance.deleteScheduledPresence(domain, cid, presenceId, startDate, untilDate);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.deleteScheduledPresence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
$startDate = startDate_example; // String | Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z
$untilDate = untilDate_example; // String | Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z

try {
    $api_instance->deleteScheduledPresence($domain, $cid, $presenceId, $startDate, $untilDate);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->deleteScheduledPresence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $presenceId = presenceId_example; # String | The presence ID that identifies scheduled presence
my $startDate = startDate_example; # String | Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z
my $untilDate = untilDate_example; # String | Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z

eval { 
    $api_instance->deleteScheduledPresence(domain => $domain, cid => $cid, presenceId => $presenceId, startDate => $startDate, untilDate => $untilDate);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->deleteScheduledPresence: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
presenceId = presenceId_example # String | The presence ID that identifies scheduled presence
startDate = startDate_example # String | Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z (optional)
untilDate = untilDate_example # String | Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z (optional)

try: 
    # Delete scheduled presence
    api_instance.delete_scheduled_presence(domain, cid, presenceId, startDate=startDate, untilDate=untilDate)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->deleteScheduledPresence: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
presenceId*
String
The presence ID that identifies scheduled presence
Required
Query parameters
Name Description
startDate
String
Delete from date in UTC format. Eg. 2020-04-01T00:00:00Z
untilDate
String
Delete to date in UTC format. Eg. 2020-05-01T00:00:00Z

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getContact1

Get contact

Retrieve a contact's information.


/contacts/v1/info/{domain}/{cid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            ContactDTO result = apiInstance.getContact1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContact1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            ContactDTO result = apiInstance.getContact1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContact1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get contact
[apiInstance getContact1With:domain
    cid:cid
              completionHandler: ^(ContactDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get contact
                ContactDTO result = apiInstance.getContact1(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContact1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContact1(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContact1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get contact
    api_response = api_instance.get_contact1(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContact1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"id":"jane@example.org","firstname":"Jane","lastname":"Doe","company":"Example organization","presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION","SMS"]},"inlist":true,"diversionAccess":"NONE","type":"SHORTCUT","vcard":15,"contactStatus":"FAVORITE","preferredNumber":"+46812345001","collaboration":true}
{"id":"john@example.org","firstname":"John","lastname":"Doe","company":"Example organization","presence":{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","capabilities":["FULL_COLLABORATION","SMS"]},"inlist":false,"diversionAccess":"NONE","type":"DIRECTORY","vcard":22,"contactStatus":"CONTACT","preferredNumber":"+46812345001","collaboration":true}

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactAvailable1

Get availability

Retrieve a contact's availability.


/contacts/v1/info/{domain}/{cid}/available

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//contacts/v1/info/{domain}/{cid}/available"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.getContactAvailable1(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactAvailable1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.getContactAvailable1(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactAvailable1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get availability
[apiInstance getContactAvailable1With:domain
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getContactAvailable1(domain, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get availability
                apiInstance.getContactAvailable1(domain, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactAvailable1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->getContactAvailable1($domain, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->getContactAvailable1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->getContactAvailable1(domain => $domain, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactAvailable1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get availability
    api_instance.get_contact_available1(domain, cid)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactAvailable1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - Returns true if the contact is available

Status: 403 - Not Authorized

Status: 404 - Organization does not exist


getContactImage1

Get image

Retrieve a contact's image.


/contacts/v1/info/{domain}/{cid}/image

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//contacts/v1/info/{domain}/{cid}/image?ver=&prefWidth=&prefHeight="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String ver = ver_example; // String | The image version
        Integer prefWidth = 56; // Integer | Preferred width (pixels)
        Integer prefHeight = 56; // Integer | Preferred height (pixels)
        try {
            apiInstance.getContactImage1(domain, cid, ver, prefWidth, prefHeight);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactImage1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String ver = ver_example; // String | The image version
        Integer prefWidth = 56; // Integer | Preferred width (pixels)
        Integer prefHeight = 56; // Integer | Preferred height (pixels)
        try {
            apiInstance.getContactImage1(domain, cid, ver, prefWidth, prefHeight);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactImage1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *ver = ver_example; // The image version
Integer *prefWidth = 56; // Preferred width (pixels) (optional)
Integer *prefHeight = 56; // Preferred height (pixels) (optional)

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

// Get image
[apiInstance getContactImage1With:domain
    cid:cid
    ver:ver
    prefWidth:prefWidth
    prefHeight:prefHeight
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var ver = ver_example; // {{String}} The image version
var opts = { 
  'prefWidth': 56, // {{Integer}} Preferred width (pixels)
  'prefHeight': 56 // {{Integer}} Preferred height (pixels)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getContactImage1(domain, cid, ver, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var ver = ver_example;  // String | The image version
            var prefWidth = 56;  // Integer | Preferred width (pixels) (optional) 
            var prefHeight = 56;  // Integer | Preferred height (pixels) (optional) 

            try
            {
                // Get image
                apiInstance.getContactImage1(domain, cid, ver, prefWidth, prefHeight);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactImage1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$ver = ver_example; // String | The image version
$prefWidth = 56; // Integer | Preferred width (pixels)
$prefHeight = 56; // Integer | Preferred height (pixels)

try {
    $api_instance->getContactImage1($domain, $cid, $ver, $prefWidth, $prefHeight);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->getContactImage1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $ver = ver_example; # String | The image version
my $prefWidth = 56; # Integer | Preferred width (pixels)
my $prefHeight = 56; # Integer | Preferred height (pixels)

eval { 
    $api_instance->getContactImage1(domain => $domain, cid => $cid, ver => $ver, prefWidth => $prefWidth, prefHeight => $prefHeight);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactImage1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
ver = ver_example # String | The image version
prefWidth = 56 # Integer | Preferred width (pixels) (optional)
prefHeight = 56 # Integer | Preferred height (pixels) (optional)

try: 
    # Get image
    api_instance.get_contact_image1(domain, cid, ver, prefWidth=prefWidth, prefHeight=prefHeight)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactImage1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Query parameters
Name Description
ver*
String
The image version
Required
prefWidth
Integer (int32)
Preferred width (pixels)
prefHeight
Integer (int32)
Preferred height (pixels)

Responses

Status: 200 - The image in jpeg format

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactLineState1

Get line state

Retrieve a contact's line state.


/contacts/v1/info/{domain}/{cid}/incall

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/incall"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the user accessing the API
        String cid = cid_example; // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
        try {
            'Boolean' result = apiInstance.getContactLineState1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactLineState1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the user accessing the API
        String cid = cid_example; // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
        try {
            'Boolean' result = apiInstance.getContactLineState1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactLineState1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *cid = cid_example; // The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state

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

// Get line state
[apiInstance getContactLineState1With:domain
    cid:cid
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var cid = cid_example; // {{String}} The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var cid = cid_example;  // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state

            try
            {
                // Get line state
                'Boolean' result = apiInstance.getContactLineState1(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactLineState1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the user accessing the API
$cid = cid_example; // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $cid = cid_example; # String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state

eval { 
    my $result = $api_instance->getContactLineState1(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactLineState1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the user accessing the API
cid = cid_example # String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state

try: 
    # Get line state
    api_response = api_instance.get_contact_line_state1(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactLineState1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
cid*
String
The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresence

Get presence

Retrieve a contact's presence information, either as structure or in 'application/pidf+xml' format, see RFC3863/RFC4480/4481/RFC4482.<br>When fetching information in PIDF format, only domain and cid shall be used as input parameters.


/contacts/v1/info/{domain}/{cid}/presence

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/pidf+xml,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/presence?startDate=&endDate=&expandRecurrence=&eventType=&cachedCalendar="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String startDate = startDate_example; // String | Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now.
        String endDate = endDate_example; // String | End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate.
        String expandRecurrence = expandRecurrence_example; // String | If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false.
        String eventType = eventType_example; // String | The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. Boolean cachedCalendar = true; // Boolean | Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. try { ScheduledPresencesDTO result = apiInstance.getContactPresence(domain, cid, startDate, endDate, expandRecurrence, eventType, cachedCalendar); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#getContactPresence"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String startDate = startDate_example; // String | Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now.
        String endDate = endDate_example; // String | End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate.
        String expandRecurrence = expandRecurrence_example; // String | If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false.
        String eventType = eventType_example; // String | The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. Boolean cachedCalendar = true; // Boolean | Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. try { ScheduledPresencesDTO result = apiInstance.getContactPresence(domain, cid, startDate, endDate, expandRecurrence, eventType, cachedCalendar); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#getContactPresence"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *startDate = startDate_example; // Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now. (optional)
String *endDate = endDate_example; // End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate. (optional)
String *expandRecurrence = expandRecurrence_example; // If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false. (optional)
String *eventType = eventType_example; // The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. (optional) Boolean *cachedCalendar = true; // Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. (optional) ContactsInformationV1Api *apiInstance = [[ContactsInformationV1Api alloc] init]; // Get presence [apiInstance getContactPresenceWith:domain cid:cid startDate:startDate endDate:endDate expandRecurrence:expandRecurrence eventType:eventType cachedCalendar:cachedCalendar completionHandler: ^(ScheduledPresencesDTO output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'startDate': startDate_example, // {{String}} Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now.
  'endDate': endDate_example, // {{String}} End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate.
  'expandRecurrence': expandRecurrence_example, // {{String}} If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false.
  'eventType': eventType_example, // {{String}} The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. 'cachedCalendar': true // {{Boolean}} Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getContactPresence(domain, cid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var startDate = startDate_example;  // String | Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now. (optional) 
            var endDate = endDate_example;  // String | End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate. (optional) 
            var expandRecurrence = expandRecurrence_example;  // String | If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false. (optional) 
            var eventType = eventType_example;  // String | The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. (optional) var cachedCalendar = true; // Boolean | Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. (optional) try { // Get presence ScheduledPresencesDTO result = apiInstance.getContactPresence(domain, cid, startDate, endDate, expandRecurrence, eventType, cachedCalendar); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationV1Api.getContactPresence: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$startDate = startDate_example; // String | Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now.
$endDate = endDate_example; // String | End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate.
$expandRecurrence = expandRecurrence_example; // String | If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false.
$eventType = eventType_example; // String | The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. $cachedCalendar = true; // Boolean | Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. try { $result = $api_instance->getContactPresence($domain, $cid, $startDate, $endDate, $expandRecurrence, $eventType, $cachedCalendar); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationV1Api->getContactPresence: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $startDate = startDate_example; # String | Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now.
my $endDate = endDate_example; # String | End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate.
my $expandRecurrence = expandRecurrence_example; # String | If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false.
my $eventType = eventType_example; # String | The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. my $cachedCalendar = true; # Boolean | Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. eval { my $result = $api_instance->getContactPresence(domain => $domain, cid => $cid, startDate => $startDate, endDate => $endDate, expandRecurrence => $expandRecurrence, eventType => $eventType, cachedCalendar => $cachedCalendar); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationV1Api->getContactPresence: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
startDate = startDate_example # String | Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now. (optional)
endDate = endDate_example # String | End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate. (optional)
expandRecurrence = expandRecurrence_example # String | If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false. (optional)
eventType = eventType_example # String | The type of events that should be included in the result. Valid values are:
PRESENCE - Scheduled presences including synchronized presences from external calendar.
CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.
ALL - Both schedule presences and all synchronized external calendar events.
If eventType is not set, it will default to PRESENCE. (optional) cachedCalendar = true # Boolean | Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false. (optional) try: # Get presence api_response = api_instance.get_contact_presence(domain, cid, startDate=startDate, endDate=endDate, expandRecurrence=expandRecurrence, eventType=eventType, cachedCalendar=cachedCalendar) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationV1Api->getContactPresence: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Query parameters
Name Description
startDate
String
Start date in UTC format. Eg. 2020-04-01T00:00:00Z. If startDate is not used, it will be set to now.
endDate
String
End date in UTC format. Eg. 2020-05-01T00:00:00Z. If endDate is not used, it will be set to 24 hours from startDate.
expandRecurrence
String
If set to true, the recurrence data should be expanded in the response. If expandRecurrence is not set, it will default to false.
eventType
String
The type of events that should be included in the result. Valid values are:<br> PRESENCE - Scheduled presences including synchronized presences from external calendar.<br> CALENDAR - External calendar events, both events mapped to schedule presences and other synchronized events.<br> ALL - Both schedule presences and all synchronized external calendar events.<br>If eventType is not set, it will default to PRESENCE.
cachedCalendar
Boolean
Fetch only synchronized calendar events when value is true, i.e. the response will only contain events that are within 24 hours. If cachedCalendar is not set, it will default to false.

Responses

Status: 200 - OK

{"presence":[{"role":"business","note":"Daily standup","presenceId":"3","activity":"meeting","priority":0,"name":"Standup meeting","source":"INTERNAL","modifiable":true,"deleted":false,"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","dt-start":"2021-02-01T08:30:00Z","dt-end":"2021-02-01T09:00:00Z","tzid":"Europe/Stockholm","instances":[{"deleted":false,"dt-start":"2021-02-01T08:30:00Z","dt-end":"2021-02-01T09:00:00Z","instanceId":"1612168200000"},{"deleted":false,"dt-start":"2021-02-02T08:30:00Z","dt-end":"2021-02-02T09:00:00Z","instanceId":"1612254600000"}],"recur":{"freq":"WEEKLY","byday":"MO,TU,WE,TH"}},{"role":"business","note":"Lunch","presenceId":"1","activity":"lunch","priority":0,"name":"Lunch","source":"INTERNAL","modifiable":true,"deleted":false,"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","dt-start":"2021-01-10T11:00:00Z","dt-end":"2021-01-10T12:00:00Z","tzid":"Europe/Stockholm","instances":[{"deleted":false,"dt-start":"2021-02-01T11:00:00Z","dt-end":"2021-02-01T12:00:00Z","instanceId":"1612341000000"},{"deleted":false,"dt-start":"2021-02-02T11:00:00Z","dt-end":"2021-02-02T12:00:00Z","instanceId":"1612427400000"}],"recur":{"until":"2021-02-14T23:00:00Z","freq":"DAILY"}}],"calendar-sync-status":"calendar-sync-not-enabled"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceActivity1

Get activity

Retrieve a contact's activity.


/contacts/v1/info/{domain}/{cid}/activity

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/activity"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivity1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceActivity1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivity1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceActivity1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get activity
[apiInstance getContactPresenceActivity1With:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get activity
                'String' result = apiInstance.getContactPresenceActivity1(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactPresenceActivity1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceActivity1(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactPresenceActivity1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get activity
    api_response = api_instance.get_contact_presence_activity1(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactPresenceActivity1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - The result in string format

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactPresenceActivityExpiration1

Get activity expiration

To read a contact's activity expiration.


/contacts/v1/info/{domain}/{cid}/activityexpiration

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/activityexpiration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivityExpiration1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceActivityExpiration1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceActivityExpiration1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceActivityExpiration1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get activity expiration
[apiInstance getContactPresenceActivityExpiration1With:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get activity expiration
                'String' result = apiInstance.getContactPresenceActivityExpiration1(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactPresenceActivityExpiration1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceActivityExpiration1(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactPresenceActivityExpiration1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get activity expiration
    api_response = api_instance.get_contact_presence_activity_expiration1(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactPresenceActivityExpiration1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - The activity expiration in string format

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactPresenceById

Get scheduled presence

Retrieve a specific scheduled presence change for a contact.


/contacts/v1/info/{domain}/{cid}/presence/{presenceId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/presence/{presenceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
        try {
            ScheduledPresenceDTO result = apiInstance.getContactPresenceById(domain, cid, presenceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
        try {
            ScheduledPresenceDTO result = apiInstance.getContactPresenceById(domain, cid, presenceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *presenceId = presenceId_example; // The presence ID that identifies scheduled presence

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

// Get scheduled presence
[apiInstance getContactPresenceByIdWith:domain
    cid:cid
    presenceId:presenceId
              completionHandler: ^(ScheduledPresenceDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var presenceId = presenceId_example; // {{String}} The presence ID that identifies scheduled presence

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var presenceId = presenceId_example;  // String | The presence ID that identifies scheduled presence

            try
            {
                // Get scheduled presence
                ScheduledPresenceDTO result = apiInstance.getContactPresenceById(domain, cid, presenceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactPresenceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence

try {
    $result = $api_instance->getContactPresenceById($domain, $cid, $presenceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->getContactPresenceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $presenceId = presenceId_example; # String | The presence ID that identifies scheduled presence

eval { 
    my $result = $api_instance->getContactPresenceById(domain => $domain, cid => $cid, presenceId => $presenceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactPresenceById: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
presenceId = presenceId_example # String | The presence ID that identifies scheduled presence

try: 
    # Get scheduled presence
    api_response = api_instance.get_contact_presence_by_id(domain, cid, presenceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactPresenceById: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
presenceId*
String
The presence ID that identifies scheduled presence
Required

Responses

Status: 200 - OK

{"role":"business","note":"Daily standup","presenceId":"3","activity":"meeting","priority":0,"name":"Standup meeting","source":"INTERNAL","modifiable":true,"deleted":false,"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","dt-start":"2021-02-01T08:30:00Z","dt-end":"2021-02-01T09:00:00Z","tzid":"Europe/Stockholm","recur":{"freq":"WEEKLY","byday":"MO,TU,WE,TH"}}
{"role":"business","note":"Daily standup","presenceId":"3","activity":"meeting","priority":0,"name":"Standup meeting","source":"INTERNAL","modifiable":true,"deleted":false,"futurePresenceAccess":"WRITE","activityAccess":"WRITE","roleAccess":"WRITE","noteAccess":"WRITE","dt-start":"2021-02-01T08:30:00Z","dt-end":"2021-02-01T09:00:00Z","tzid":"Europe/Stockholm","recur":{"freq":"WEEKLY","byday":"MO,TU,WE,TH"}}

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceNote1

Get note

Get a contact's presence note.


/contacts/v1/info/{domain}/{cid}/note

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/note"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceNote1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceNote1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceNote1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceNote1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get note
[apiInstance getContactPresenceNote1With:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get note
                'String' result = apiInstance.getContactPresenceNote1(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactPresenceNote1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceNote1(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactPresenceNote1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get note
    api_response = api_instance.get_contact_presence_note1(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactPresenceNote1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - The note in string format

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceRole1

Get role

Retrieve a contact's presence role.


/contacts/v1/info/{domain}/{cid}/role

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceRole1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceRole1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            'String' result = apiInstance.getContactPresenceRole1(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactPresenceRole1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Get role
[apiInstance getContactPresenceRole1With:domain
    cid:cid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get role
                'String' result = apiInstance.getContactPresenceRole1(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactPresenceRole1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getContactPresenceRole1(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactPresenceRole1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get role
    api_response = api_instance.get_contact_presence_role1(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactPresenceRole1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - The role in string format

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


getContactVcard1

Get vCard

To read a contact's vCard information.


/contacts/v1/info/{domain}/{cid}/vcard

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/vcard?ver="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
        String ver = ver_example; // String | The vCard version
        try {
            VcardDTO result = apiInstance.getContactVcard1(domain, cid, ver);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactVcard1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
        String ver = ver_example; // String | The vCard version
        try {
            VcardDTO result = apiInstance.getContactVcard1(domain, cid, ver);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getContactVcard1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
String *ver = ver_example; // The vCard version (optional)

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

// Get vCard
[apiInstance getContactVcard1With:domain
    cid:cid
    ver:ver
              completionHandler: ^(VcardDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
var opts = { 
  'ver': ver_example // {{String}} The vCard version
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactVcard1(domain, cid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
            var ver = ver_example;  // String | The vCard version (optional) 

            try
            {
                // Get vCard
                VcardDTO result = apiInstance.getContactVcard1(domain, cid, ver);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getContactVcard1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
$ver = ver_example; // String | The vCard version

try {
    $result = $api_instance->getContactVcard1($domain, $cid, $ver);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->getContactVcard1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
my $ver = ver_example; # String | The vCard version

eval { 
    my $result = $api_instance->getContactVcard1(domain => $domain, cid => $cid, ver => $ver);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getContactVcard1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
ver = ver_example # String | The vCard version (optional)

try: 
    # Get vCard
    api_response = api_instance.get_contact_vcard1(domain, cid, ver=ver)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getContactVcard1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact. The ID can be in 2 formats: user@domain or phonenumber
Required
Query parameters
Name Description
ver
String
The vCard version

Responses

Status: 200 - OK

{"Description":{"TEL":[{"value":"+46812345001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"}]},{"value":"5001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"},{"resource":"http://www.telepo.com/telepo-rdf/#shortnumber"}]}],"group":[{"value":"Support","parseType":"Resource"},{"value":"Technical Support","parseType":"Resource"}],"field":[{"id":"field1","value":"Field1 content"},{"id":"field2","value":"Field2 content"},{"id":"field3","value":"Field3 content"},{"id":"field4","value":"Field4 content"}],"ORG":{"parseType":"Resource","Orgname":"Example Organisation","Orgunit":"Support"},"EMAIL":{"value":"john.doe@example.org","type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#internet"},"parseType":"Resource"},"ADR":{"type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},"parseType":"Resource","Country":"Sweden","Locality":"111 11","Street":"Example Street 1","Pcode":"Stockholm"},"N":{"parseType":"Resource","Family":"Doe","Given":"John"},"FN":"John Doe"}}
{"Description":{"TEL":[{"value":"+46812345001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"}]},{"value":"5001","parseType":"Resource","type":[{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#voice"},{"resource":"http://www.telepo.com/telepo-rdf/#shortnumber"}]}],"group":[{"value":"Support","parseType":"Resource"},{"value":"Technical Support","parseType":"Resource"}],"field":[{"id":"field1","value":"Field1 content"},{"id":"field2","value":"Field2 content"},{"id":"field3","value":"Field3 content"},{"id":"field4","value":"Field4 content"}],"ORG":{"parseType":"Resource","Orgname":"Example Organisation","Orgunit":"Support"},"EMAIL":{"value":"john.doe@example.org","type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#internet"},"parseType":"Resource"},"ADR":{"type":{"resource":"http://www.w3.org/2001/vcard-rdf/3.0#work"},"parseType":"Resource","Country":"Sweden","Locality":"111 11","Street":"Example Street 1","Pcode":"Stockholm"},"N":{"parseType":"Resource","Family":"Doe","Given":"John"},"FN":"John Doe"}}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getNumberFromExternalLookup

External number lookup

Do a number lookup in an external directory.


/contacts/v1/info/{domain}/{number}/externallookup

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//contacts/v1/info/{domain}/{number}/externallookup"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the organization in which the request is made
        String number = number_example; // String | The number to look up in the external directory
        try {
            JCardDto result = apiInstance.getNumberFromExternalLookup(domain, number);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getNumberFromExternalLookup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the organization in which the request is made
        String number = number_example; // String | The number to look up in the external directory
        try {
            JCardDto result = apiInstance.getNumberFromExternalLookup(domain, number);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getNumberFromExternalLookup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization in which the request is made
String *number = number_example; // The number to look up in the external directory

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

// External number lookup
[apiInstance getNumberFromExternalLookupWith:domain
    number:number
              completionHandler: ^(JCardDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the organization in which the request is made
var number = number_example; // {{String}} The number to look up in the external directory

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

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the organization in which the request is made
            var number = number_example;  // String | The number to look up in the external directory

            try
            {
                // External number lookup
                JCardDto result = apiInstance.getNumberFromExternalLookup(domain, number);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getNumberFromExternalLookup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the organization in which the request is made
$number = number_example; // String | The number to look up in the external directory

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the organization in which the request is made
my $number = number_example; # String | The number to look up in the external directory

eval { 
    my $result = $api_instance->getNumberFromExternalLookup(domain => $domain, number => $number);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getNumberFromExternalLookup: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the organization in which the request is made
number = number_example # String | The number to look up in the external directory

try: 
    # External number lookup
    api_response = api_instance.get_number_from_external_lookup(domain, number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getNumberFromExternalLookup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization in which the request is made
Required
number*
String
The number to look up in the external directory
Required

Responses

Status: 200 - OK

{"name":"Jane Doe"}

Status: 403 - Not Authorized

Status: 404 - Organization does not exist


getTimeZones

List time zones

List the supported time zone ID values and their offset values


/contacts/v1/info/timezones

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//contacts/v1/info/timezones?when=&tzid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String when = when_example; // String | Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z
        String tzid = tzid_example; // String | Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted.
        try {
            TimeZonesDTO result = apiInstance.getTimeZones(when, tzid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getTimeZones");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String when = when_example; // String | Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z
        String tzid = tzid_example; // String | Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted.
        try {
            TimeZonesDTO result = apiInstance.getTimeZones(when, tzid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#getTimeZones");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *when = when_example; // Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z (optional)
String *tzid = tzid_example; // Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted. (optional)

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

// List time zones
[apiInstance getTimeZonesWith:when
    tzid:tzid
              completionHandler: ^(TimeZonesDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var opts = { 
  'when': when_example, // {{String}} Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z
  'tzid': tzid_example // {{String}} Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTimeZones(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var when = when_example;  // String | Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z (optional) 
            var tzid = tzid_example;  // String | Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted. (optional) 

            try
            {
                // List time zones
                TimeZonesDTO result = apiInstance.getTimeZones(when, tzid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.getTimeZones: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$when = when_example; // String | Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z
$tzid = tzid_example; // String | Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted.

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


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $when = when_example; # String | Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z
my $tzid = tzid_example; # String | Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted.

eval { 
    my $result = $api_instance->getTimeZones(when => $when, tzid => $tzid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->getTimeZones: $@\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.ContactsInformationV1Api()
when = when_example # String | Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z (optional)
tzid = tzid_example # String | Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted. (optional)

try: 
    # List time zones
    api_response = api_instance.get_time_zones(when=when, tzid=tzid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->getTimeZones: %s\n" % e)

Parameters

Query parameters
Name Description
when
String
Calculate offsets for this given date Standard XML schema formatted date string in UTC format. Eg. 2021-01-01T09:00:00Z
tzid
String
Set to a time zone ID to view only that timezone. Useful when the offset for a time zone is wanted.

Responses

Status: 200 - OK

{"timezone":[{"region":"America","city":"Montreal","offset":"-18000000","tzid":"America/Montreal"},{"region":"Europe","city":"Stockholm","offset":"3600000","tzid":"Europe/Stockholm"},{"region":"Etc","city":"GMT","offset":"0","tzid":"Etc/GMT"}]}
{"timezone":[{"region":"America","city":"Montreal","offset":"-18000000","tzid":"America/Montreal"},{"region":"Europe","city":"Stockholm","offset":"3600000","tzid":"Europe/Stockholm"},{"region":"Etc","city":"GMT","offset":"0","tzid":"Etc/GMT"}]}

Status: 400 - Bad Request


putPidf

Update presence using PIDF

Update presence information in 'application/pidf+xml' format, see RFC3863/RFC4480/4481/RFC4482.


/contacts/v1/info/{domain}/{cid}/presence

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/pidf+xml"\
"/api//contacts/v1/info/{domain}/{cid}/presence"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String body = ; // String | 
        try {
            apiInstance.putPidf(domain, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#putPidf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String body = ; // String | 
        try {
            apiInstance.putPidf(domain, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#putPidf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *body = ; //  (optional)

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

// Update presence using PIDF
[apiInstance putPidfWith:domain
    cid:cid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'body':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.putPidf(domaincid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var body = new String(); // String |  (optional) 

            try
            {
                // Update presence using PIDF
                apiInstance.putPidf(domain, cid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.putPidf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$body = ; // String | 

try {
    $api_instance->putPidf($domain, $cid, $body);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->putPidf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $body = WWW::SwaggerClient::Object::String->new(); # String | 

eval { 
    $api_instance->putPidf(domain => $domain, cid => $cid, body => $body);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->putPidf: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
body =  # String |  (optional)

try: 
    # Update presence using PIDF
    api_instance.put_pidf(domain, cid, body=body)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->putPidf: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceActivity1

Update activity

Update a contact's activity.


/contacts/v1/info/{domain}/{cid}/activity/{activity}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/activity/{activity}?available="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String activity = activity_example; // String | The presence activity
Available values can be listed by using the Configuration API. Boolean available = true; // Boolean | The availability try { 'String' result = apiInstance.setContactPresenceActivity1(domain, cid, activity, available); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceActivity1"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String activity = activity_example; // String | The presence activity
Available values can be listed by using the Configuration API. Boolean available = true; // Boolean | The availability try { 'String' result = apiInstance.setContactPresenceActivity1(domain, cid, activity, available); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceActivity1"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *activity = activity_example; // The presence activity
Available values can be listed by using the Configuration API. Boolean *available = true; // The availability (optional) ContactsInformationV1Api *apiInstance = [[ContactsInformationV1Api alloc] init]; // Update activity [apiInstance setContactPresenceActivity1With:domain cid:cid activity:activity available:available completionHandler: ^('String' output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var activity = activity_example; // {{String}} The presence activity
Available values can be listed by using the Configuration API. var opts = { 'available': true // {{Boolean}} The availability }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.setContactPresenceActivity1(domain, cid, activity, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var activity = activity_example;  // String | The presence activity
Available values can be listed by using the Configuration API. var available = true; // Boolean | The availability (optional) try { // Update activity 'String' result = apiInstance.setContactPresenceActivity1(domain, cid, activity, available); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationV1Api.setContactPresenceActivity1: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$activity = activity_example; // String | The presence activity
Available values can be listed by using the Configuration API. $available = true; // Boolean | The availability try { $result = $api_instance->setContactPresenceActivity1($domain, $cid, $activity, $available); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationV1Api->setContactPresenceActivity1: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $activity = activity_example; # String | The presence activity
Available values can be listed by using the Configuration API. my $available = true; # Boolean | The availability eval { my $result = $api_instance->setContactPresenceActivity1(domain => $domain, cid => $cid, activity => $activity, available => $available); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationV1Api->setContactPresenceActivity1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
activity = activity_example # String | The presence activity
Available values can be listed by using the Configuration API. available = true # Boolean | The availability (optional) try: # Update activity api_response = api_instance.set_contact_presence_activity1(domain, cid, activity, available=available) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationV1Api->setContactPresenceActivity1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
activity*
String
The presence activity<br>Available values can be listed by using the Configuration API.
Required
Query parameters
Name Description
available
Boolean
The availability

Responses

Status: 200 - The activity in string format

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


setContactPresenceActivityExpiration1

Update activity expiration

Update a contact's activity expiration.


/contacts/v1/info/{domain}/{cid}/activityexpiration/{expires}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/activityexpiration/{expires}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String expires = expires_example; // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { apiInstance.setContactPresenceActivityExpiration1(domain, cid, expires); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceActivityExpiration1"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String expires = expires_example; // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { apiInstance.setContactPresenceActivityExpiration1(domain, cid, expires); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceActivityExpiration1"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *expires = expires_example; // The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. ContactsInformationV1Api *apiInstance = [[ContactsInformationV1Api alloc] init]; // Update activity expiration [apiInstance setContactPresenceActivityExpiration1With:domain cid:cid expires:expires completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var expires = expires_example; // {{String}} The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.setContactPresenceActivityExpiration1(domain, cid, expires, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var expires = expires_example;  // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { // Update activity expiration apiInstance.setContactPresenceActivityExpiration1(domain, cid, expires); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationV1Api.setContactPresenceActivityExpiration1: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$expires = expires_example; // String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try { $api_instance->setContactPresenceActivityExpiration1($domain, $cid, $expires); } catch (Exception $e) { echo 'Exception when calling ContactsInformationV1Api->setContactPresenceActivityExpiration1: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $expires = expires_example; # String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. eval { $api_instance->setContactPresenceActivityExpiration1(domain => $domain, cid => $cid, expires => $expires); }; if ($@) { warn "Exception when calling ContactsInformationV1Api->setContactPresenceActivityExpiration1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
expires = expires_example # String | The activity expires string, or 'never' if the activity should not have an expiry time.
The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used. try: # Update activity expiration api_instance.set_contact_presence_activity_expiration1(domain, cid, expires) except ApiException as e: print("Exception when calling ContactsInformationV1Api->setContactPresenceActivityExpiration1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
expires*
String
The activity expires string, or 'never' if the activity should not have an expiry time.<br>The date and time should be a string according to XMLCalendar: YYYY-MM-DDThh:mm:ss , for example: 2010-01-27T19:01:32. You can also add a time zone. The time zone is based on UTC (Z) with an offset from -14:00 to +14:00. For example, "14:30:00-05:00" specifies 2:30 PM in the afternoon at UTC-05:00, which is the same as EST. If a time zone is not specified, the default time zone is used.
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


setContactPresenceNote1

Set note

Set a contact's presence note.


/contacts/v1/info/{domain}/{cid}/note

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/note?note=&ver="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the user accessing the API
        String cid = cid_example; // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
        String note = note_example; // String | The note
        String ver = ver_example; // String | Version number (not used)
        try {
            validationResult result = apiInstance.setContactPresenceNote1(domain, cid, note, ver);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceNote1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the user accessing the API
        String cid = cid_example; // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
        String note = note_example; // String | The note
        String ver = ver_example; // String | Version number (not used)
        try {
            validationResult result = apiInstance.setContactPresenceNote1(domain, cid, note, ver);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceNote1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *cid = cid_example; // The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
String *note = note_example; // The note (optional)
String *ver = ver_example; // Version number (not used) (optional)

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

// Set note
[apiInstance setContactPresenceNote1With:domain
    cid:cid
    note:note
    ver:ver
              completionHandler: ^(validationResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var cid = cid_example; // {{String}} The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
var opts = { 
  'note': note_example, // {{String}} The note
  'ver': ver_example // {{String}} Version number (not used)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setContactPresenceNote1(domain, cid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var cid = cid_example;  // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
            var note = note_example;  // String | The note (optional) 
            var ver = ver_example;  // String | Version number (not used) (optional) 

            try
            {
                // Set note
                validationResult result = apiInstance.setContactPresenceNote1(domain, cid, note, ver);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.setContactPresenceNote1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the user accessing the API
$cid = cid_example; // String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
$note = note_example; // String | The note
$ver = ver_example; // String | Version number (not used)

try {
    $result = $api_instance->setContactPresenceNote1($domain, $cid, $note, $ver);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->setContactPresenceNote1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $cid = cid_example; # String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
my $note = note_example; # String | The note
my $ver = ver_example; # String | Version number (not used)

eval { 
    my $result = $api_instance->setContactPresenceNote1(domain => $domain, cid => $cid, note => $note, ver => $ver);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->setContactPresenceNote1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the user accessing the API
cid = cid_example # String | The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
note = note_example # String | The note (optional)
ver = ver_example # String | Version number (not used) (optional)

try: 
    # Set note
    api_response = api_instance.set_contact_presence_note1(domain, cid, note=note, ver=ver)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->setContactPresenceNote1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
cid*
String
The contact ID (including domain) for the user with the fields. The field should have the follow format user@domain or number@domain when fetching a mobile subscriber's line state
Required
Query parameters
Name Description
note
String
The note
ver
String
Version number (not used)

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceRole1

Set role

Set a contact's presence role.


/contacts/v1/info/{domain}/{cid}/role/{role}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//contacts/v1/info/{domain}/{cid}/role/{role}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String role = role_example; // String | The presence role
Available values can be listed by using the Configuration API. try { 'String' result = apiInstance.setContactPresenceRole1(domain, cid, role); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceRole1"); e.printStackTrace(); } } }
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String role = role_example; // String | The presence role
Available values can be listed by using the Configuration API. try { 'String' result = apiInstance.setContactPresenceRole1(domain, cid, role); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ContactsInformationV1Api#setContactPresenceRole1"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *role = role_example; // The presence role
Available values can be listed by using the Configuration API. ContactsInformationV1Api *apiInstance = [[ContactsInformationV1Api alloc] init]; // Set role [apiInstance setContactPresenceRole1With:domain cid:cid role:role completionHandler: ^('String' output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var role = role_example; // {{String}} The presence role
Available values can be listed by using the Configuration API. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.setContactPresenceRole1(domain, cid, role, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var role = role_example;  // String | The presence role
Available values can be listed by using the Configuration API. try { // Set role 'String' result = apiInstance.setContactPresenceRole1(domain, cid, role); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling ContactsInformationV1Api.setContactPresenceRole1: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$role = role_example; // String | The presence role
Available values can be listed by using the Configuration API. try { $result = $api_instance->setContactPresenceRole1($domain, $cid, $role); print_r($result); } catch (Exception $e) { echo 'Exception when calling ContactsInformationV1Api->setContactPresenceRole1: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $role = role_example; # String | The presence role
Available values can be listed by using the Configuration API. eval { my $result = $api_instance->setContactPresenceRole1(domain => $domain, cid => $cid, role => $role); print Dumper($result); }; if ($@) { warn "Exception when calling ContactsInformationV1Api->setContactPresenceRole1: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
role = role_example # String | The presence role
Available values can be listed by using the Configuration API. try: # Set role api_response = api_instance.set_contact_presence_role1(domain, cid, role) pprint(api_response) except ApiException as e: print("Exception when calling ContactsInformationV1Api->setContactPresenceRole1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
role*
String
The presence role<br>Available values can be listed by using the Configuration API.
Required

Responses

Status: 200 - The role in string format

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or contact is not found


subscribeForContactLineState

Subscribe on line state

The method produces a SSE stream of line state updates in application/dialog-info+xml format, see RFC4235.


/contacts/v1/info/v1/{domain}/{cid}/incall

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/event-stream"\
"/api//contacts/v1/info/v1/{domain}/{cid}/incall"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.subscribeForContactLineState(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#subscribeForContactLineState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.subscribeForContactLineState(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#subscribeForContactLineState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Subscribe on line state
[apiInstance subscribeForContactLineStateWith:domain
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeForContactLineState(domain, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Subscribe on line state
                apiInstance.subscribeForContactLineState(domain, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.subscribeForContactLineState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->subscribeForContactLineState($domain, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->subscribeForContactLineState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->subscribeForContactLineState(domain => $domain, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->subscribeForContactLineState: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Subscribe on line state
    api_instance.subscribe_for_contact_line_state(domain, cid)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->subscribeForContactLineState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - A document stream in 'application/dialog-info+xml' format

Status: 403 - Not Authorized

Status: 404 - Not Found


subscribeForContactPidf

Subscribe on presence

The method produces a SSE stream of presence states in 'application/pidf+xml' format, see RFC3863/RFC4480/4481/RFC4482.


/contacts/v1/info/v1/{domain}/{cid}/presence

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/event-stream"\
"/api//contacts/v1/info/v1/{domain}/{cid}/presence"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.subscribeForContactPidf(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#subscribeForContactPidf");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.subscribeForContactPidf(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#subscribeForContactPidf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Subscribe on presence
[apiInstance subscribeForContactPidfWith:domain
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeForContactPidf(domain, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new ContactsInformationV1Api();
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Subscribe on presence
                apiInstance.subscribeForContactPidf(domain, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.subscribeForContactPidf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->subscribeForContactPidf($domain, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->subscribeForContactPidf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->subscribeForContactPidf(domain => $domain, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->subscribeForContactPidf: $@\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.ContactsInformationV1Api()
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Subscribe on presence
    api_instance.subscribe_for_contact_pidf(domain, cid)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->subscribeForContactPidf: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - A document stream in 'application/pidf+xml' format

Status: 403 - Not Authorized

Status: 404 - Not Found


updateContactPresence1

Update scheduled presence

Update a contact's scheduled presence change.


/contacts/v1/info/{domain}/{cid}/presence/{presenceId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/presence/{presenceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        ScheduledPresenceDTO body = {
  "role" : "business",
  "note" : "Daily standup",
  "presenceId" : "3",
  "activity" : "meeting",
  "priority" : 0,
  "name" : "Standup meeting",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-02-01T08:30:00Z",
  "dt-end" : "2021-02-01T09:00:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // ScheduledPresenceDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
        try {
            apiInstance.updateContactPresence1(body, domain, cid, presenceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#updateContactPresence1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        ScheduledPresenceDTO body = {
  "role" : "business",
  "note" : "Daily standup",
  "presenceId" : "3",
  "activity" : "meeting",
  "priority" : 0,
  "name" : "Standup meeting",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-02-01T08:30:00Z",
  "dt-end" : "2021-02-01T09:00:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // ScheduledPresenceDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        String presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence
        try {
            apiInstance.updateContactPresence1(body, domain, cid, presenceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#updateContactPresence1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ScheduledPresenceDTO *body = {
  "role" : "business",
  "note" : "Daily standup",
  "presenceId" : "3",
  "activity" : "meeting",
  "priority" : 0,
  "name" : "Standup meeting",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-02-01T08:30:00Z",
  "dt-end" : "2021-02-01T09:00:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact
String *presenceId = presenceId_example; // The presence ID that identifies scheduled presence

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

// Update scheduled presence
[apiInstance updateContactPresence1With:body
    domain:domain
    cid:cid
    presenceId:presenceId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var body = {
  "role" : "business",
  "note" : "Daily standup",
  "presenceId" : "3",
  "activity" : "meeting",
  "priority" : 0,
  "name" : "Standup meeting",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-02-01T08:30:00Z",
  "dt-end" : "2021-02-01T09:00:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // {{ScheduledPresenceDTO}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact
var presenceId = presenceId_example; // {{String}} The presence ID that identifies scheduled presence

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

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


            var apiInstance = new ContactsInformationV1Api();
            var body = new ScheduledPresenceDTO(); // ScheduledPresenceDTO | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact
            var presenceId = presenceId_example;  // String | The presence ID that identifies scheduled presence

            try
            {
                // Update scheduled presence
                apiInstance.updateContactPresence1(body, domain, cid, presenceId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.updateContactPresence1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$body = {
  "role" : "business",
  "note" : "Daily standup",
  "presenceId" : "3",
  "activity" : "meeting",
  "priority" : 0,
  "name" : "Standup meeting",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-02-01T08:30:00Z",
  "dt-end" : "2021-02-01T09:00:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
}; // ScheduledPresenceDTO | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact
$presenceId = presenceId_example; // String | The presence ID that identifies scheduled presence

try {
    $api_instance->updateContactPresence1($body, $domain, $cid, $presenceId);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->updateContactPresence1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $body = WWW::SwaggerClient::Object::ScheduledPresenceDTO->new(); # ScheduledPresenceDTO | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact
my $presenceId = presenceId_example; # String | The presence ID that identifies scheduled presence

eval { 
    $api_instance->updateContactPresence1(body => $body, domain => $domain, cid => $cid, presenceId => $presenceId);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->updateContactPresence1: $@\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.ContactsInformationV1Api()
body = {
  "role" : "business",
  "note" : "Daily standup",
  "presenceId" : "3",
  "activity" : "meeting",
  "priority" : 0,
  "name" : "Standup meeting",
  "source" : "INTERNAL",
  "modifiable" : true,
  "deleted" : false,
  "futurePresenceAccess" : "WRITE",
  "activityAccess" : "WRITE",
  "roleAccess" : "WRITE",
  "noteAccess" : "WRITE",
  "dt-start" : "2021-02-01T08:30:00Z",
  "dt-end" : "2021-02-01T09:00:00Z",
  "tzid" : "Europe/Stockholm",
  "recur" : {
    "freq" : "WEEKLY",
    "byday" : "MO,TU,WE,TH"
  }
} # ScheduledPresenceDTO | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact
presenceId = presenceId_example # String | The presence ID that identifies scheduled presence

try: 
    # Update scheduled presence
    api_instance.update_contact_presence1(body, domain, cid, presenceId)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->updateContactPresence1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
presenceId*
String
The presence ID that identifies scheduled presence
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateContactVcard1

Update vCard

Update a contact's vCard information.


/contacts/v1/info/{domain}/{cid}/vcard

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//contacts/v1/info/{domain}/{cid}/vcard"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsInformationV1Api;

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

public class ContactsInformationV1ApiExample {

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


        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        VcardDTO body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // VcardDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.updateContactVcard1(body, domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#updateContactVcard1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsInformationV1Api;

public class ContactsInformationV1ApiExample {

    public static void main(String[] args) {
        ContactsInformationV1Api apiInstance = new ContactsInformationV1Api();
        VcardDTO body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // VcardDTO | 
        String domain = domain_example; // String | The domain of the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.updateContactVcard1(body, domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsInformationV1Api#updateContactVcard1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
VcardDTO *body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // 
String *domain = domain_example; // The domain of the contact
String *cid = cid_example; // The ID of the contact

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

// Update vCard
[apiInstance updateContactVcard1With:body
    domain:domain
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.ContactsInformationV1Api()
var body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // {{VcardDTO}} 
var domain = domain_example; // {{String}} The domain of the contact
var cid = cid_example; // {{String}} The ID of the contact

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

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


            var apiInstance = new ContactsInformationV1Api();
            var body = new VcardDTO(); // VcardDTO | 
            var domain = domain_example;  // String | The domain of the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Update vCard
                apiInstance.updateContactVcard1(body, domain, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsInformationV1Api.updateContactVcard1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiContactsInformationV1Api();
$body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
}; // VcardDTO | 
$domain = domain_example; // String | The domain of the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->updateContactVcard1($body, $domain, $cid);
} catch (Exception $e) {
    echo 'Exception when calling ContactsInformationV1Api->updateContactVcard1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsInformationV1Api;


my $api_instance = WWW::SwaggerClient::ContactsInformationV1Api->new();
my $body = WWW::SwaggerClient::Object::VcardDTO->new(); # VcardDTO | 
my $domain = domain_example; # String | The domain of the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->updateContactVcard1(body => $body, domain => $domain, cid => $cid);
};
if ($@) {
    warn "Exception when calling ContactsInformationV1Api->updateContactVcard1: $@\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.ContactsInformationV1Api()
body = {
  "Description" : {
    "TEL" : [ {
      "value" : "+46812345001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      } ]
    }, {
      "value" : "5001",
      "type" : [ {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#work"
      }, {
        "resource" : "http://www.w3.org/2001/vcard-rdf/3.0#voice"
      }, {
        "resource" : "http://www.telepo.com/telepo-rdf/#shortnumber"
      } ]
    } ],
    "group" : [ {
      "value" : "Support"
    }, {
      "value" : "Technical Support"
    } ],
    "ORG" : {
      "Orgname" : "Example Organisation",
      "Orgunit" : "Support"
    },
    "EMAIL" : {
      "value" : "john.doe@example.org"
    },
    "ADR" : {
      "Country" : "Sweden",
      "Locality" : "111 11",
      "Street" : "Example Street 1",
      "Pcode" : "Stockholm"
    },
    "N" : {
      "Family" : "Doe",
      "Given" : "John"
    }
  }
} # VcardDTO | 
domain = domain_example # String | The domain of the contact
cid = cid_example # String | The ID of the contact

try: 
    # Update vCard
    api_instance.update_contact_vcard1(body, domain, cid)
except ApiException as e:
    print("Exception when calling ContactsInformationV1Api->updateContactVcard1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - The input is not correct, see response for details

Status: 403 - Not Authorized

Status: 404 - Not Found


DistributionGroup

getCallHistoryOfAGroup

Get group call history

Get call log items for a specific distribution group accessible to the user.<br>Calls are normally grouped in call log items by distribution group, caller and item type. For example, missed calls from +155568123456 to ACD 'Customer service' are gathered in one call log item. However, if both callerNumber and itemType are specified as parameters, each individual call is returned as a separate call log item.


/user/distgroup/{domain}/{user}/calllog/{grpid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/calllog/{grpid}?groupDomain=&callerNumber=&itemType=&since=&olderThan=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        String grpid = grpid_example; // String | The ID of the distribution group
        String groupDomain = groupDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        String callerNumber = callerNumber_example; // String | If provided, only return group call log items that originate from this number
        array[String] itemType = ; // array[String] | If provided, only return these types of group call log items
        String since = since_example; // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. String olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. String limit = limit_example; // String | If stated, return no more than this amount of group call log items try { distributionGroupCallLog result = apiInstance.getCallHistoryOfAGroup(domain, user, grpid, groupDomain, callerNumber, itemType, since, olderThan, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DistributionGroupApi#getCallHistoryOfAGroup"); e.printStackTrace(); } } }
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        String grpid = grpid_example; // String | The ID of the distribution group
        String groupDomain = groupDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        String callerNumber = callerNumber_example; // String | If provided, only return group call log items that originate from this number
        array[String] itemType = ; // array[String] | If provided, only return these types of group call log items
        String since = since_example; // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. String olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. String limit = limit_example; // String | If stated, return no more than this amount of group call log items try { distributionGroupCallLog result = apiInstance.getCallHistoryOfAGroup(domain, user, grpid, groupDomain, callerNumber, itemType, since, olderThan, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DistributionGroupApi#getCallHistoryOfAGroup"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user
String *grpid = grpid_example; // The ID of the distribution group
String *groupDomain = groupDomain_example; // If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain (optional)
String *callerNumber = callerNumber_example; // If provided, only return group call log items that originate from this number (optional)
array[String] *itemType = ; // If provided, only return these types of group call log items (optional)
String *since = since_example; // If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. (optional) String *olderThan = olderThan_example; // If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. (optional) String *limit = limit_example; // If stated, return no more than this amount of group call log items (optional) DistributionGroupApi *apiInstance = [[DistributionGroupApi alloc] init]; // Get group call history [apiInstance getCallHistoryOfAGroupWith:domain user:user grpid:grpid groupDomain:groupDomain callerNumber:callerNumber itemType:itemType since:since olderThan:olderThan limit:limit completionHandler: ^(distributionGroupCallLog output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user
var grpid = grpid_example; // {{String}} The ID of the distribution group
var opts = { 
  'groupDomain': groupDomain_example, // {{String}} If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
  'callerNumber': callerNumber_example, // {{String}} If provided, only return group call log items that originate from this number
  'itemType': , // {{array[String]}} If provided, only return these types of group call log items
  'since': since_example, // {{String}} If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. 'olderThan': olderThan_example, // {{String}} If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. 'limit': limit_example // {{String}} If stated, return no more than this amount of group call log items }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getCallHistoryOfAGroup(domain, user, grpid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user
            var grpid = grpid_example;  // String | The ID of the distribution group
            var groupDomain = groupDomain_example;  // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain (optional) 
            var callerNumber = callerNumber_example;  // String | If provided, only return group call log items that originate from this number (optional) 
            var itemType = new array[String](); // array[String] | If provided, only return these types of group call log items (optional) 
            var since = since_example;  // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. (optional) var olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. (optional) var limit = limit_example; // String | If stated, return no more than this amount of group call log items (optional) try { // Get group call history distributionGroupCallLog result = apiInstance.getCallHistoryOfAGroup(domain, user, grpid, groupDomain, callerNumber, itemType, since, olderThan, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DistributionGroupApi.getCallHistoryOfAGroup: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user
$grpid = grpid_example; // String | The ID of the distribution group
$groupDomain = groupDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
$callerNumber = callerNumber_example; // String | If provided, only return group call log items that originate from this number
$itemType = ; // array[String] | If provided, only return these types of group call log items
$since = since_example; // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. $olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. $limit = limit_example; // String | If stated, return no more than this amount of group call log items try { $result = $api_instance->getCallHistoryOfAGroup($domain, $user, $grpid, $groupDomain, $callerNumber, $itemType, $since, $olderThan, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling DistributionGroupApi->getCallHistoryOfAGroup: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DistributionGroupApi;


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user
my $grpid = grpid_example; # String | The ID of the distribution group
my $groupDomain = groupDomain_example; # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
my $callerNumber = callerNumber_example; # String | If provided, only return group call log items that originate from this number
my $itemType = []; # array[String] | If provided, only return these types of group call log items
my $since = since_example; # String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. my $olderThan = olderThan_example; # String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. my $limit = limit_example; # String | If stated, return no more than this amount of group call log items eval { my $result = $api_instance->getCallHistoryOfAGroup(domain => $domain, user => $user, grpid => $grpid, groupDomain => $groupDomain, callerNumber => $callerNumber, itemType => $itemType, since => $since, olderThan => $olderThan, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling DistributionGroupApi->getCallHistoryOfAGroup: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user
grpid = grpid_example # String | The ID of the distribution group
groupDomain = groupDomain_example # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain (optional)
callerNumber = callerNumber_example # String | If provided, only return group call log items that originate from this number (optional)
itemType =  # array[String] | If provided, only return these types of group call log items (optional)
since = since_example # String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. (optional) olderThan = olderThan_example # String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. (optional) limit = limit_example # String | If stated, return no more than this amount of group call log items (optional) try: # Get group call history api_response = api_instance.get_call_history_of_a_group(domain, user, grpid, groupDomain=groupDomain, callerNumber=callerNumber, itemType=itemType, since=since, olderThan=olderThan, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling DistributionGroupApi->getCallHistoryOfAGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required
grpid*
String
The ID of the distribution group
Required
Query parameters
Name Description
groupDomain
String
If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as <b>domain</b>
callerNumber
String
If provided, only return group call log items that originate from this number
itemType
array[String]
If provided, only return these types of group call log items
since
String
If provided, only return items with ID greater than this.<br/>The purpose of <b>since</b> is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.<br/>Note that <b>since</b> cannot be combined with <b>olderThan</b>.
olderThan
String
If provided, only return group call log items with ID smaller than this.<br/>The purpose of <b>olderThan</b> is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.<br/>Note that <b>olderThan</b> cannot be combined with <b>since</b>.
limit
String
If stated, return no more than this amount of group call log items

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getCallHistoryOfAllGroups

Get call history

Get call log items for all ACD/Attendant groups available for the user.


/user/distgroup/{domain}/{user}/calllog

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/calllog?callerNumber=&itemType=&since=&olderThan=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        String callerNumber = callerNumber_example; // String | If provided, only return group call log items that originate from this number
        array[String] itemType = ; // array[String] | If provided, only return these types of group call log items
        String since = since_example; // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. String olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. String limit = limit_example; // String | If stated, return no more than this amount of group call log items try { distributionGroupCallLog result = apiInstance.getCallHistoryOfAllGroups(domain, user, callerNumber, itemType, since, olderThan, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DistributionGroupApi#getCallHistoryOfAllGroups"); e.printStackTrace(); } } }
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        String callerNumber = callerNumber_example; // String | If provided, only return group call log items that originate from this number
        array[String] itemType = ; // array[String] | If provided, only return these types of group call log items
        String since = since_example; // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. String olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. String limit = limit_example; // String | If stated, return no more than this amount of group call log items try { distributionGroupCallLog result = apiInstance.getCallHistoryOfAllGroups(domain, user, callerNumber, itemType, since, olderThan, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DistributionGroupApi#getCallHistoryOfAllGroups"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user
String *callerNumber = callerNumber_example; // If provided, only return group call log items that originate from this number (optional)
array[String] *itemType = ; // If provided, only return these types of group call log items (optional)
String *since = since_example; // If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. (optional) String *olderThan = olderThan_example; // If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. (optional) String *limit = limit_example; // If stated, return no more than this amount of group call log items (optional) DistributionGroupApi *apiInstance = [[DistributionGroupApi alloc] init]; // Get call history [apiInstance getCallHistoryOfAllGroupsWith:domain user:user callerNumber:callerNumber itemType:itemType since:since olderThan:olderThan limit:limit completionHandler: ^(distributionGroupCallLog output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user
var opts = { 
  'callerNumber': callerNumber_example, // {{String}} If provided, only return group call log items that originate from this number
  'itemType': , // {{array[String]}} If provided, only return these types of group call log items
  'since': since_example, // {{String}} If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. 'olderThan': olderThan_example, // {{String}} If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. 'limit': limit_example // {{String}} If stated, return no more than this amount of group call log items }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getCallHistoryOfAllGroups(domain, user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user
            var callerNumber = callerNumber_example;  // String | If provided, only return group call log items that originate from this number (optional) 
            var itemType = new array[String](); // array[String] | If provided, only return these types of group call log items (optional) 
            var since = since_example;  // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. (optional) var olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. (optional) var limit = limit_example; // String | If stated, return no more than this amount of group call log items (optional) try { // Get call history distributionGroupCallLog result = apiInstance.getCallHistoryOfAllGroups(domain, user, callerNumber, itemType, since, olderThan, limit); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DistributionGroupApi.getCallHistoryOfAllGroups: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user
$callerNumber = callerNumber_example; // String | If provided, only return group call log items that originate from this number
$itemType = ; // array[String] | If provided, only return these types of group call log items
$since = since_example; // String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. $olderThan = olderThan_example; // String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. $limit = limit_example; // String | If stated, return no more than this amount of group call log items try { $result = $api_instance->getCallHistoryOfAllGroups($domain, $user, $callerNumber, $itemType, $since, $olderThan, $limit); print_r($result); } catch (Exception $e) { echo 'Exception when calling DistributionGroupApi->getCallHistoryOfAllGroups: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DistributionGroupApi;


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user
my $callerNumber = callerNumber_example; # String | If provided, only return group call log items that originate from this number
my $itemType = []; # array[String] | If provided, only return these types of group call log items
my $since = since_example; # String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. my $olderThan = olderThan_example; # String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. my $limit = limit_example; # String | If stated, return no more than this amount of group call log items eval { my $result = $api_instance->getCallHistoryOfAllGroups(domain => $domain, user => $user, callerNumber => $callerNumber, itemType => $itemType, since => $since, olderThan => $olderThan, limit => $limit); print Dumper($result); }; if ($@) { warn "Exception when calling DistributionGroupApi->getCallHistoryOfAllGroups: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user
callerNumber = callerNumber_example # String | If provided, only return group call log items that originate from this number (optional)
itemType =  # array[String] | If provided, only return these types of group call log items (optional)
since = since_example # String | If provided, only return items with ID greater than this.
The purpose of since is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.
Note that since cannot be combined with olderThan. (optional) olderThan = olderThan_example # String | If provided, only return group call log items with ID smaller than this.
The purpose of olderThan is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.
Note that olderThan cannot be combined with since. (optional) limit = limit_example # String | If stated, return no more than this amount of group call log items (optional) try: # Get call history api_response = api_instance.get_call_history_of_all_groups(domain, user, callerNumber=callerNumber, itemType=itemType, since=since, olderThan=olderThan, limit=limit) pprint(api_response) except ApiException as e: print("Exception when calling DistributionGroupApi->getCallHistoryOfAllGroups: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required
Query parameters
Name Description
callerNumber
String
If provided, only return group call log items that originate from this number
itemType
array[String]
If provided, only return these types of group call log items
since
String
If provided, only return items with ID greater than this.<br/>The purpose of <b>since</b> is to enable retrieving items that have come in since last fetch by providing since=the last known item ID.<br/>Note that <b>since</b> cannot be combined with <b>olderThan</b>.
olderThan
String
If provided, only return group call log items with ID smaller than this.<br/>The purpose of <b>olderThan</b> is to enable 'scrolling' in a list so that when the final item is reached, later items can be fetched by providing olderThan=the last call log ID retrieved.<br/>Note that <b>olderThan</b> cannot be combined with <b>since</b>.
limit
String
If stated, return no more than this amount of group call log items

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getDistributionGroups

List groups

List ACD/Attendant groups available to the user, and the user's current login state.


/user/distgroup/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        try {
            distributionGroups result = apiInstance.getDistributionGroups(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#getDistributionGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        try {
            distributionGroups result = apiInstance.getDistributionGroups(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#getDistributionGroups");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user

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

// List groups
[apiInstance getDistributionGroupsWith:domain
    user:user
              completionHandler: ^(distributionGroups output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user

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

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user

            try
            {
                // List groups
                distributionGroups result = apiInstance.getDistributionGroups(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.getDistributionGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user

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


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user

eval { 
    my $result = $api_instance->getDistributionGroups(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->getDistributionGroups: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user

try: 
    # List groups
    api_response = api_instance.get_distribution_groups(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->getDistributionGroups: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getGroupCallHistoryAssignedTo

List assigned calls

List group call log items assigned to a user.


/user/distgroup/{domain}/{user}/calllog/assigned

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/calllog/assigned"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        try {
            distributionGroupCallLog result = apiInstance.getGroupCallHistoryAssignedTo(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#getGroupCallHistoryAssignedTo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        try {
            distributionGroupCallLog result = apiInstance.getGroupCallHistoryAssignedTo(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#getGroupCallHistoryAssignedTo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user

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

// List assigned calls
[apiInstance getGroupCallHistoryAssignedToWith:domain
    user:user
              completionHandler: ^(distributionGroupCallLog output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user

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

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user

            try
            {
                // List assigned calls
                distributionGroupCallLog result = apiInstance.getGroupCallHistoryAssignedTo(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.getGroupCallHistoryAssignedTo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user

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


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user

eval { 
    my $result = $api_instance->getGroupCallHistoryAssignedTo(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->getGroupCallHistoryAssignedTo: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user

try: 
    # List assigned calls
    api_response = api_instance.get_group_call_history_assigned_to(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->getGroupCallHistoryAssignedTo: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getGroupCallHistoryAssignedToOfAGroup

List group assigned calls

List call log items assigned to a user from a certain distribution group.


/user/distgroup/{domain}/{user}/calllog/assigned/{grpid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/calllog/assigned/{grpid}?groupDomain="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        String grpid = grpid_example; // String | The ID of the distribution group
        String groupDomain = groupDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        try {
            distributionGroupCallLog result = apiInstance.getGroupCallHistoryAssignedToOfAGroup(domain, user, grpid, groupDomain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#getGroupCallHistoryAssignedToOfAGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        String grpid = grpid_example; // String | The ID of the distribution group
        String groupDomain = groupDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        try {
            distributionGroupCallLog result = apiInstance.getGroupCallHistoryAssignedToOfAGroup(domain, user, grpid, groupDomain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#getGroupCallHistoryAssignedToOfAGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user
String *grpid = grpid_example; // The ID of the distribution group
String *groupDomain = groupDomain_example; // If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain (optional)

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

// List group assigned calls
[apiInstance getGroupCallHistoryAssignedToOfAGroupWith:domain
    user:user
    grpid:grpid
    groupDomain:groupDomain
              completionHandler: ^(distributionGroupCallLog output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user
var grpid = grpid_example; // {{String}} The ID of the distribution group
var opts = { 
  'groupDomain': groupDomain_example // {{String}} If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroupCallHistoryAssignedToOfAGroup(domain, user, grpid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user
            var grpid = grpid_example;  // String | The ID of the distribution group
            var groupDomain = groupDomain_example;  // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain (optional) 

            try
            {
                // List group assigned calls
                distributionGroupCallLog result = apiInstance.getGroupCallHistoryAssignedToOfAGroup(domain, user, grpid, groupDomain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.getGroupCallHistoryAssignedToOfAGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user
$grpid = grpid_example; // String | The ID of the distribution group
$groupDomain = groupDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain

try {
    $result = $api_instance->getGroupCallHistoryAssignedToOfAGroup($domain, $user, $grpid, $groupDomain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistributionGroupApi->getGroupCallHistoryAssignedToOfAGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DistributionGroupApi;


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user
my $grpid = grpid_example; # String | The ID of the distribution group
my $groupDomain = groupDomain_example; # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain

eval { 
    my $result = $api_instance->getGroupCallHistoryAssignedToOfAGroup(domain => $domain, user => $user, grpid => $grpid, groupDomain => $groupDomain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->getGroupCallHistoryAssignedToOfAGroup: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user
grpid = grpid_example # String | The ID of the distribution group
groupDomain = groupDomain_example # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain (optional)

try: 
    # List group assigned calls
    api_response = api_instance.get_group_call_history_assigned_to_of_a_group(domain, user, grpid, groupDomain=groupDomain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->getGroupCallHistoryAssignedToOfAGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required
grpid*
String
The ID of the distribution group
Required
Query parameters
Name Description
groupDomain
String
If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as <b>domain</b>

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


loginToGroup

Log in to federated group

Log in a user to a distribution group.


/user/distgroup/{domain}/{user}/{grpid}/{grpid-domain}/login

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/{grpid}/{grpid-domain}/login?ignoreStatistics="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        Long grpid = 789; // Long | The ID of the distribution group
        String grpidDomain = grpidDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response.
        try {
            distributionGroups result = apiInstance.loginToGroup(domain, user, grpid, grpidDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#loginToGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        Long grpid = 789; // Long | The ID of the distribution group
        String grpidDomain = grpidDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response.
        try {
            distributionGroups result = apiInstance.loginToGroup(domain, user, grpid, grpidDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#loginToGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user
Long *grpid = 789; // The ID of the distribution group
String *grpidDomain = grpidDomain_example; // If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
Boolean *ignoreStatistics = true; // Don't include statistics and immediately return an empty response. (optional)

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

// Log in to federated group
[apiInstance loginToGroupWith:domain
    user:user
    grpid:grpid
    grpidDomain:grpidDomain
    ignoreStatistics:ignoreStatistics
              completionHandler: ^(distributionGroups output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user
var grpid = 789; // {{Long}} The ID of the distribution group
var grpidDomain = grpidDomain_example; // {{String}} If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
var opts = { 
  'ignoreStatistics': true // {{Boolean}} Don't include statistics and immediately return an empty response.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.loginToGroup(domain, user, grpid, grpidDomain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user
            var grpid = 789;  // Long | The ID of the distribution group
            var grpidDomain = grpidDomain_example;  // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
            var ignoreStatistics = true;  // Boolean | Don't include statistics and immediately return an empty response. (optional) 

            try
            {
                // Log in to federated group
                distributionGroups result = apiInstance.loginToGroup(domain, user, grpid, grpidDomain, ignoreStatistics);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.loginToGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user
$grpid = 789; // Long | The ID of the distribution group
$grpidDomain = grpidDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
$ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response.

try {
    $result = $api_instance->loginToGroup($domain, $user, $grpid, $grpidDomain, $ignoreStatistics);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistributionGroupApi->loginToGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DistributionGroupApi;


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user
my $grpid = 789; # Long | The ID of the distribution group
my $grpidDomain = grpidDomain_example; # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
my $ignoreStatistics = true; # Boolean | Don't include statistics and immediately return an empty response.

eval { 
    my $result = $api_instance->loginToGroup(domain => $domain, user => $user, grpid => $grpid, grpidDomain => $grpidDomain, ignoreStatistics => $ignoreStatistics);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->loginToGroup: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user
grpid = 789 # Long | The ID of the distribution group
grpidDomain = grpidDomain_example # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
ignoreStatistics = true # Boolean | Don't include statistics and immediately return an empty response. (optional)

try: 
    # Log in to federated group
    api_response = api_instance.login_to_group(domain, user, grpid, grpidDomain, ignoreStatistics=ignoreStatistics)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->loginToGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required
grpid*
Long (int64)
The ID of the distribution group
Required
grpid-domain*
String
If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as <b>domain</b>
Required
Query parameters
Name Description
ignoreStatistics
Boolean
Don't include statistics and immediately return an empty response.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


logoutFromGroup

Log out of federated group

Log out a user from a distribution group.


/user/distgroup/{domain}/{user}/{grpid}/{grpid-domain}/logout

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/{grpid}/{grpid-domain}/logout?ignoreStatistics="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        Long grpid = 789; // Long | The ID of the distribution group
        String grpidDomain = grpidDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response.
        try {
            distributionGroups result = apiInstance.logoutFromGroup(domain, user, grpid, grpidDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#logoutFromGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        Long grpid = 789; // Long | The ID of the distribution group
        String grpidDomain = grpidDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
        Boolean ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response.
        try {
            distributionGroups result = apiInstance.logoutFromGroup(domain, user, grpid, grpidDomain, ignoreStatistics);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#logoutFromGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user
Long *grpid = 789; // The ID of the distribution group
String *grpidDomain = grpidDomain_example; // If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
Boolean *ignoreStatistics = true; // Don't include statistics and immediately return an empty response. (optional)

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

// Log out of federated group
[apiInstance logoutFromGroupWith:domain
    user:user
    grpid:grpid
    grpidDomain:grpidDomain
    ignoreStatistics:ignoreStatistics
              completionHandler: ^(distributionGroups output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user
var grpid = 789; // {{Long}} The ID of the distribution group
var grpidDomain = grpidDomain_example; // {{String}} If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
var opts = { 
  'ignoreStatistics': true // {{Boolean}} Don't include statistics and immediately return an empty response.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logoutFromGroup(domain, user, grpid, grpidDomain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user
            var grpid = 789;  // Long | The ID of the distribution group
            var grpidDomain = grpidDomain_example;  // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
            var ignoreStatistics = true;  // Boolean | Don't include statistics and immediately return an empty response. (optional) 

            try
            {
                // Log out of federated group
                distributionGroups result = apiInstance.logoutFromGroup(domain, user, grpid, grpidDomain, ignoreStatistics);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.logoutFromGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user
$grpid = 789; // Long | The ID of the distribution group
$grpidDomain = grpidDomain_example; // String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
$ignoreStatistics = true; // Boolean | Don't include statistics and immediately return an empty response.

try {
    $result = $api_instance->logoutFromGroup($domain, $user, $grpid, $grpidDomain, $ignoreStatistics);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DistributionGroupApi->logoutFromGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DistributionGroupApi;


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user
my $grpid = 789; # Long | The ID of the distribution group
my $grpidDomain = grpidDomain_example; # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
my $ignoreStatistics = true; # Boolean | Don't include statistics and immediately return an empty response.

eval { 
    my $result = $api_instance->logoutFromGroup(domain => $domain, user => $user, grpid => $grpid, grpidDomain => $grpidDomain, ignoreStatistics => $ignoreStatistics);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->logoutFromGroup: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user
grpid = 789 # Long | The ID of the distribution group
grpidDomain = grpidDomain_example # String | If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as domain
ignoreStatistics = true # Boolean | Don't include statistics and immediately return an empty response. (optional)

try: 
    # Log out of federated group
    api_response = api_instance.logout_from_group(domain, user, grpid, grpidDomain, ignoreStatistics=ignoreStatistics)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->logoutFromGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required
grpid*
Long (int64)
The ID of the distribution group
Required
grpid-domain*
String
If stated, the domain of the organization to which the distribution group belongs. If omitted, this is assumed to be the same as <b>domain</b>
Required
Query parameters
Name Description
ignoreStatistics
Boolean
Don't include statistics and immediately return an empty response.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


subscribeForQueueStatistics

Subscribe to queue statistics

Produces a SSE stream of queue statistic updates in application/telepo-queue-statistics+xml format. The stream will only contain updates to the queues that the user is a member of.


/user/distgroup/v1/{domain}/{user}/statistics

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/event-stream"\
"/api//user/distgroup/v1/{domain}/{user}/statistics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        try {
            apiInstance.subscribeForQueueStatistics(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#subscribeForQueueStatistics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        try {
            apiInstance.subscribeForQueueStatistics(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#subscribeForQueueStatistics");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user

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

// Subscribe to queue statistics
[apiInstance subscribeForQueueStatisticsWith:domain
    user:user
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeForQueueStatistics(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DistributionGroupApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user

            try
            {
                // Subscribe to queue statistics
                apiInstance.subscribeForQueueStatistics(domain, user);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.subscribeForQueueStatistics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user

try {
    $api_instance->subscribeForQueueStatistics($domain, $user);
} catch (Exception $e) {
    echo 'Exception when calling DistributionGroupApi->subscribeForQueueStatistics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DistributionGroupApi;


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user

eval { 
    $api_instance->subscribeForQueueStatistics(domain => $domain, user => $user);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->subscribeForQueueStatistics: $@\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.DistributionGroupApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user

try: 
    # Subscribe to queue statistics
    api_instance.subscribe_for_queue_statistics(domain, user)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->subscribeForQueueStatistics: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateCallHistoryItem

Assign call

Assign a call in a group call log to a user.


/user/distgroup/{domain}/{user}/calllog/{itemid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//user/distgroup/{domain}/{user}/calllog/{itemid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DistributionGroupApi;

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

public class DistributionGroupApiExample {

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


        DistributionGroupApi apiInstance = new DistributionGroupApi();
        HandledStatus body = ; // HandledStatus | 
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        Long itemid = 789; // Long | The ID of the group call log item to assign to the user
        try {
            callLogItem result = apiInstance.updateCallHistoryItem(body, domain, user, itemid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#updateCallHistoryItem");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DistributionGroupApi;

public class DistributionGroupApiExample {

    public static void main(String[] args) {
        DistributionGroupApi apiInstance = new DistributionGroupApi();
        HandledStatus body = ; // HandledStatus | 
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The ID of the user
        Long itemid = 789; // Long | The ID of the group call log item to assign to the user
        try {
            callLogItem result = apiInstance.updateCallHistoryItem(body, domain, user, itemid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistributionGroupApi#updateCallHistoryItem");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
HandledStatus *body = ; // 
String *domain = domain_example; // The domain of the user
String *user = user_example; // The ID of the user
Long *itemid = 789; // The ID of the group call log item to assign to the user

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

// Assign call
[apiInstance updateCallHistoryItemWith:body
    domain:domain
    user:user
    itemid:itemid
              completionHandler: ^(callLogItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DistributionGroupApi()
var body = ; // {{HandledStatus}} 
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The ID of the user
var itemid = 789; // {{Long}} The ID of the group call log item to assign to the user

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

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


            var apiInstance = new DistributionGroupApi();
            var body = new HandledStatus(); // HandledStatus | 
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The ID of the user
            var itemid = 789;  // Long | The ID of the group call log item to assign to the user

            try
            {
                // Assign call
                callLogItem result = apiInstance.updateCallHistoryItem(body, domain, user, itemid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DistributionGroupApi.updateCallHistoryItem: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDistributionGroupApi();
$body = ; // HandledStatus | 
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The ID of the user
$itemid = 789; // Long | The ID of the group call log item to assign to the user

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


my $api_instance = WWW::SwaggerClient::DistributionGroupApi->new();
my $body = WWW::SwaggerClient::Object::HandledStatus->new(); # HandledStatus | 
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The ID of the user
my $itemid = 789; # Long | The ID of the group call log item to assign to the user

eval { 
    my $result = $api_instance->updateCallHistoryItem(body => $body, domain => $domain, user => $user, itemid => $itemid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DistributionGroupApi->updateCallHistoryItem: $@\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.DistributionGroupApi()
body =  # HandledStatus | 
domain = domain_example # String | The domain of the user
user = user_example # String | The ID of the user
itemid = 789 # Long | The ID of the group call log item to assign to the user

try: 
    # Assign call
    api_response = api_instance.update_call_history_item(body, domain, user, itemid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DistributionGroupApi->updateCallHistoryItem: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The ID of the user
Required
itemid*
Long (int64)
The ID of the group call log item to assign to the user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


Diversion

addUpdateUserDiversionRules

Set diversion rules

Updates the user's defined diversion rules for available lines.<br>Both POST and PUT can be used in the request.


/diversion/{domain}/{userId}/rules

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        Diversion body = {
  "user" : {
    "domain" : "example.com",
    "userid" : "albo"
  },
  "userDiversionLineRules" : [ {
    "lineNumber" : "+123460000",
    "lineOrderType" : "PRIMARY",
    "lineType" : "OFFICE_FIXED",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  }, {
    "lineNumber" : "+123467890",
    "lineOrderType" : "SECONDARY",
    "lineType" : "OFFICE_MOBILE",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  } ]
}; // Diversion | 
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.addUpdateUserDiversionRules(body, userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#addUpdateUserDiversionRules");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        Diversion body = {
  "user" : {
    "domain" : "example.com",
    "userid" : "albo"
  },
  "userDiversionLineRules" : [ {
    "lineNumber" : "+123460000",
    "lineOrderType" : "PRIMARY",
    "lineType" : "OFFICE_FIXED",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  }, {
    "lineNumber" : "+123467890",
    "lineOrderType" : "SECONDARY",
    "lineType" : "OFFICE_MOBILE",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  } ]
}; // Diversion | 
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.addUpdateUserDiversionRules(body, userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#addUpdateUserDiversionRules");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Diversion *body = {
  "user" : {
    "domain" : "example.com",
    "userid" : "albo"
  },
  "userDiversionLineRules" : [ {
    "lineNumber" : "+123460000",
    "lineOrderType" : "PRIMARY",
    "lineType" : "OFFICE_FIXED",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  }, {
    "lineNumber" : "+123467890",
    "lineOrderType" : "SECONDARY",
    "lineType" : "OFFICE_MOBILE",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  } ]
}; // 
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Set diversion rules
[apiInstance addUpdateUserDiversionRulesWith:body
    userId:userId
    domain:domain
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var body = {
  "user" : {
    "domain" : "example.com",
    "userid" : "albo"
  },
  "userDiversionLineRules" : [ {
    "lineNumber" : "+123460000",
    "lineOrderType" : "PRIMARY",
    "lineType" : "OFFICE_FIXED",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  }, {
    "lineNumber" : "+123467890",
    "lineOrderType" : "SECONDARY",
    "lineType" : "OFFICE_MOBILE",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  } ]
}; // {{Diversion}} 
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

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

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


            var apiInstance = new DiversionApi();
            var body = new Diversion(); // Diversion | 
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Set diversion rules
                apiInstance.addUpdateUserDiversionRules(body, userId, domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiversionApi.addUpdateUserDiversionRules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$body = {
  "user" : {
    "domain" : "example.com",
    "userid" : "albo"
  },
  "userDiversionLineRules" : [ {
    "lineNumber" : "+123460000",
    "lineOrderType" : "PRIMARY",
    "lineType" : "OFFICE_FIXED",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  }, {
    "lineNumber" : "+123467890",
    "lineOrderType" : "SECONDARY",
    "lineType" : "OFFICE_MOBILE",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  } ]
}; // Diversion | 
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $api_instance->addUpdateUserDiversionRules($body, $userId, $domain);
} catch (Exception $e) {
    echo 'Exception when calling DiversionApi->addUpdateUserDiversionRules: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $body = WWW::SwaggerClient::Object::Diversion->new(); # Diversion | 
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    $api_instance->addUpdateUserDiversionRules(body => $body, userId => $userId, domain => $domain);
};
if ($@) {
    warn "Exception when calling DiversionApi->addUpdateUserDiversionRules: $@\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.DiversionApi()
body = {
  "user" : {
    "domain" : "example.com",
    "userid" : "albo"
  },
  "userDiversionLineRules" : [ {
    "lineNumber" : "+123460000",
    "lineOrderType" : "PRIMARY",
    "lineType" : "OFFICE_FIXED",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  }, {
    "lineNumber" : "+123467890",
    "lineOrderType" : "SECONDARY",
    "lineType" : "OFFICE_MOBILE",
    "userDiversionRules" : [ {
      "diversionRoutingRulesType" : "CFWD_ALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_ON_BUSY_OR_UNREACHABLE"
    }, {
      "phoneNumber" : "+12345678",
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER"
    }, {
      "diversionRoutingRulesType" : "CFWD_NO_ANSWER_OR_UNREACHABLE"
    }, {
      "diversionRoutingRulesType" : "CFWD_UNREACHABLE"
    } ]
  } ]
} # Diversion | 
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Set diversion rules
    api_instance.add_update_user_diversion_rules(body, userId, domain)
except ApiException as e:
    print("Exception when calling DiversionApi->addUpdateUserDiversionRules: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteDiversionRuleForLine

Delete diversion rule for line order

Deletes a user's defined diversion rule for a line order type.


/diversion/{domain}/{userId}/rules/{lineOrderType}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules/{lineOrderType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.deleteDiversionRuleForLine(userId, domain, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#deleteDiversionRuleForLine"); e.printStackTrace(); } } }
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.deleteDiversionRuleForLine(userId, domain, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#deleteDiversionRuleForLine"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *lineOrderType = lineOrderType_example; // User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line DiversionApi *apiInstance = [[DiversionApi alloc] init]; // Delete diversion rule for line order [apiInstance deleteDiversionRuleForLineWith:userId domain:domain lineOrderType:lineOrderType completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var lineOrderType = lineOrderType_example; // {{String}} User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.deleteDiversionRuleForLine(userId, domain, lineOrderType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var lineOrderType = lineOrderType_example;  // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { // Delete diversion rule for line order apiInstance.deleteDiversionRuleForLine(userId, domain, lineOrderType); } catch (Exception e) { Debug.Print("Exception when calling DiversionApi.deleteDiversionRuleForLine: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { $api_instance->deleteDiversionRuleForLine($userId, $domain, $lineOrderType); } catch (Exception $e) { echo 'Exception when calling DiversionApi->deleteDiversionRuleForLine: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $lineOrderType = lineOrderType_example; # String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line eval { $api_instance->deleteDiversionRuleForLine(userId => $userId, domain => $domain, lineOrderType => $lineOrderType); }; if ($@) { warn "Exception when calling DiversionApi->deleteDiversionRuleForLine: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
lineOrderType = lineOrderType_example # String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try: # Delete diversion rule for line order api_instance.delete_diversion_rule_for_line(userId, domain, lineOrderType) except ApiException as e: print("Exception when calling DiversionApi->deleteDiversionRuleForLine: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
lineOrderType*
String
User line order for which diversion rules shall be deleted. Possible values are:<br>PRIMARY - Primary line<br>SECONDARY - Secondary line
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteDiversionRuleForLineAndType

Delete diversion for rule

Deletes a user's defined diversion rule for a pre-defined diversion rule type.


/diversion/{domain}/{userId}/rules/{lineOrderType}/{diversionRuleType}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules/{lineOrderType}/{diversionRuleType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String diversionRuleType = diversionRuleType_example; // String | The diversion rule type for which diversion shall be deleted
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.deleteDiversionRuleForLineAndType(userId, domain, diversionRuleType, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#deleteDiversionRuleForLineAndType"); e.printStackTrace(); } } }
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String diversionRuleType = diversionRuleType_example; // String | The diversion rule type for which diversion shall be deleted
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.deleteDiversionRuleForLineAndType(userId, domain, diversionRuleType, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#deleteDiversionRuleForLineAndType"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *diversionRuleType = diversionRuleType_example; // The diversion rule type for which diversion shall be deleted
String *lineOrderType = lineOrderType_example; // User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line DiversionApi *apiInstance = [[DiversionApi alloc] init]; // Delete diversion for rule [apiInstance deleteDiversionRuleForLineAndTypeWith:userId domain:domain diversionRuleType:diversionRuleType lineOrderType:lineOrderType completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var diversionRuleType = diversionRuleType_example; // {{String}} The diversion rule type for which diversion shall be deleted
var lineOrderType = lineOrderType_example; // {{String}} User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.deleteDiversionRuleForLineAndType(userId, domain, diversionRuleType, lineOrderType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var diversionRuleType = diversionRuleType_example;  // String | The diversion rule type for which diversion shall be deleted
            var lineOrderType = lineOrderType_example;  // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { // Delete diversion for rule apiInstance.deleteDiversionRuleForLineAndType(userId, domain, diversionRuleType, lineOrderType); } catch (Exception e) { Debug.Print("Exception when calling DiversionApi.deleteDiversionRuleForLineAndType: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$diversionRuleType = diversionRuleType_example; // String | The diversion rule type for which diversion shall be deleted
$lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { $api_instance->deleteDiversionRuleForLineAndType($userId, $domain, $diversionRuleType, $lineOrderType); } catch (Exception $e) { echo 'Exception when calling DiversionApi->deleteDiversionRuleForLineAndType: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $diversionRuleType = diversionRuleType_example; # String | The diversion rule type for which diversion shall be deleted
my $lineOrderType = lineOrderType_example; # String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line eval { $api_instance->deleteDiversionRuleForLineAndType(userId => $userId, domain => $domain, diversionRuleType => $diversionRuleType, lineOrderType => $lineOrderType); }; if ($@) { warn "Exception when calling DiversionApi->deleteDiversionRuleForLineAndType: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
diversionRuleType = diversionRuleType_example # String | The diversion rule type for which diversion shall be deleted
lineOrderType = lineOrderType_example # String | User line order for which diversion rules shall be deleted. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try: # Delete diversion for rule api_instance.delete_diversion_rule_for_line_and_type(userId, domain, diversionRuleType, lineOrderType) except ApiException as e: print("Exception when calling DiversionApi->deleteDiversionRuleForLineAndType: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
diversionRuleType*
String
The diversion rule type for which diversion shall be deleted
Required
lineOrderType*
String
User line order for which diversion rules shall be deleted. Possible values are:<br>PRIMARY - Primary line<br>SECONDARY - Secondary line
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - No diversion rules found for requested diversionRuleType


deleteDiversionRuleForUser

Delete diversion rule

Deletes a user's defined diversion rules.


/diversion/{domain}/{userId}/rules

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.deleteDiversionRuleForUser(userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#deleteDiversionRuleForUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.deleteDiversionRuleForUser(userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#deleteDiversionRuleForUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Delete diversion rule
[apiInstance deleteDiversionRuleForUserWith:userId
    domain:domain
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDiversionRuleForUser(userId, domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Delete diversion rule
                apiInstance.deleteDiversionRuleForUser(userId, domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiversionApi.deleteDiversionRuleForUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $api_instance->deleteDiversionRuleForUser($userId, $domain);
} catch (Exception $e) {
    echo 'Exception when calling DiversionApi->deleteDiversionRuleForUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    $api_instance->deleteDiversionRuleForUser(userId => $userId, domain => $domain);
};
if ($@) {
    warn "Exception when calling DiversionApi->deleteDiversionRuleForUser: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Delete diversion rule
    api_instance.delete_diversion_rule_for_user(userId, domain)
except ApiException as e:
    print("Exception when calling DiversionApi->deleteDiversionRuleForUser: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getAllUserDiversionCallRoutingRules

Get diversion rules

Retrieves a user's diversion rules.


/diversion/{domain}/{userId}/rules

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            diversion result = apiInstance.getAllUserDiversionCallRoutingRules(userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#getAllUserDiversionCallRoutingRules");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            diversion result = apiInstance.getAllUserDiversionCallRoutingRules(userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#getAllUserDiversionCallRoutingRules");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Get diversion rules
[apiInstance getAllUserDiversionCallRoutingRulesWith:userId
    domain:domain
              completionHandler: ^(diversion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

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

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Get diversion rules
                diversion result = apiInstance.getAllUserDiversionCallRoutingRules(userId, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiversionApi.getAllUserDiversionCallRoutingRules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

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


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    my $result = $api_instance->getAllUserDiversionCallRoutingRules(userId => $userId, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiversionApi->getAllUserDiversionCallRoutingRules: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Get diversion rules
    api_response = api_instance.get_all_user_diversion_call_routing_rules(userId, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiversionApi->getAllUserDiversionCallRoutingRules: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

{"user":{"domain":"example.com","userid":"albo"},"userDiversionLineRules":[{"lineNumber":"+123460000","lineOrderType":"PRIMARY","lineType":"OFFICE_FIXED","userDiversionRules":[{"diversionRoutingRulesType":"CFWD_ALL"},{"phoneNumber":"+12345679","diversionRoutingRulesType":"CFWD_ON_BUSY"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_OR_UNREACHABLE"},{"phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"},{"diversionRoutingRulesType":"CFWD_NO_ANSWER_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_UNREACHABLE"}]},{"lineNumber":"+123467890","lineOrderType":"SECONDARY","lineType":"OFFICE_MOBILE","userDiversionRules":[{"diversionRoutingRulesType":"CFWD_ALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_OR_UNREACHABLE"},{"phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"},{"diversionRoutingRulesType":"CFWD_NO_ANSWER_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_UNREACHABLE"}]}]}
{"user":{"domain":"example.com","userid":"albo"},"userDiversionLineRules":[{"lineNumber":"+123460000","lineOrderType":"PRIMARY","lineType":"OFFICE_FIXED","userDiversionRules":[{"diversionRoutingRulesType":"CFWD_ALL"},{"phoneNumber":"+12345679","diversionRoutingRulesType":"CFWD_ON_BUSY"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_OR_UNREACHABLE"},{"phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"},{"diversionRoutingRulesType":"CFWD_NO_ANSWER_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_UNREACHABLE"}]},{"lineNumber":"+123467890","lineOrderType":"SECONDARY","lineType":"OFFICE_MOBILE","userDiversionRules":[{"diversionRoutingRulesType":"CFWD_ALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_OR_UNREACHABLE"},{"phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"},{"diversionRoutingRulesType":"CFWD_NO_ANSWER_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_UNREACHABLE"}]}]}

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


getAllUserLineDiversionCallRoutingRules

Get diversion by line order type

Retrieves a user's diversion rules for specified line order type.


/diversion/{domain}/{userId}/rules/{lineOrderType}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules/{lineOrderType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { diversion result = apiInstance.getAllUserLineDiversionCallRoutingRules(userId, domain, lineOrderType); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#getAllUserLineDiversionCallRoutingRules"); e.printStackTrace(); } } }
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { diversion result = apiInstance.getAllUserLineDiversionCallRoutingRules(userId, domain, lineOrderType); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#getAllUserLineDiversionCallRoutingRules"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *lineOrderType = lineOrderType_example; // User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line DiversionApi *apiInstance = [[DiversionApi alloc] init]; // Get diversion by line order type [apiInstance getAllUserLineDiversionCallRoutingRulesWith:userId domain:domain lineOrderType:lineOrderType completionHandler: ^(diversion output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var lineOrderType = lineOrderType_example; // {{String}} User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getAllUserLineDiversionCallRoutingRules(userId, domain, lineOrderType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var lineOrderType = lineOrderType_example;  // String | User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { // Get diversion by line order type diversion result = apiInstance.getAllUserLineDiversionCallRoutingRules(userId, domain, lineOrderType); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DiversionApi.getAllUserLineDiversionCallRoutingRules: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$lineOrderType = lineOrderType_example; // String | User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { $result = $api_instance->getAllUserLineDiversionCallRoutingRules($userId, $domain, $lineOrderType); print_r($result); } catch (Exception $e) { echo 'Exception when calling DiversionApi->getAllUserLineDiversionCallRoutingRules: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $lineOrderType = lineOrderType_example; # String | User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line eval { my $result = $api_instance->getAllUserLineDiversionCallRoutingRules(userId => $userId, domain => $domain, lineOrderType => $lineOrderType); print Dumper($result); }; if ($@) { warn "Exception when calling DiversionApi->getAllUserLineDiversionCallRoutingRules: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
lineOrderType = lineOrderType_example # String | User line order for which diversion details shall to be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try: # Get diversion by line order type api_response = api_instance.get_all_user_line_diversion_call_routing_rules(userId, domain, lineOrderType) pprint(api_response) except ApiException as e: print("Exception when calling DiversionApi->getAllUserLineDiversionCallRoutingRules: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
lineOrderType*
String
User line order for which diversion details shall to be fetched. Possible values are:<br>PRIMARY - Primary line<br>SECONDARY - Secondary line
Required

Responses

Status: 200 - OK

{"user":{"domain":"example.com","userid":"albo"},"userDiversionLineRules":[{"lineNumber":"+123460000","lineOrderType":"PRIMARY","lineType":"OFFICE_FIXED","userDiversionRules":[{"diversionRoutingRulesType":"CFWD_ALL"},{"phoneNumber":"+12345679","diversionRoutingRulesType":"CFWD_ON_BUSY"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_OR_UNREACHABLE"},{"phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"},{"diversionRoutingRulesType":"CFWD_NO_ANSWER_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_UNREACHABLE"}]}]}
{"user":{"domain":"example.com","userid":"albo"},"userDiversionLineRules":[{"lineNumber":"+123460000","lineOrderType":"PRIMARY","lineType":"OFFICE_FIXED","userDiversionRules":[{"diversionRoutingRulesType":"CFWD_ALL"},{"phoneNumber":"+12345679","diversionRoutingRulesType":"CFWD_ON_BUSY"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_IN_CALL_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_ON_BUSY_OR_UNREACHABLE"},{"phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"},{"diversionRoutingRulesType":"CFWD_NO_ANSWER_OR_UNREACHABLE"},{"diversionRoutingRulesType":"CFWD_UNREACHABLE"}]}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


getDiversion

Get active diversion number

Retrieves a user's active diversion number.


/diversion/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            Diversion result = apiInstance.getDiversion(userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#getDiversion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            Diversion result = apiInstance.getDiversion(userId, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#getDiversion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Get active diversion number
[apiInstance getDiversionWith:userId
    domain:domain
              completionHandler: ^(Diversion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

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

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Get active diversion number
                Diversion result = apiInstance.getDiversion(userId, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiversionApi.getDiversion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

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


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    my $result = $api_instance->getDiversion(userId => $userId, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiversionApi->getDiversion: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Get active diversion number
    api_response = api_instance.get_diversion(userId, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiversionApi->getDiversion: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

{"diversion-number":"+14423455"}
{"diversion-number":"+14423455"}

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


getDiversionRuleForRuleType

Get diversion for rule type

Retrieves a user's diversion rules for a specific line order and rule type.


/diversion/{domain}/{userId}/rules/{lineOrderType}/{diversionRuleType}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules/{lineOrderType}/{diversionRuleType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String diversionRuleType = diversionRuleType_example; // String | The diversion rule type for which details shall be fetched.
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { userDiversionRule result = apiInstance.getDiversionRuleForRuleType(userId, domain, diversionRuleType, lineOrderType); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#getDiversionRuleForRuleType"); e.printStackTrace(); } } }
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String diversionRuleType = diversionRuleType_example; // String | The diversion rule type for which details shall be fetched.
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { userDiversionRule result = apiInstance.getDiversionRuleForRuleType(userId, domain, diversionRuleType, lineOrderType); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#getDiversionRuleForRuleType"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *diversionRuleType = diversionRuleType_example; // The diversion rule type for which details shall be fetched.
String *lineOrderType = lineOrderType_example; // User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line DiversionApi *apiInstance = [[DiversionApi alloc] init]; // Get diversion for rule type [apiInstance getDiversionRuleForRuleTypeWith:userId domain:domain diversionRuleType:diversionRuleType lineOrderType:lineOrderType completionHandler: ^(userDiversionRule output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var diversionRuleType = diversionRuleType_example; // {{String}} The diversion rule type for which details shall be fetched.
var lineOrderType = lineOrderType_example; // {{String}} User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getDiversionRuleForRuleType(userId, domain, diversionRuleType, lineOrderType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var diversionRuleType = diversionRuleType_example;  // String | The diversion rule type for which details shall be fetched.
            var lineOrderType = lineOrderType_example;  // String | User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { // Get diversion for rule type userDiversionRule result = apiInstance.getDiversionRuleForRuleType(userId, domain, diversionRuleType, lineOrderType); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling DiversionApi.getDiversionRuleForRuleType: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$diversionRuleType = diversionRuleType_example; // String | The diversion rule type for which details shall be fetched.
$lineOrderType = lineOrderType_example; // String | User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { $result = $api_instance->getDiversionRuleForRuleType($userId, $domain, $diversionRuleType, $lineOrderType); print_r($result); } catch (Exception $e) { echo 'Exception when calling DiversionApi->getDiversionRuleForRuleType: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $diversionRuleType = diversionRuleType_example; # String | The diversion rule type for which details shall be fetched.
my $lineOrderType = lineOrderType_example; # String | User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line eval { my $result = $api_instance->getDiversionRuleForRuleType(userId => $userId, domain => $domain, diversionRuleType => $diversionRuleType, lineOrderType => $lineOrderType); print Dumper($result); }; if ($@) { warn "Exception when calling DiversionApi->getDiversionRuleForRuleType: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
diversionRuleType = diversionRuleType_example # String | The diversion rule type for which details shall be fetched.
lineOrderType = lineOrderType_example # String | User line order for which diversion details shall be fetched. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try: # Get diversion for rule type api_response = api_instance.get_diversion_rule_for_rule_type(userId, domain, diversionRuleType, lineOrderType) pprint(api_response) except ApiException as e: print("Exception when calling DiversionApi->getDiversionRuleForRuleType: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
diversionRuleType*
String
The diversion rule type for which details shall be fetched.
Required
lineOrderType*
String
User line order for which diversion details shall be fetched. Possible values are:<br>PRIMARY - Primary line<br>SECONDARY - Secondary line
Required

Responses

Status: 200 - OK

{"lineOrderType":"PRIMARY","phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"}
{"lineOrderType":"PRIMARY","phoneNumber":"+12345678","diversionRoutingRulesType":"CFWD_NO_ANSWER"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


removeDiversion

Delete diversion number

Clears a user's active diversion number.


/diversion/{domain}/{userId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//diversion/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.removeDiversion(userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#removeDiversion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            apiInstance.removeDiversion(userId, domain);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#removeDiversion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API

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

// Delete diversion number
[apiInstance removeDiversionWith:userId
    domain:domain
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeDiversion(userId, domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Delete diversion number
                apiInstance.removeDiversion(userId, domain);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiversionApi.removeDiversion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $api_instance->removeDiversion($userId, $domain);
} catch (Exception $e) {
    echo 'Exception when calling DiversionApi->removeDiversion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    $api_instance->removeDiversion(userId => $userId, domain => $domain);
};
if ($@) {
    warn "Exception when calling DiversionApi->removeDiversion: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Delete diversion number
    api_instance.remove_diversion(userId, domain)
except ApiException as e:
    print("Exception when calling DiversionApi->removeDiversion: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


setDiversionRuleForRuleType

Set diversion for rule type

Creates or updates a user's defined diversion rule for a pre-defined diversion rule type.<br>Both POST and PUT can be used in the request.


/diversion/{domain}/{userId}/rules/{lineOrderType}/{diversionRuleType}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules/{lineOrderType}/{diversionRuleType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        UserDiversionRule body = {
  "phoneNumber" : "+12345679",
  "diversionRoutingRulesType" : "CFWD_ON_BUSY"
}; // UserDiversionRule | 
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String diversionRuleType = diversionRuleType_example; // String | The diversion rule type details shall be set for.
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.setDiversionRuleForRuleType(body, userId, domain, diversionRuleType, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#setDiversionRuleForRuleType"); e.printStackTrace(); } } }
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        UserDiversionRule body = {
  "phoneNumber" : "+12345679",
  "diversionRoutingRulesType" : "CFWD_ON_BUSY"
}; // UserDiversionRule | 
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String diversionRuleType = diversionRuleType_example; // String | The diversion rule type details shall be set for.
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.setDiversionRuleForRuleType(body, userId, domain, diversionRuleType, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#setDiversionRuleForRuleType"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
UserDiversionRule *body = {
  "phoneNumber" : "+12345679",
  "diversionRoutingRulesType" : "CFWD_ON_BUSY"
}; // 
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *diversionRuleType = diversionRuleType_example; // The diversion rule type details shall be set for.
String *lineOrderType = lineOrderType_example; // User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line DiversionApi *apiInstance = [[DiversionApi alloc] init]; // Set diversion for rule type [apiInstance setDiversionRuleForRuleTypeWith:body userId:userId domain:domain diversionRuleType:diversionRuleType lineOrderType:lineOrderType completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var body = {
  "phoneNumber" : "+12345679",
  "diversionRoutingRulesType" : "CFWD_ON_BUSY"
}; // {{UserDiversionRule}} 
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var diversionRuleType = diversionRuleType_example; // {{String}} The diversion rule type details shall be set for.
var lineOrderType = lineOrderType_example; // {{String}} User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.setDiversionRuleForRuleType(bodyuserIddomaindiversionRuleTypelineOrderType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var body = new UserDiversionRule(); // UserDiversionRule | 
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var diversionRuleType = diversionRuleType_example;  // String | The diversion rule type details shall be set for.
            var lineOrderType = lineOrderType_example;  // String | User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { // Set diversion for rule type apiInstance.setDiversionRuleForRuleType(body, userId, domain, diversionRuleType, lineOrderType); } catch (Exception e) { Debug.Print("Exception when calling DiversionApi.setDiversionRuleForRuleType: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$body = {
  "phoneNumber" : "+12345679",
  "diversionRoutingRulesType" : "CFWD_ON_BUSY"
}; // UserDiversionRule | 
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$diversionRuleType = diversionRuleType_example; // String | The diversion rule type details shall be set for.
$lineOrderType = lineOrderType_example; // String | User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { $api_instance->setDiversionRuleForRuleType($body, $userId, $domain, $diversionRuleType, $lineOrderType); } catch (Exception $e) { echo 'Exception when calling DiversionApi->setDiversionRuleForRuleType: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $body = WWW::SwaggerClient::Object::UserDiversionRule->new(); # UserDiversionRule | 
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $diversionRuleType = diversionRuleType_example; # String | The diversion rule type details shall be set for.
my $lineOrderType = lineOrderType_example; # String | User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line eval { $api_instance->setDiversionRuleForRuleType(body => $body, userId => $userId, domain => $domain, diversionRuleType => $diversionRuleType, lineOrderType => $lineOrderType); }; if ($@) { warn "Exception when calling DiversionApi->setDiversionRuleForRuleType: $@\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.DiversionApi()
body = {
  "phoneNumber" : "+12345679",
  "diversionRoutingRulesType" : "CFWD_ON_BUSY"
} # UserDiversionRule | 
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
diversionRuleType = diversionRuleType_example # String | The diversion rule type details shall be set for.
lineOrderType = lineOrderType_example # String | User line order for which diversion rules shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try: # Set diversion for rule type api_instance.set_diversion_rule_for_rule_type(body, userId, domain, diversionRuleType, lineOrderType) except ApiException as e: print("Exception when calling DiversionApi->setDiversionRuleForRuleType: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
diversionRuleType*
String
The diversion rule type details shall be set for.
Required
lineOrderType*
String
User line order for which diversion rules shall be set. Possible values are:<br>PRIMARY - Primary line<br>SECONDARY - Secondary line
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setDiversionRuleForUserLine

Set diversion for line order

Creates or updates a user's defined diversion rule for a pre-defined diversion rule type.<br>Both PUT and POST can be used in the request.


/diversion/{domain}/{userId}/rules/{lineOrderType}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//diversion/{domain}/{userId}/rules/{lineOrderType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        Diversion body = {
  "userDiversionLineRules" : [ {
    "userDiversionRules" : [ {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    } ]
  } ]
}; // Diversion | 
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.setDiversionRuleForUserLine(body, userId, domain, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#setDiversionRuleForUserLine"); e.printStackTrace(); } } }
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        Diversion body = {
  "userDiversionLineRules" : [ {
    "userDiversionRules" : [ {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    } ]
  } ]
}; // Diversion | 
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String lineOrderType = lineOrderType_example; // String | User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { apiInstance.setDiversionRuleForUserLine(body, userId, domain, lineOrderType); } catch (ApiException e) { System.err.println("Exception when calling DiversionApi#setDiversionRuleForUserLine"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
Diversion *body = {
  "userDiversionLineRules" : [ {
    "userDiversionRules" : [ {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    } ]
  } ]
}; // 
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *lineOrderType = lineOrderType_example; // User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line DiversionApi *apiInstance = [[DiversionApi alloc] init]; // Set diversion for line order [apiInstance setDiversionRuleForUserLineWith:body userId:userId domain:domain lineOrderType:lineOrderType completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var body = {
  "userDiversionLineRules" : [ {
    "userDiversionRules" : [ {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    } ]
  } ]
}; // {{Diversion}} 
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var lineOrderType = lineOrderType_example; // {{String}} User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.setDiversionRuleForUserLine(bodyuserIddomainlineOrderType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var body = new Diversion(); // Diversion | 
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var lineOrderType = lineOrderType_example;  // String | User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { // Set diversion for line order apiInstance.setDiversionRuleForUserLine(body, userId, domain, lineOrderType); } catch (Exception e) { Debug.Print("Exception when calling DiversionApi.setDiversionRuleForUserLine: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$body = {
  "userDiversionLineRules" : [ {
    "userDiversionRules" : [ {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    } ]
  } ]
}; // Diversion | 
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$lineOrderType = lineOrderType_example; // String | User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try { $api_instance->setDiversionRuleForUserLine($body, $userId, $domain, $lineOrderType); } catch (Exception $e) { echo 'Exception when calling DiversionApi->setDiversionRuleForUserLine: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $body = WWW::SwaggerClient::Object::Diversion->new(); # Diversion | 
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $lineOrderType = lineOrderType_example; # String | User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line eval { $api_instance->setDiversionRuleForUserLine(body => $body, userId => $userId, domain => $domain, lineOrderType => $lineOrderType); }; if ($@) { warn "Exception when calling DiversionApi->setDiversionRuleForUserLine: $@\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.DiversionApi()
body = {
  "userDiversionLineRules" : [ {
    "userDiversionRules" : [ {
      "phoneNumber" : "+12345679",
      "diversionRoutingRulesType" : "CFWD_ON_BUSY"
    } ]
  } ]
} # Diversion | 
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
lineOrderType = lineOrderType_example # String | User line order for which diversion shall be set. Possible values are:
PRIMARY - Primary line
SECONDARY - Secondary line try: # Set diversion for line order api_instance.set_diversion_rule_for_user_line(body, userId, domain, lineOrderType) except ApiException as e: print("Exception when calling DiversionApi->setDiversionRuleForUserLine: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
lineOrderType*
String
User line order for which diversion shall be set. Possible values are:<br>PRIMARY - Primary line<br>SECONDARY - Secondary line
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateDiversion

Set diversion number

Sets a user's active diversion number.<br>Both POST and PUT can be used in the request.


/diversion/{domain}/{userId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//diversion/{domain}/{userId}?phoneNumber=&activityScoped="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DiversionApi;

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

public class DiversionApiExample {

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


        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String phoneNumber = phoneNumber_example; // String | The diversion number
        Boolean activityScoped = true; // Boolean | Set to true if the diversion number should be cleared after a change of presence activity.
        try {
            Diversion result = apiInstance.updateDiversion(userId, domain, phoneNumber, activityScoped);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#updateDiversion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DiversionApi;

public class DiversionApiExample {

    public static void main(String[] args) {
        DiversionApi apiInstance = new DiversionApi();
        String userId = userId_example; // String | The username of the user accessing the API
        String domain = domain_example; // String | The domain of the user accessing the API
        String phoneNumber = phoneNumber_example; // String | The diversion number
        Boolean activityScoped = true; // Boolean | Set to true if the diversion number should be cleared after a change of presence activity.
        try {
            Diversion result = apiInstance.updateDiversion(userId, domain, phoneNumber, activityScoped);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiversionApi#updateDiversion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *userId = userId_example; // The username of the user accessing the API
String *domain = domain_example; // The domain of the user accessing the API
String *phoneNumber = phoneNumber_example; // The diversion number
Boolean *activityScoped = true; // Set to true if the diversion number should be cleared after a change of presence activity. (optional)

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

// Set diversion number
[apiInstance updateDiversionWith:userId
    domain:domain
    phoneNumber:phoneNumber
    activityScoped:activityScoped
              completionHandler: ^(Diversion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.DiversionApi()
var userId = userId_example; // {{String}} The username of the user accessing the API
var domain = domain_example; // {{String}} The domain of the user accessing the API
var phoneNumber = phoneNumber_example; // {{String}} The diversion number
var opts = { 
  'activityScoped': true // {{Boolean}} Set to true if the diversion number should be cleared after a change of presence activity.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDiversion(userId, domain, phoneNumber, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DiversionApi();
            var userId = userId_example;  // String | The username of the user accessing the API
            var domain = domain_example;  // String | The domain of the user accessing the API
            var phoneNumber = phoneNumber_example;  // String | The diversion number
            var activityScoped = true;  // Boolean | Set to true if the diversion number should be cleared after a change of presence activity. (optional) 

            try
            {
                // Set diversion number
                Diversion result = apiInstance.updateDiversion(userId, domain, phoneNumber, activityScoped);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DiversionApi.updateDiversion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDiversionApi();
$userId = userId_example; // String | The username of the user accessing the API
$domain = domain_example; // String | The domain of the user accessing the API
$phoneNumber = phoneNumber_example; // String | The diversion number
$activityScoped = true; // Boolean | Set to true if the diversion number should be cleared after a change of presence activity.

try {
    $result = $api_instance->updateDiversion($userId, $domain, $phoneNumber, $activityScoped);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiversionApi->updateDiversion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DiversionApi;


my $api_instance = WWW::SwaggerClient::DiversionApi->new();
my $userId = userId_example; # String | The username of the user accessing the API
my $domain = domain_example; # String | The domain of the user accessing the API
my $phoneNumber = phoneNumber_example; # String | The diversion number
my $activityScoped = true; # Boolean | Set to true if the diversion number should be cleared after a change of presence activity.

eval { 
    my $result = $api_instance->updateDiversion(userId => $userId, domain => $domain, phoneNumber => $phoneNumber, activityScoped => $activityScoped);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DiversionApi->updateDiversion: $@\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.DiversionApi()
userId = userId_example # String | The username of the user accessing the API
domain = domain_example # String | The domain of the user accessing the API
phoneNumber = phoneNumber_example # String | The diversion number
activityScoped = true # Boolean | Set to true if the diversion number should be cleared after a change of presence activity. (optional)

try: 
    # Set diversion number
    api_response = api_instance.update_diversion(userId, domain, phoneNumber, activityScoped=activityScoped)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiversionApi->updateDiversion: %s\n" % e)

Parameters

Path parameters
Name Description
userId*
String
The username of the user accessing the API
Required
domain*
String
The domain of the user accessing the API
Required
Query parameters
Name Description
phoneNumber*
String
The diversion number
Required
activityScoped
Boolean
Set to true if the diversion number should be cleared after a change of presence activity.

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Domain or user is not found


Event

deleteEvent

Delete event

Remove a specified event.


/event/v1/{domain}/{userId}/{eventId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to delete an event
        try {
            apiInstance.deleteEvent(domain, userId, eventId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#deleteEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to delete an event
        try {
            apiInstance.deleteEvent(domain, userId, eventId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#deleteEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *eventId = 789; // Event id to delete an event

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

// Delete event
[apiInstance deleteEventWith:domain
    userId:userId
    eventId:eventId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var eventId = 789; // {{Long}} Event id to delete an event

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteEvent(domain, userId, eventId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var eventId = 789;  // Long | Event id to delete an event

            try
            {
                // Delete event
                apiInstance.deleteEvent(domain, userId, eventId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.deleteEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$eventId = 789; // Long | Event id to delete an event

try {
    $api_instance->deleteEvent($domain, $userId, $eventId);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->deleteEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $eventId = 789; # Long | Event id to delete an event

eval { 
    $api_instance->deleteEvent(domain => $domain, userId => $userId, eventId => $eventId);
};
if ($@) {
    warn "Exception when calling EventApi->deleteEvent: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
eventId = 789 # Long | Event id to delete an event

try: 
    # Delete event
    api_instance.delete_event(domain, userId, eventId)
except ApiException as e:
    print("Exception when calling EventApi->deleteEvent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
eventId*
Long (int64)
Event id to delete an event
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteEventException

Delete instance

Remove a single event occurrence or an exception from a recurring event.


/event/v1/exception/{domain}/{userId}/{confId}/{eventDate}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/exception/{domain}/{userId}/{confId}/{eventDate}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long confId = 789; // Long | Event id to delete an event occurrence or exception
        String eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format
        try {
            eventexception result = apiInstance.deleteEventException(domain, userId, confId, eventDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#deleteEventException");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long confId = 789; // Long | Event id to delete an event occurrence or exception
        String eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format
        try {
            eventexception result = apiInstance.deleteEventException(domain, userId, confId, eventDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#deleteEventException");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *confId = 789; // Event id to delete an event occurrence or exception
String *eventDate = eventDate_example; // The date of the event instance in 'yyyy-MM-dd' format

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

// Delete instance
[apiInstance deleteEventExceptionWith:domain
    userId:userId
    confId:confId
    eventDate:eventDate
              completionHandler: ^(eventexception output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var confId = 789; // {{Long}} Event id to delete an event occurrence or exception
var eventDate = eventDate_example; // {{String}} The date of the event instance in 'yyyy-MM-dd' format

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var confId = 789;  // Long | Event id to delete an event occurrence or exception
            var eventDate = eventDate_example;  // String | The date of the event instance in 'yyyy-MM-dd' format

            try
            {
                // Delete instance
                eventexception result = apiInstance.deleteEventException(domain, userId, confId, eventDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.deleteEventException: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$confId = 789; // Long | Event id to delete an event occurrence or exception
$eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format

try {
    $result = $api_instance->deleteEventException($domain, $userId, $confId, $eventDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->deleteEventException: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $confId = 789; # Long | Event id to delete an event occurrence or exception
my $eventDate = eventDate_example; # String | The date of the event instance in 'yyyy-MM-dd' format

eval { 
    my $result = $api_instance->deleteEventException(domain => $domain, userId => $userId, confId => $confId, eventDate => $eventDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->deleteEventException: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
confId = 789 # Long | Event id to delete an event occurrence or exception
eventDate = eventDate_example # String | The date of the event instance in 'yyyy-MM-dd' format

try: 
    # Delete instance
    api_response = api_instance.delete_event_exception(domain, userId, confId, eventDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->deleteEventException: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
confId*
Long (int64)
Event id to delete an event occurrence or exception
Required
eventDate*
String
The date of the event instance in 'yyyy-MM-dd' format
Required

Responses

Status: 200 - OK

{"id":2,"dateTimeStart":"2022-04-10T12:38:39Z","dateTimeEnd":"2022-04-10T13:38:39Z","name":"Test meeting update","note":"Test meeting instance","isUpdated":false,"isCancelled":true,"eventId":1,"participants":[{}],"dateTimeOld":"2022-04-10T15:38:39Z"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getCtiTicket

Fetches a ticket for interacting with the conference call via the CTI API.


/event/v1/ctiticket/{domain}/{userId}/{confId}

Usage and SDK Samples

curl -X GET\
"/api//event/v1/ctiticket/{domain}/{userId}/{confId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

    public static void main(String[] args) {
        
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | Organization domain
        String userId = userId_example; // String | User Identification
        String confId = confId_example; // String | Event Identification
        try {
            apiInstance.getCtiTicket(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getCtiTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | Organization domain
        String userId = userId_example; // String | User Identification
        String confId = confId_example; // String | Event Identification
        try {
            apiInstance.getCtiTicket(domain, userId, confId);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getCtiTicket");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // Organization domain
String *userId = userId_example; // User Identification
String *confId = confId_example; // Event Identification

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

// Fetches a ticket for interacting with the conference call via the CTI API.
[apiInstance getCtiTicketWith:domain
    userId:userId
    confId:confId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} Organization domain
var userId = userId_example; // {{String}} User Identification
var confId = confId_example; // {{String}} Event Identification

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getCtiTicket(domain, userId, confId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new EventApi();
            var domain = domain_example;  // String | Organization domain
            var userId = userId_example;  // String | User Identification
            var confId = confId_example;  // String | Event Identification

            try
            {
                // Fetches a ticket for interacting with the conference call via the CTI API.
                apiInstance.getCtiTicket(domain, userId, confId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getCtiTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | Organization domain
$userId = userId_example; // String | User Identification
$confId = confId_example; // String | Event Identification

try {
    $api_instance->getCtiTicket($domain, $userId, $confId);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getCtiTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;

my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | Organization domain
my $userId = userId_example; # String | User Identification
my $confId = confId_example; # String | Event Identification

eval { 
    $api_instance->getCtiTicket(domain => $domain, userId => $userId, confId => $confId);
};
if ($@) {
    warn "Exception when calling EventApi->getCtiTicket: $@\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.EventApi()
domain = domain_example # String | Organization domain
userId = userId_example # String | User Identification
confId = confId_example # String | Event Identification

try: 
    # Fetches a ticket for interacting with the conference call via the CTI API.
    api_instance.get_cti_ticket(domain, userId, confId)
except ApiException as e:
    print("Exception when calling EventApi->getCtiTicket: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
Organization domain
Required
userId*
String
User Identification
Required
confId*
String
Event Identification
Required

Responses

Status: 200 - Success, the ticket is returned as string

Status: 403 - Requested method is not supported

Status: 404 - Domain, user or conference not found


getDialInNumbers1

Get conference numbers

Get available conference numbers for dialling in.


/event/v1/{domain}/{userId}/dialInNumbers

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/dialInNumbers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            'String' result = apiInstance.getDialInNumbers1(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getDialInNumbers1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            'String' result = apiInstance.getDialInNumbers1(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getDialInNumbers1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user

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

// Get conference numbers
[apiInstance getDialInNumbers1With:domain
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Get conference numbers
                'String' result = apiInstance.getDialInNumbers1(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getDialInNumbers1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user

eval { 
    my $result = $api_instance->getDialInNumbers1(domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getDialInNumbers1: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user

try: 
    # Get conference numbers
    api_response = api_instance.get_dial_in_numbers1(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getDialInNumbers1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required

Responses

Status: 200 - Success, returns a comma separated list with dial-in numbers

Status: 403 - Not Authorized

Status: 404 - Not Found


getEvent

Get event

Fetch a specified event.


/event/v1/{domain}/{userId}/{eventId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to fetch an event
        try {
            event result = apiInstance.getEvent(domain, userId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to fetch an event
        try {
            event result = apiInstance.getEvent(domain, userId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *eventId = 789; // Event id to fetch an event

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

// Get event
[apiInstance getEventWith:domain
    userId:userId
    eventId:eventId
              completionHandler: ^(event output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var eventId = 789; // {{Long}} Event id to fetch an event

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var eventId = 789;  // Long | Event id to fetch an event

            try
            {
                // Get event
                event result = apiInstance.getEvent(domain, userId, eventId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$eventId = 789; // Long | Event id to fetch an event

try {
    $result = $api_instance->getEvent($domain, $userId, $eventId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $eventId = 789; # Long | Event id to fetch an event

eval { 
    my $result = $api_instance->getEvent(domain => $domain, userId => $userId, eventId => $eventId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getEvent: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
eventId = 789 # Long | Event id to fetch an event

try: 
    # Get event
    api_response = api_instance.get_event(domain, userId, eventId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getEvent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
eventId*
Long (int64)
Event id to fetch an event
Required

Responses

Status: 200 - OK

{"endDate":"2022-04-24T15:38:39Z","id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"MONTHLY_ABSOLUTE","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":2,"recurrenceRangeType":"END_DATE","dayOfMonth":9,"weekPosition":"NONE","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=MONTHLY;INTERVAL=2;BYMONTHDAY=9;UNTIL=20220424T153839Z"}
{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"DAILY","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","weekPosition":"NONE","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=DAILY;INTERVAL=1"}
{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"MONTHLY_RELATIVE","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","daysOfWeek":["FR"],"weekPosition":"THIRD","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=MONTHLY;INTERVAL=1;BYSETPOS=3;BYDAY=FR"}
{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"NONE","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"recurrenceRangeType":"NONE","synchronizedMeeting":false}
{"endDate":"2022-04-24T15:38:39Z","id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"WEEKLY","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NUMBERED","daysOfWeek":["MO","TU","WE","TH","FR"],"weekPosition":"NONE","numberOfOccurrences":14,"exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;COUNT=14"}
{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"YEARLY_ABSOLUTE","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","dayOfMonth":3,"monthOfYear":10,"weekPosition":"NONE","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=YEARLY;INTERVAL=1;BYMONTH=10;BYMONTHDAY=3"}
{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"YEARLY_RELATIVE","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","daysOfWeek":["FR"],"monthOfYear":11,"weekPosition":"FIRST","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=YEARLY;INTERVAL=1;BYSETPOS=1;BYDAY=FR;BYMONTH=11"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getEvents

Get events

Fetch events for a specified user, where the user is either the organizer or a participant.


/event/v1/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            events result = apiInstance.getEvents(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            events result = apiInstance.getEvents(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user

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

// Get events
[apiInstance getEventsWith:domain
    userId:userId
              completionHandler: ^(events output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Get events
                events result = apiInstance.getEvents(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user

eval { 
    my $result = $api_instance->getEvents(domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getEvents: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user

try: 
    # Get events
    api_response = api_instance.get_events(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getEvents: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required

Responses

Status: 200 - OK

{"events":[{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"DAILY","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","weekPosition":"NONE","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=DAILY;INTERVAL=1"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found

Status: 504 - Failed to fetch event's webmeet details within 2.75 times the allowed response delay.


getEventsForBinder

Get stream events

Fetch events for a stream.


/event/v1/streams

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/streams?binder_id=&unique_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String binderId = binderId_example; // String | Stream identification
        String uniqueId = uniqueId_example; // String | Unique id of a user, can be either en email address or a mobile number
        try {
            events result = apiInstance.getEventsForBinder(binderId, uniqueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getEventsForBinder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String binderId = binderId_example; // String | Stream identification
        String uniqueId = uniqueId_example; // String | Unique id of a user, can be either en email address or a mobile number
        try {
            events result = apiInstance.getEventsForBinder(binderId, uniqueId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getEventsForBinder");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *binderId = binderId_example; // Stream identification
String *uniqueId = uniqueId_example; // Unique id of a user, can be either en email address or a mobile number

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

// Get stream events
[apiInstance getEventsForBinderWith:binderId
    uniqueId:uniqueId
              completionHandler: ^(events output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var binderId = binderId_example; // {{String}} Stream identification
var uniqueId = uniqueId_example; // {{String}} Unique id of a user, can be either en email address or a mobile number

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

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


            var apiInstance = new EventApi();
            var binderId = binderId_example;  // String | Stream identification
            var uniqueId = uniqueId_example;  // String | Unique id of a user, can be either en email address or a mobile number

            try
            {
                // Get stream events
                events result = apiInstance.getEventsForBinder(binderId, uniqueId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getEventsForBinder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$binderId = binderId_example; // String | Stream identification
$uniqueId = uniqueId_example; // String | Unique id of a user, can be either en email address or a mobile number

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $binderId = binderId_example; # String | Stream identification
my $uniqueId = uniqueId_example; # String | Unique id of a user, can be either en email address or a mobile number

eval { 
    my $result = $api_instance->getEventsForBinder(binderId => $binderId, uniqueId => $uniqueId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getEventsForBinder: $@\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.EventApi()
binderId = binderId_example # String | Stream identification
uniqueId = uniqueId_example # String | Unique id of a user, can be either en email address or a mobile number

try: 
    # Get stream events
    api_response = api_instance.get_events_for_binder(binderId, uniqueId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getEventsForBinder: %s\n" % e)

Parameters

Query parameters
Name Description
binder_id*
String
Stream identification
Required
unique_id*
String
Unique id of a user, can be either en email address or a mobile number
Required

Responses

Status: 200 - OK

{"events":[{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"DAILY","note":"Test meeting ongoing","dialInNumbers":"+46767676767,+46767611000,5752222","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","weekPosition":"NONE","exceptions":[null],"synchronizedMeeting":false,"rRule":"FREQ=DAILY;INTERVAL=1"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized


getFirstDayOfWeek

Get first workday

Fetches the first work day of week for given user/domain.


/event/v1/{domain}/{userId}/firstDayOfWeek

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/firstDayOfWeek"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            'String' result = apiInstance.getFirstDayOfWeek(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getFirstDayOfWeek");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            'String' result = apiInstance.getFirstDayOfWeek(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getFirstDayOfWeek");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user

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

// Get first workday
[apiInstance getFirstDayOfWeekWith:domain
    userId:userId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Get first workday
                'String' result = apiInstance.getFirstDayOfWeek(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getFirstDayOfWeek: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user

eval { 
    my $result = $api_instance->getFirstDayOfWeek(domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getFirstDayOfWeek: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user

try: 
    # Get first workday
    api_response = api_instance.get_first_day_of_week(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getFirstDayOfWeek: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required

Responses

Status: 200 - Success, the day is returned as string, MO for Monday and SU for Sunday

Status: 403 - Not Authorized

Status: 404 - Not Found


getSingleEventException

Get instance

Get the details of a single occurrence or exception from a recurring event.


/event/v1/exception/{domain}/{userId}/{confId}/{eventDate}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/exception/{domain}/{userId}/{confId}/{eventDate}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long confId = 789; // Long | Event id to fetch an occurrence or exception
        String eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format
        try {
            eventexception result = apiInstance.getSingleEventException(domain, userId, confId, eventDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getSingleEventException");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long confId = 789; // Long | Event id to fetch an occurrence or exception
        String eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format
        try {
            eventexception result = apiInstance.getSingleEventException(domain, userId, confId, eventDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getSingleEventException");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *confId = 789; // Event id to fetch an occurrence or exception
String *eventDate = eventDate_example; // The date of the event instance in 'yyyy-MM-dd' format

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

// Get instance
[apiInstance getSingleEventExceptionWith:domain
    userId:userId
    confId:confId
    eventDate:eventDate
              completionHandler: ^(eventexception output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var confId = 789; // {{Long}} Event id to fetch an occurrence or exception
var eventDate = eventDate_example; // {{String}} The date of the event instance in 'yyyy-MM-dd' format

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var confId = 789;  // Long | Event id to fetch an occurrence or exception
            var eventDate = eventDate_example;  // String | The date of the event instance in 'yyyy-MM-dd' format

            try
            {
                // Get instance
                eventexception result = apiInstance.getSingleEventException(domain, userId, confId, eventDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getSingleEventException: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$confId = 789; // Long | Event id to fetch an occurrence or exception
$eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format

try {
    $result = $api_instance->getSingleEventException($domain, $userId, $confId, $eventDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getSingleEventException: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $confId = 789; # Long | Event id to fetch an occurrence or exception
my $eventDate = eventDate_example; # String | The date of the event instance in 'yyyy-MM-dd' format

eval { 
    my $result = $api_instance->getSingleEventException(domain => $domain, userId => $userId, confId => $confId, eventDate => $eventDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getSingleEventException: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
confId = 789 # Long | Event id to fetch an occurrence or exception
eventDate = eventDate_example # String | The date of the event instance in 'yyyy-MM-dd' format

try: 
    # Get instance
    api_response = api_instance.get_single_event_exception(domain, userId, confId, eventDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getSingleEventException: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
confId*
Long (int64)
Event id to fetch an occurrence or exception
Required
eventDate*
String
The date of the event instance in 'yyyy-MM-dd' format
Required

Responses

Status: 200 - OK

{"id":1,"dateTimeStart":"2022-04-10T12:38:39Z","dateTimeEnd":"2022-04-10T13:38:39Z","name":"Test meeting update","note":"Test meeting instance","isUpdated":true,"isCancelled":false,"eventId":1,"organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"dateTimeOld":"2022-04-10T15:38:39Z"}
{"id":2,"dateTimeStart":"2022-04-10T12:38:39Z","dateTimeEnd":"2022-04-10T13:38:39Z","name":"Test meeting update","note":"Test meeting instance","isUpdated":false,"isCancelled":true,"eventId":1,"participants":[{}],"dateTimeOld":"2022-04-10T15:38:39Z"}
{"dateTimeStart":"2022-04-10T12:38:39Z","dateTimeEnd":"2022-04-10T13:38:39Z","name":"Test meeting update","note":"Test meeting instance","isUpdated":true,"isCancelled":false,"eventId":1,"organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getWebmeetForEvent

Get web meet

Get a web meeting.


/event/v1/{domain}/{userId}/{eventId}/webmeet

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/{eventId}/webmeet"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to fetch a web meet
        try {
            WebmeetDTO result = apiInstance.getWebmeetForEvent(domain, userId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getWebmeetForEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to fetch a web meet
        try {
            WebmeetDTO result = apiInstance.getWebmeetForEvent(domain, userId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#getWebmeetForEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *eventId = 789; // Event id to fetch a web meet

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

// Get web meet
[apiInstance getWebmeetForEventWith:domain
    userId:userId
    eventId:eventId
              completionHandler: ^(WebmeetDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var eventId = 789; // {{Long}} Event id to fetch a web meet

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var eventId = 789;  // Long | Event id to fetch a web meet

            try
            {
                // Get web meet
                WebmeetDTO result = apiInstance.getWebmeetForEvent(domain, userId, eventId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.getWebmeetForEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$eventId = 789; // Long | Event id to fetch a web meet

try {
    $result = $api_instance->getWebmeetForEvent($domain, $userId, $eventId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->getWebmeetForEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $eventId = 789; # Long | Event id to fetch a web meet

eval { 
    my $result = $api_instance->getWebmeetForEvent(domain => $domain, userId => $userId, eventId => $eventId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->getWebmeetForEvent: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
eventId = 789 # Long | Event id to fetch a web meet

try: 
    # Get web meet
    api_response = api_instance.get_webmeet_for_event(domain, userId, eventId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->getWebmeetForEvent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
eventId*
Long (int64)
Event id to fetch a web meet
Required

Responses

Status: 200 - OK

{"data":{"id":"654297226"},"code":"RESPONSE_SUCCESS"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found

Status: 504 - Failed to fetch event's webmeet details within 2.75 times the allowed response delay.


initializeConferenceWithNumber1

Join conference

Join conference call on user's answer place.


/event/v1/{domain}/{userId}/{eventId}/join

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/{eventId}/join?answerPlace=&sipInstance=&autoAnswer=&selectedDeviceID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to join a conference
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        String autoAnswer = autoAnswer_example; // String | Auto answer on user device
        String selectedDeviceID = selectedDeviceID_example; // String | The Device ID of the user agent
        try {
            apiInstance.initializeConferenceWithNumber1(domain, userId, eventId, answerPlace, sipInstance, autoAnswer, selectedDeviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#initializeConferenceWithNumber1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to join a conference
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        String autoAnswer = autoAnswer_example; // String | Auto answer on user device
        String selectedDeviceID = selectedDeviceID_example; // String | The Device ID of the user agent
        try {
            apiInstance.initializeConferenceWithNumber1(domain, userId, eventId, answerPlace, sipInstance, autoAnswer, selectedDeviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#initializeConferenceWithNumber1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *eventId = 789; // Event id to join a conference
String *answerPlace = answerPlace_example; // The register user device name (optional)
String *sipInstance = sipInstance_example; // Instance Id (sipInstance) of the user agent (optional)
String *autoAnswer = autoAnswer_example; // Auto answer on user device (optional)
String *selectedDeviceID = selectedDeviceID_example; // The Device ID of the user agent (optional)

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

// Join conference
[apiInstance initializeConferenceWithNumber1With:domain
    userId:userId
    eventId:eventId
    answerPlace:answerPlace
    sipInstance:sipInstance
    autoAnswer:autoAnswer
    selectedDeviceID:selectedDeviceID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var eventId = 789; // {{Long}} Event id to join a conference
var opts = { 
  'answerPlace': answerPlace_example, // {{String}} The register user device name
  'sipInstance': sipInstance_example, // {{String}} Instance Id (sipInstance) of the user agent
  'autoAnswer': autoAnswer_example, // {{String}} Auto answer on user device
  'selectedDeviceID': selectedDeviceID_example // {{String}} The Device ID of the user agent
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.initializeConferenceWithNumber1(domain, userId, eventId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var eventId = 789;  // Long | Event id to join a conference
            var answerPlace = answerPlace_example;  // String | The register user device name (optional) 
            var sipInstance = sipInstance_example;  // String | Instance Id (sipInstance) of the user agent (optional) 
            var autoAnswer = autoAnswer_example;  // String | Auto answer on user device (optional) 
            var selectedDeviceID = selectedDeviceID_example;  // String | The Device ID of the user agent (optional) 

            try
            {
                // Join conference
                apiInstance.initializeConferenceWithNumber1(domain, userId, eventId, answerPlace, sipInstance, autoAnswer, selectedDeviceID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.initializeConferenceWithNumber1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$eventId = 789; // Long | Event id to join a conference
$answerPlace = answerPlace_example; // String | The register user device name
$sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
$autoAnswer = autoAnswer_example; // String | Auto answer on user device
$selectedDeviceID = selectedDeviceID_example; // String | The Device ID of the user agent

try {
    $api_instance->initializeConferenceWithNumber1($domain, $userId, $eventId, $answerPlace, $sipInstance, $autoAnswer, $selectedDeviceID);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->initializeConferenceWithNumber1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $eventId = 789; # Long | Event id to join a conference
my $answerPlace = answerPlace_example; # String | The register user device name
my $sipInstance = sipInstance_example; # String | Instance Id (sipInstance) of the user agent
my $autoAnswer = autoAnswer_example; # String | Auto answer on user device
my $selectedDeviceID = selectedDeviceID_example; # String | The Device ID of the user agent

eval { 
    $api_instance->initializeConferenceWithNumber1(domain => $domain, userId => $userId, eventId => $eventId, answerPlace => $answerPlace, sipInstance => $sipInstance, autoAnswer => $autoAnswer, selectedDeviceID => $selectedDeviceID);
};
if ($@) {
    warn "Exception when calling EventApi->initializeConferenceWithNumber1: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
eventId = 789 # Long | Event id to join a conference
answerPlace = answerPlace_example # String | The register user device name (optional)
sipInstance = sipInstance_example # String | Instance Id (sipInstance) of the user agent (optional)
autoAnswer = autoAnswer_example # String | Auto answer on user device (optional)
selectedDeviceID = selectedDeviceID_example # String | The Device ID of the user agent (optional)

try: 
    # Join conference
    api_instance.initialize_conference_with_number1(domain, userId, eventId, answerPlace=answerPlace, sipInstance=sipInstance, autoAnswer=autoAnswer, selectedDeviceID=selectedDeviceID)
except ApiException as e:
    print("Exception when calling EventApi->initializeConferenceWithNumber1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
eventId*
Long (int64)
Event id to join a conference
Required
Query parameters
Name Description
answerPlace
String
The register user device name
sipInstance
String
Instance Id (sipInstance) of the user agent
autoAnswer
String
Auto answer on user device
selectedDeviceID
String
The Device ID of the user agent

Responses

Status: 200 - OK

Status: 202 - The join conference call setup has been initiated, but the processing has not been completed

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


isEnhancedConferenceSupported

Enhanced conference enabled status

Returns true if the organization is using enhanced conferencing, false otherwise.


/event/v1/supported/{domain}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/supported/{domain}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.isEnhancedConferenceSupported(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#isEnhancedConferenceSupported");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.isEnhancedConferenceSupported(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#isEnhancedConferenceSupported");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain

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

// Enhanced conference enabled status
[apiInstance isEnhancedConferenceSupportedWith:domain
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain

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

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain

            try
            {
                // Enhanced conference enabled status
                'Boolean' result = apiInstance.isEnhancedConferenceSupported(domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.isEnhancedConferenceSupported: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain

eval { 
    my $result = $api_instance->isEnhancedConferenceSupported(domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->isEnhancedConferenceSupported: $@\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.EventApi()
domain = domain_example # String | The organization domain

try: 
    # Enhanced conference enabled status
    api_response = api_instance.is_enhanced_conference_supported(domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->isEnhancedConferenceSupported: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Organization not found


leaveConference2

Leave conference

Hangs up conference call on user's answer place.


/event/v1/{domain}/{userId}/{eventId}/leave

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//event/v1/{domain}/{userId}/{eventId}/leave?answerPlace=&sipInstance=&selectedDeviceID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to leave a conference
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        String selectedDeviceID = selectedDeviceID_example; // String | The Device ID of the user agent
        try {
            apiInstance.leaveConference2(domain, userId, eventId, answerPlace, sipInstance, selectedDeviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#leaveConference2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to leave a conference
        String answerPlace = answerPlace_example; // String | The register user device name
        String sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
        String selectedDeviceID = selectedDeviceID_example; // String | The Device ID of the user agent
        try {
            apiInstance.leaveConference2(domain, userId, eventId, answerPlace, sipInstance, selectedDeviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#leaveConference2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *eventId = 789; // Event id to leave a conference
String *answerPlace = answerPlace_example; // The register user device name (optional)
String *sipInstance = sipInstance_example; // Instance Id (sipInstance) of the user agent (optional)
String *selectedDeviceID = selectedDeviceID_example; // The Device ID of the user agent (optional)

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

// Leave conference
[apiInstance leaveConference2With:domain
    userId:userId
    eventId:eventId
    answerPlace:answerPlace
    sipInstance:sipInstance
    selectedDeviceID:selectedDeviceID
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var eventId = 789; // {{Long}} Event id to leave a conference
var opts = { 
  'answerPlace': answerPlace_example, // {{String}} The register user device name
  'sipInstance': sipInstance_example, // {{String}} Instance Id (sipInstance) of the user agent
  'selectedDeviceID': selectedDeviceID_example // {{String}} The Device ID of the user agent
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.leaveConference2(domain, userId, eventId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new EventApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var eventId = 789;  // Long | Event id to leave a conference
            var answerPlace = answerPlace_example;  // String | The register user device name (optional) 
            var sipInstance = sipInstance_example;  // String | Instance Id (sipInstance) of the user agent (optional) 
            var selectedDeviceID = selectedDeviceID_example;  // String | The Device ID of the user agent (optional) 

            try
            {
                // Leave conference
                apiInstance.leaveConference2(domain, userId, eventId, answerPlace, sipInstance, selectedDeviceID);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.leaveConference2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$eventId = 789; // Long | Event id to leave a conference
$answerPlace = answerPlace_example; // String | The register user device name
$sipInstance = sipInstance_example; // String | Instance Id (sipInstance) of the user agent
$selectedDeviceID = selectedDeviceID_example; // String | The Device ID of the user agent

try {
    $api_instance->leaveConference2($domain, $userId, $eventId, $answerPlace, $sipInstance, $selectedDeviceID);
} catch (Exception $e) {
    echo 'Exception when calling EventApi->leaveConference2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventApi;


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $eventId = 789; # Long | Event id to leave a conference
my $answerPlace = answerPlace_example; # String | The register user device name
my $sipInstance = sipInstance_example; # String | Instance Id (sipInstance) of the user agent
my $selectedDeviceID = selectedDeviceID_example; # String | The Device ID of the user agent

eval { 
    $api_instance->leaveConference2(domain => $domain, userId => $userId, eventId => $eventId, answerPlace => $answerPlace, sipInstance => $sipInstance, selectedDeviceID => $selectedDeviceID);
};
if ($@) {
    warn "Exception when calling EventApi->leaveConference2: $@\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.EventApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
eventId = 789 # Long | Event id to leave a conference
answerPlace = answerPlace_example # String | The register user device name (optional)
sipInstance = sipInstance_example # String | Instance Id (sipInstance) of the user agent (optional)
selectedDeviceID = selectedDeviceID_example # String | The Device ID of the user agent (optional)

try: 
    # Leave conference
    api_instance.leave_conference2(domain, userId, eventId, answerPlace=answerPlace, sipInstance=sipInstance, selectedDeviceID=selectedDeviceID)
except ApiException as e:
    print("Exception when calling EventApi->leaveConference2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
eventId*
Long (int64)
Event id to leave a conference
Required
Query parameters
Name Description
answerPlace
String
The register user device name
sipInstance
String
Instance Id (sipInstance) of the user agent
selectedDeviceID
String
The Device ID of the user agent

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


scheduleEvent

Create event

Schedule a new event.


/event/v1/{domain}/{userId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//event/v1/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        Event body = {
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // Event | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            event result = apiInstance.scheduleEvent(body, domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#scheduleEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        Event body = {
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // Event | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            event result = apiInstance.scheduleEvent(body, domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#scheduleEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Event *body = {
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // 
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user

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

// Create event
[apiInstance scheduleEventWith:body
    domain:domain
    userId:userId
              completionHandler: ^(event output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var body = {
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // {{Event}} 
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user

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

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


            var apiInstance = new EventApi();
            var body = new Event(); // Event | 
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Create event
                event result = apiInstance.scheduleEvent(body, domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.scheduleEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$body = {
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // Event | 
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $body = WWW::SwaggerClient::Object::Event->new(); # Event | 
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user

eval { 
    my $result = $api_instance->scheduleEvent(body => $body, domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->scheduleEvent: $@\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.EventApi()
body = {
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
} # Event | 
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user

try: 
    # Create event
    api_response = api_instance.schedule_event(body, domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->scheduleEvent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"DAILY","note":"Test meeting ongoing","dialInNumbers":"+4676767676","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","weekPosition":"NONE","synchronizedMeeting":false,"rRule":"FREQ=DAILY;INTERVAL=1"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateEvent

Update event

Update an event.


/event/v1/{domain}/{userId}/{eventId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//event/v1/{domain}/{userId}/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        Event body = {
  "id" : 1,
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // Event | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to update an event
        try {
            event result = apiInstance.updateEvent(body, domain, userId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#updateEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        Event body = {
  "id" : 1,
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // Event | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long eventId = 789; // Long | Event id to update an event
        try {
            event result = apiInstance.updateEvent(body, domain, userId, eventId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#updateEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Event *body = {
  "id" : 1,
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // 
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *eventId = 789; // Event id to update an event

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

// Update event
[apiInstance updateEventWith:body
    domain:domain
    userId:userId
    eventId:eventId
              completionHandler: ^(event output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var body = {
  "id" : 1,
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // {{Event}} 
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var eventId = 789; // {{Long}} Event id to update an event

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

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


            var apiInstance = new EventApi();
            var body = new Event(); // Event | 
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var eventId = 789;  // Long | Event id to update an event

            try
            {
                // Update event
                event result = apiInstance.updateEvent(body, domain, userId, eventId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.updateEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$body = {
  "id" : 1,
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
}; // Event | 
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$eventId = 789; // Long | Event id to update an event

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $body = WWW::SwaggerClient::Object::Event->new(); # Event | 
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $eventId = 789; # Long | Event id to update an event

eval { 
    my $result = $api_instance->updateEvent(body => $body, domain => $domain, userId => $userId, eventId => $eventId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->updateEvent: $@\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.EventApi()
body = {
  "id" : 1,
  "dateTimeStart" : "2022-04-10T15:38:39Z",
  "dateTimeEnd" : "2022-04-10T16:38:39Z",
  "name" : "Test meeting",
  "organizer" : {
    "id" : "alice@abc.com",
    "firstName" : "Alice",
    "lastName" : "Test",
    "email" : "alice@abc.com",
    "businessPhone" : "+123402",
    "mobilePhone" : "+46767676195"
  },
  "participants" : [ {
    "id" : "bob@abc.com",
    "firstName" : "Bob",
    "lastName" : "Test",
    "email" : "bob@abc.com",
    "businessPhone" : "+123403",
    "mobilePhone" : "+46767676194"
  } ],
  "minutesBeforeMeetingReminder" : 15,
  "minutesBeforeMeetingSMS" : 15,
  "timeZone" : "Europe/Stockholm",
  "recurringType" : "DAILY",
  "note" : "Test meeting ongoing",
  "moxtraBinderId" : "IBcgJw9swZjy68F2tP1XEKA3",
  "moxtraMeetId" : "408052103",
  "webmeetAllowed" : true,
  "interval" : 1,
  "recurrenceRangeType" : "NONE",
  "weekPosition" : "NONE",
  "synchronizedMeeting" : false
} # Event | 
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
eventId = 789 # Long | Event id to update an event

try: 
    # Update event
    api_response = api_instance.update_event(body, domain, userId, eventId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->updateEvent: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
eventId*
Long (int64)
Event id to update an event
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"id":1,"dateTimeStart":"2022-04-10T15:38:39Z","dateTimeEnd":"2022-04-10T16:38:39Z","name":"Test meeting","organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"minutesBeforeMeetingReminder":15,"minutesBeforeMeetingSMS":15,"pincode":"151512","timeZone":"Europe/Stockholm","recurringType":"DAILY","note":"Test meeting ongoing","dialInNumbers":"+4676767676","moxtraBinderId":"IBcgJw9swZjy68F2tP1XEKA3","moxtraMeetId":"408052103","webmeetAllowed":true,"interval":1,"recurrenceRangeType":"NONE","weekPosition":"NONE","synchronizedMeeting":false,"rRule":"FREQ=DAILY;INTERVAL=1"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateEventException

Update instance

Modify a single event occurrence or an exception from a recurring event.


/event/v1/exception/{domain}/{userId}/{confId}/{eventDate}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//event/v1/exception/{domain}/{userId}/{confId}/{eventDate}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventApi;

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

public class EventApiExample {

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


        EventApi apiInstance = new EventApi();
        Eventexception body = {
  "summary" : "Event exception",
  "description" : "The exception of an event is an updated occurrence or exception of the event.",
  "value" : {
    "id" : 1,
    "dateTimeStart" : "2022-04-10T12:38:39Z",
    "dateTimeEnd" : "2022-04-10T13:38:39Z",
    "name" : "Test meeting update",
    "note" : "Test meeting instance",
    "isUpdated" : true,
    "isCancelled" : false,
    "eventId" : 1,
    "organizer" : {
      "id" : "alice@abc.com",
      "firstName" : "Alice",
      "lastName" : "Test",
      "email" : "alice@abc.com",
      "businessPhone" : "+123402",
      "mobilePhone" : "+46767676195"
    },
    "participants" : [ {
      "id" : "bob@abc.com",
      "firstName" : "Bob",
      "lastName" : "Test",
      "email" : "bob@abc.com",
      "businessPhone" : "+123403",
      "mobilePhone" : "+46767676194"
    } ]
  }
}; // Eventexception | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long confId = 789; // Long | Event id to update an event occurrence or exception
        String eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format
        try {
            eventexception result = apiInstance.updateEventException(body, domain, userId, confId, eventDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#updateEventException");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EventApi;

public class EventApiExample {

    public static void main(String[] args) {
        EventApi apiInstance = new EventApi();
        Eventexception body = {
  "summary" : "Event exception",
  "description" : "The exception of an event is an updated occurrence or exception of the event.",
  "value" : {
    "id" : 1,
    "dateTimeStart" : "2022-04-10T12:38:39Z",
    "dateTimeEnd" : "2022-04-10T13:38:39Z",
    "name" : "Test meeting update",
    "note" : "Test meeting instance",
    "isUpdated" : true,
    "isCancelled" : false,
    "eventId" : 1,
    "organizer" : {
      "id" : "alice@abc.com",
      "firstName" : "Alice",
      "lastName" : "Test",
      "email" : "alice@abc.com",
      "businessPhone" : "+123402",
      "mobilePhone" : "+46767676195"
    },
    "participants" : [ {
      "id" : "bob@abc.com",
      "firstName" : "Bob",
      "lastName" : "Test",
      "email" : "bob@abc.com",
      "businessPhone" : "+123403",
      "mobilePhone" : "+46767676194"
    } ]
  }
}; // Eventexception | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        Long confId = 789; // Long | Event id to update an event occurrence or exception
        String eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format
        try {
            eventexception result = apiInstance.updateEventException(body, domain, userId, confId, eventDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventApi#updateEventException");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Eventexception *body = {
  "summary" : "Event exception",
  "description" : "The exception of an event is an updated occurrence or exception of the event.",
  "value" : {
    "id" : 1,
    "dateTimeStart" : "2022-04-10T12:38:39Z",
    "dateTimeEnd" : "2022-04-10T13:38:39Z",
    "name" : "Test meeting update",
    "note" : "Test meeting instance",
    "isUpdated" : true,
    "isCancelled" : false,
    "eventId" : 1,
    "organizer" : {
      "id" : "alice@abc.com",
      "firstName" : "Alice",
      "lastName" : "Test",
      "email" : "alice@abc.com",
      "businessPhone" : "+123402",
      "mobilePhone" : "+46767676195"
    },
    "participants" : [ {
      "id" : "bob@abc.com",
      "firstName" : "Bob",
      "lastName" : "Test",
      "email" : "bob@abc.com",
      "businessPhone" : "+123403",
      "mobilePhone" : "+46767676194"
    } ]
  }
}; // 
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user
Long *confId = 789; // Event id to update an event occurrence or exception
String *eventDate = eventDate_example; // The date of the event instance in 'yyyy-MM-dd' format

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

// Update instance
[apiInstance updateEventExceptionWith:body
    domain:domain
    userId:userId
    confId:confId
    eventDate:eventDate
              completionHandler: ^(eventexception output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.EventApi()
var body = {
  "summary" : "Event exception",
  "description" : "The exception of an event is an updated occurrence or exception of the event.",
  "value" : {
    "id" : 1,
    "dateTimeStart" : "2022-04-10T12:38:39Z",
    "dateTimeEnd" : "2022-04-10T13:38:39Z",
    "name" : "Test meeting update",
    "note" : "Test meeting instance",
    "isUpdated" : true,
    "isCancelled" : false,
    "eventId" : 1,
    "organizer" : {
      "id" : "alice@abc.com",
      "firstName" : "Alice",
      "lastName" : "Test",
      "email" : "alice@abc.com",
      "businessPhone" : "+123402",
      "mobilePhone" : "+46767676195"
    },
    "participants" : [ {
      "id" : "bob@abc.com",
      "firstName" : "Bob",
      "lastName" : "Test",
      "email" : "bob@abc.com",
      "businessPhone" : "+123403",
      "mobilePhone" : "+46767676194"
    } ]
  }
}; // {{Eventexception}} 
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user
var confId = 789; // {{Long}} Event id to update an event occurrence or exception
var eventDate = eventDate_example; // {{String}} The date of the event instance in 'yyyy-MM-dd' format

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

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


            var apiInstance = new EventApi();
            var body = new Eventexception(); // Eventexception | 
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user
            var confId = 789;  // Long | Event id to update an event occurrence or exception
            var eventDate = eventDate_example;  // String | The date of the event instance in 'yyyy-MM-dd' format

            try
            {
                // Update instance
                eventexception result = apiInstance.updateEventException(body, domain, userId, confId, eventDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventApi.updateEventException: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventApi();
$body = {
  "summary" : "Event exception",
  "description" : "The exception of an event is an updated occurrence or exception of the event.",
  "value" : {
    "id" : 1,
    "dateTimeStart" : "2022-04-10T12:38:39Z",
    "dateTimeEnd" : "2022-04-10T13:38:39Z",
    "name" : "Test meeting update",
    "note" : "Test meeting instance",
    "isUpdated" : true,
    "isCancelled" : false,
    "eventId" : 1,
    "organizer" : {
      "id" : "alice@abc.com",
      "firstName" : "Alice",
      "lastName" : "Test",
      "email" : "alice@abc.com",
      "businessPhone" : "+123402",
      "mobilePhone" : "+46767676195"
    },
    "participants" : [ {
      "id" : "bob@abc.com",
      "firstName" : "Bob",
      "lastName" : "Test",
      "email" : "bob@abc.com",
      "businessPhone" : "+123403",
      "mobilePhone" : "+46767676194"
    } ]
  }
}; // Eventexception | 
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user
$confId = 789; // Long | Event id to update an event occurrence or exception
$eventDate = eventDate_example; // String | The date of the event instance in 'yyyy-MM-dd' format

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


my $api_instance = WWW::SwaggerClient::EventApi->new();
my $body = WWW::SwaggerClient::Object::Eventexception->new(); # Eventexception | 
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user
my $confId = 789; # Long | Event id to update an event occurrence or exception
my $eventDate = eventDate_example; # String | The date of the event instance in 'yyyy-MM-dd' format

eval { 
    my $result = $api_instance->updateEventException(body => $body, domain => $domain, userId => $userId, confId => $confId, eventDate => $eventDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventApi->updateEventException: $@\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.EventApi()
body = {
  "summary" : "Event exception",
  "description" : "The exception of an event is an updated occurrence or exception of the event.",
  "value" : {
    "id" : 1,
    "dateTimeStart" : "2022-04-10T12:38:39Z",
    "dateTimeEnd" : "2022-04-10T13:38:39Z",
    "name" : "Test meeting update",
    "note" : "Test meeting instance",
    "isUpdated" : true,
    "isCancelled" : false,
    "eventId" : 1,
    "organizer" : {
      "id" : "alice@abc.com",
      "firstName" : "Alice",
      "lastName" : "Test",
      "email" : "alice@abc.com",
      "businessPhone" : "+123402",
      "mobilePhone" : "+46767676195"
    },
    "participants" : [ {
      "id" : "bob@abc.com",
      "firstName" : "Bob",
      "lastName" : "Test",
      "email" : "bob@abc.com",
      "businessPhone" : "+123403",
      "mobilePhone" : "+46767676194"
    } ]
  }
} # Eventexception | 
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user
confId = 789 # Long | Event id to update an event occurrence or exception
eventDate = eventDate_example # String | The date of the event instance in 'yyyy-MM-dd' format

try: 
    # Update instance
    api_response = api_instance.update_event_exception(body, domain, userId, confId, eventDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->updateEventException: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
confId*
Long (int64)
Event id to update an event occurrence or exception
Required
eventDate*
String
The date of the event instance in 'yyyy-MM-dd' format
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"id":1,"dateTimeStart":"2022-04-10T12:38:39Z","dateTimeEnd":"2022-04-10T13:38:39Z","name":"Test meeting update","note":"Test meeting instance","isUpdated":true,"isCancelled":false,"eventId":1,"organizer":{"id":"alice@abc.com","firstName":"Alice","lastName":"Test","email":"alice@abc.com","businessPhone":"+123402","mobilePhone":"+46767676195"},"participants":[{"id":"bob@abc.com","firstName":"Bob","lastName":"Test","email":"bob@abc.com","businessPhone":"+123403","mobilePhone":"+46767676194"}],"dateTimeOld":"2022-04-10T15:38:39Z"}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


LineState

createLineState

Create line state

Creates a line state for a user and external id. If the line state already exists, it will be updated.


/linestate/v1/{domain}/{userId}/{externalId}

Usage and SDK Samples

curl -X POST\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//linestate/v1/{domain}/{userId}/{externalId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineStateApi;

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

public class LineStateApiExample {

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

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            LineStateDTO result = apiInstance.createLineState(domain, userId, externalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#createLineState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineStateApi;

public class LineStateApiExample {

    public static void main(String[] args) {
        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            LineStateDTO result = apiInstance.createLineState(domain, userId, externalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#createLineState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user id
String *externalId = externalId_example; // The external id

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

// Create line state
[apiInstance createLineStateWith:domain
    userId:userId
    externalId:externalId
              completionHandler: ^(LineStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.LineStateApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user id
var externalId = externalId_example; // {{String}} The external id

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

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

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new LineStateApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user id
            var externalId = externalId_example;  // String | The external id

            try
            {
                // Create line state
                LineStateDTO result = apiInstance.createLineState(domain, userId, externalId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineStateApi.createLineState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiLineStateApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user id
$externalId = externalId_example; // String | The external id

try {
    $result = $api_instance->createLineState($domain, $userId, $externalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineStateApi->createLineState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineStateApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LineStateApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user id
my $externalId = externalId_example; # String | The external id

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

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LineStateApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user id
externalId = externalId_example # String | The external id

try: 
    # Create line state
    api_response = api_instance.create_line_state(domain, userId, externalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineStateApi->createLineState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user id
Required
externalId*
String
The external id
Required
Query parameters
Name Description

Responses

Status: 200 - Success. The returned document contains the updated line state.

{"expiresOn":"2020-03-10T11:05:00+01"}

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist

Status: 501 - Requested service is not implemented


getLineState

Get line state

Fetches a specific line state for a user.


/linestate/v1/{domain}/{userId}/{externalId}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//linestate/v1/{domain}/{userId}/{externalId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineStateApi;

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

public class LineStateApiExample {

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

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            LineStateDTO result = apiInstance.getLineState(domain, userId, externalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#getLineState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineStateApi;

public class LineStateApiExample {

    public static void main(String[] args) {
        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            LineStateDTO result = apiInstance.getLineState(domain, userId, externalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#getLineState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user id
String *externalId = externalId_example; // The external id

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

// Get line state
[apiInstance getLineStateWith:domain
    userId:userId
    externalId:externalId
              completionHandler: ^(LineStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.LineStateApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user id
var externalId = externalId_example; // {{String}} The external id

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

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

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new LineStateApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user id
            var externalId = externalId_example;  // String | The external id

            try
            {
                // Get line state
                LineStateDTO result = apiInstance.getLineState(domain, userId, externalId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineStateApi.getLineState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiLineStateApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user id
$externalId = externalId_example; // String | The external id

try {
    $result = $api_instance->getLineState($domain, $userId, $externalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineStateApi->getLineState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineStateApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LineStateApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user id
my $externalId = externalId_example; # String | The external id

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

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LineStateApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user id
externalId = externalId_example # String | The external id

try: 
    # Get line state
    api_response = api_instance.get_line_state(domain, userId, externalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineStateApi->getLineState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user id
Required
externalId*
String
The external id
Required
Query parameters
Name Description

Responses

Status: 200 - Success. The returned document contains the current line state for the user / external id. If there is no line state, an empty document is returned.

{"expiresOn":"2020-03-10T11:05:00+01"}

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist

Status: 501 - Requested service is not implemented


removeLineState

Delete line state

Removes a specific line state for a user.


/linestate/v1/{domain}/{userId}/{externalId}

Usage and SDK Samples

curl -X DELETE\
\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//linestate/v1/{domain}/{userId}/{externalId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineStateApi;

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

public class LineStateApiExample {

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

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            apiInstance.removeLineState(domain, userId, externalId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#removeLineState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineStateApi;

public class LineStateApiExample {

    public static void main(String[] args) {
        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            apiInstance.removeLineState(domain, userId, externalId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#removeLineState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user id
String *externalId = externalId_example; // The external id

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

// Delete line state
[apiInstance removeLineStateWith:domain
    userId:userId
    externalId:externalId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.LineStateApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user id
var externalId = externalId_example; // {{String}} The external id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeLineState(domain, userId, externalId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new LineStateApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user id
            var externalId = externalId_example;  // String | The external id

            try
            {
                // Delete line state
                apiInstance.removeLineState(domain, userId, externalId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineStateApi.removeLineState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiLineStateApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user id
$externalId = externalId_example; // String | The external id

try {
    $api_instance->removeLineState($domain, $userId, $externalId);
} catch (Exception $e) {
    echo 'Exception when calling LineStateApi->removeLineState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineStateApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LineStateApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user id
my $externalId = externalId_example; # String | The external id

eval { 
    $api_instance->removeLineState(domain => $domain, userId => $userId, externalId => $externalId);
};
if ($@) {
    warn "Exception when calling LineStateApi->removeLineState: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LineStateApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user id
externalId = externalId_example # String | The external id

try: 
    # Delete line state
    api_instance.remove_line_state(domain, userId, externalId)
except ApiException as e:
    print("Exception when calling LineStateApi->removeLineState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user id
Required
externalId*
String
The external id
Required
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist

Status: 501 - Requested service is not implemented


updateLineState

Update line state

Updates a line state for a user and external id. If there is no current line state, it will be created.


/linestate/v1/{domain}/{userId}/{externalId}

Usage and SDK Samples

curl -X PUT\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//linestate/v1/{domain}/{userId}/{externalId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineStateApi;

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

public class LineStateApiExample {

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

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            LineStateDTO result = apiInstance.updateLineState(domain, userId, externalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#updateLineState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineStateApi;

public class LineStateApiExample {

    public static void main(String[] args) {
        LineStateApi apiInstance = new LineStateApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        String externalId = externalId_example; // String | The external id
        try {
            LineStateDTO result = apiInstance.updateLineState(domain, userId, externalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineStateApi#updateLineState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user id
String *externalId = externalId_example; // The external id

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

// Update line state
[apiInstance updateLineStateWith:domain
    userId:userId
    externalId:externalId
              completionHandler: ^(LineStateDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.LineStateApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user id
var externalId = externalId_example; // {{String}} The external id

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

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

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new LineStateApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user id
            var externalId = externalId_example;  // String | The external id

            try
            {
                // Update line state
                LineStateDTO result = apiInstance.updateLineState(domain, userId, externalId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineStateApi.updateLineState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiLineStateApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user id
$externalId = externalId_example; // String | The external id

try {
    $result = $api_instance->updateLineState($domain, $userId, $externalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineStateApi->updateLineState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineStateApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::LineStateApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user id
my $externalId = externalId_example; # String | The external id

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

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.LineStateApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user id
externalId = externalId_example # String | The external id

try: 
    # Update line state
    api_response = api_instance.update_line_state(domain, userId, externalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineStateApi->updateLineState: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user id
Required
externalId*
String
The external id
Required
Query parameters
Name Description

Responses

Status: 200 - Success. The returned document contains the updated line state.

{"expiresOn":"2020-03-10T11:05:00+01"}

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist

Status: 501 - Requested service is not implemented


MobileSubscribers

getFullCallerID

Get caller ID settings

Retrieve the full caller ID setting for incoming calls to a subscriber's mobile.


/mobileSubscriber/{domain}/{number}/fullcallerid

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//mobileSubscriber/{domain}/{number}/fullcallerid"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

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

public class MobileSubscribersApiExample {

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


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.getFullCallerID(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getFullCallerID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.getFullCallerID(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getFullCallerID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain

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

// Get caller ID settings
[apiInstance getFullCallerIDWith:number
    domain:domain
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain

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

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


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain

            try
            {
                // Get caller ID settings
                'Boolean' result = apiInstance.getFullCallerID(number, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.getFullCallerID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain

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


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain

eval { 
    my $result = $api_instance->getFullCallerID(number => $number, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->getFullCallerID: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain

try: 
    # Get caller ID settings
    api_response = api_instance.get_full_caller_id(number, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->getFullCallerID: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getNumberPresentation

Get number presentation setting

Retrieve the number presentation setting of a mobile subscriber.


/mobileSubscriber/{domain}/{number}/numberpresentation

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//mobileSubscriber/{domain}/{number}/numberpresentation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

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

public class MobileSubscribersApiExample {

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


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'String' result = apiInstance.getNumberPresentation(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getNumberPresentation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'String' result = apiInstance.getNumberPresentation(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getNumberPresentation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain

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

// Get number presentation setting
[apiInstance getNumberPresentationWith:number
    domain:domain
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain

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

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


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain

            try
            {
                // Get number presentation setting
                'String' result = apiInstance.getNumberPresentation(number, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.getNumberPresentation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain

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


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain

eval { 
    my $result = $api_instance->getNumberPresentation(number => $number, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->getNumberPresentation: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain

try: 
    # Get number presentation setting
    api_response = api_instance.get_number_presentation(number, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->getNumberPresentation: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required

Responses

Status: 200 - 0: Use fixed number and short number internally<br>1: Use mobile number and short number internally<br>2: Always use fixed number<br>3: Always use mobile number

2

Status: 403 - Not Authorized

Status: 404 - Not Found


getPbxIntegration

Get PBX integration setting

Retrieve the PBX integration setting of a mobile subscriber.


/mobileSubscriber/{domain}/{number}/pbxintegration

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//mobileSubscriber/{domain}/{number}/pbxintegration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

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

public class MobileSubscribersApiExample {

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


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.getPbxIntegration(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getPbxIntegration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.getPbxIntegration(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getPbxIntegration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain

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

// Get PBX integration setting
[apiInstance getPbxIntegrationWith:number
    domain:domain
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain

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

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


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain

            try
            {
                // Get PBX integration setting
                'Boolean' result = apiInstance.getPbxIntegration(number, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.getPbxIntegration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain

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


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain

eval { 
    my $result = $api_instance->getPbxIntegration(number => $number, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->getPbxIntegration: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain

try: 
    # Get PBX integration setting
    api_response = api_instance.get_pbx_integration(number, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->getPbxIntegration: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getRouteToPBX

Get route to PBX setting

Retrieve the route to PBX setting of a mobile subscriber.


/mobileSubscriber/{domain}/{number}/routetopbx

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//mobileSubscriber/{domain}/{number}/routetopbx"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

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

public class MobileSubscribersApiExample {

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


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.getRouteToPBX(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getRouteToPBX");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        try {
            'Boolean' result = apiInstance.getRouteToPBX(number, domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#getRouteToPBX");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain

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

// Get route to PBX setting
[apiInstance getRouteToPBXWith:number
    domain:domain
              completionHandler: ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain

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

namespace Example
{
    public class getRouteToPBXExample
    {
        public void main()
        {


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain

            try
            {
                // Get route to PBX setting
                'Boolean' result = apiInstance.getRouteToPBX(number, domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.getRouteToPBX: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain

try {
    $result = $api_instance->getRouteToPBX($number, $domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MobileSubscribersApi->getRouteToPBX: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MobileSubscribersApi;


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain

eval { 
    my $result = $api_instance->getRouteToPBX(number => $number, domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->getRouteToPBX: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain

try: 
    # Get route to PBX setting
    api_response = api_instance.get_route_to_pbx(number, domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->getRouteToPBX: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


setFullCallerID

Update caller ID setting

Update the full caller ID setting for incoming calls to a subscriber's mobile.


/mobileSubscriber/{domain}/{number}/fullcallerid

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//mobileSubscriber/{domain}/{number}/fullcallerid?enable="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

import java.io.File;
import java.util.*;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Boolean enable = true; // Boolean | Indicate if integration should be enabled or disabled
        try {
            apiInstance.setFullCallerID(number, domain, enable);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#setFullCallerID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Boolean enable = true; // Boolean | Indicate if integration should be enabled or disabled
        try {
            apiInstance.setFullCallerID(number, domain, enable);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#setFullCallerID");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain
Boolean *enable = true; // Indicate if integration should be enabled or disabled

MobileSubscribersApi *apiInstance = [[MobileSubscribersApi alloc] init];

// Update caller ID setting
[apiInstance setFullCallerIDWith:number
    domain:domain
    enable:enable
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain
var enable = true; // {{Boolean}} Indicate if integration should be enabled or disabled

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setFullCallerID(number, domain, enable, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setFullCallerIDExample
    {
        public void main()
        {


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain
            var enable = true;  // Boolean | Indicate if integration should be enabled or disabled

            try
            {
                // Update caller ID setting
                apiInstance.setFullCallerID(number, domain, enable);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.setFullCallerID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain
$enable = true; // Boolean | Indicate if integration should be enabled or disabled

try {
    $api_instance->setFullCallerID($number, $domain, $enable);
} catch (Exception $e) {
    echo 'Exception when calling MobileSubscribersApi->setFullCallerID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MobileSubscribersApi;


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain
my $enable = true; # Boolean | Indicate if integration should be enabled or disabled

eval { 
    $api_instance->setFullCallerID(number => $number, domain => $domain, enable => $enable);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->setFullCallerID: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain
enable = true # Boolean | Indicate if integration should be enabled or disabled

try: 
    # Update caller ID setting
    api_instance.set_full_caller_id(number, domain, enable)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->setFullCallerID: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required
Query parameters
Name Description
enable*
Boolean
Indicate if integration should be enabled or disabled
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


setNumberPresentation

Update number presentation setting

Update the number presentation of a mobile subscriber.


/mobileSubscriber/{domain}/{number}/numberpresentation

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//mobileSubscriber/{domain}/{number}/numberpresentation?value="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

import java.io.File;
import java.util.*;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Integer value = 56; // Integer | The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number try { apiInstance.setNumberPresentation(number, domain, value); } catch (ApiException e) { System.err.println("Exception when calling MobileSubscribersApi#setNumberPresentation"); e.printStackTrace(); } } }
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Integer value = 56; // Integer | The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number try { apiInstance.setNumberPresentation(number, domain, value); } catch (ApiException e) { System.err.println("Exception when calling MobileSubscribersApi#setNumberPresentation"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain
Integer *value = 56; // The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number MobileSubscribersApi *apiInstance = [[MobileSubscribersApi alloc] init]; // Update number presentation setting [apiInstance setNumberPresentationWith:number domain:domain value:value completionHandler: ^(NSError* error) { if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain
var value = 56; // {{Integer}} The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.setNumberPresentation(number, domain, value, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setNumberPresentationExample
    {
        public void main()
        {


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain
            var value = 56;  // Integer | The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number try { // Update number presentation setting apiInstance.setNumberPresentation(number, domain, value); } catch (Exception e) { Debug.Print("Exception when calling MobileSubscribersApi.setNumberPresentation: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain
$value = 56; // Integer | The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number try { $api_instance->setNumberPresentation($number, $domain, $value); } catch (Exception $e) { echo 'Exception when calling MobileSubscribersApi->setNumberPresentation: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MobileSubscribersApi;


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain
my $value = 56; # Integer | The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number eval { $api_instance->setNumberPresentation(number => $number, domain => $domain, value => $value); }; if ($@) { warn "Exception when calling MobileSubscribersApi->setNumberPresentation: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain
value = 56 # Integer | The number presentation setting. The parameter can have 4 different values;
0: Use fixed number and short number internally
1: Use mobile number and short number internally
2: Always use fixed number
3: Always use mobile number try: # Update number presentation setting api_instance.set_number_presentation(number, domain, value) except ApiException as e: print("Exception when calling MobileSubscribersApi->setNumberPresentation: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required
Query parameters
Name Description
value*
Integer (int32)
The number presentation setting. The parameter can have 4 different values;<br>0: Use fixed number and short number internally<br>1: Use mobile number and short number internally<br>2: Always use fixed number<br>3: Always use mobile number
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


setPbxIntegration

Update PBX integration setting

Update the PBX integration of a mobile subscriber.


/mobileSubscriber/{domain}/{number}/pbxintegration

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//mobileSubscriber/{domain}/{number}/pbxintegration?enable="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

import java.io.File;
import java.util.*;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Boolean enable = true; // Boolean | Indicate if integration should be enabled or disabled
        try {
            apiInstance.setPbxIntegration(number, domain, enable);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#setPbxIntegration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Boolean enable = true; // Boolean | Indicate if integration should be enabled or disabled
        try {
            apiInstance.setPbxIntegration(number, domain, enable);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#setPbxIntegration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain
Boolean *enable = true; // Indicate if integration should be enabled or disabled

MobileSubscribersApi *apiInstance = [[MobileSubscribersApi alloc] init];

// Update PBX integration setting
[apiInstance setPbxIntegrationWith:number
    domain:domain
    enable:enable
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain
var enable = true; // {{Boolean}} Indicate if integration should be enabled or disabled

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setPbxIntegration(number, domain, enable, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setPbxIntegrationExample
    {
        public void main()
        {


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain
            var enable = true;  // Boolean | Indicate if integration should be enabled or disabled

            try
            {
                // Update PBX integration setting
                apiInstance.setPbxIntegration(number, domain, enable);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.setPbxIntegration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain
$enable = true; // Boolean | Indicate if integration should be enabled or disabled

try {
    $api_instance->setPbxIntegration($number, $domain, $enable);
} catch (Exception $e) {
    echo 'Exception when calling MobileSubscribersApi->setPbxIntegration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MobileSubscribersApi;


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain
my $enable = true; # Boolean | Indicate if integration should be enabled or disabled

eval { 
    $api_instance->setPbxIntegration(number => $number, domain => $domain, enable => $enable);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->setPbxIntegration: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain
enable = true # Boolean | Indicate if integration should be enabled or disabled

try: 
    # Update PBX integration setting
    api_instance.set_pbx_integration(number, domain, enable)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->setPbxIntegration: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required
Query parameters
Name Description
enable*
Boolean
Indicate if integration should be enabled or disabled
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


setRouteToPBX

Update route to PBX setting

Update the Route to PBX setting of a mobile subscriber.


/mobileSubscriber/{domain}/{number}/routetopbx

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//mobileSubscriber/{domain}/{number}/routetopbx?enable="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MobileSubscribersApi;

import java.io.File;
import java.util.*;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Boolean enable = true; // Boolean | Indicate if route to PBX should be enabled or disabled
        try {
            apiInstance.setRouteToPBX(number, domain, enable);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#setRouteToPBX");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MobileSubscribersApi;

public class MobileSubscribersApiExample {

    public static void main(String[] args) {
        MobileSubscribersApi apiInstance = new MobileSubscribersApi();
        String number = number_example; // String | The mobile number of the subscriber
        String domain = domain_example; // String | The organization domain
        Boolean enable = true; // Boolean | Indicate if route to PBX should be enabled or disabled
        try {
            apiInstance.setRouteToPBX(number, domain, enable);
        } catch (ApiException e) {
            System.err.println("Exception when calling MobileSubscribersApi#setRouteToPBX");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *number = number_example; // The mobile number of the subscriber
String *domain = domain_example; // The organization domain
Boolean *enable = true; // Indicate if route to PBX should be enabled or disabled

MobileSubscribersApi *apiInstance = [[MobileSubscribersApi alloc] init];

// Update route to PBX setting
[apiInstance setRouteToPBXWith:number
    domain:domain
    enable:enable
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.MobileSubscribersApi()
var number = number_example; // {{String}} The mobile number of the subscriber
var domain = domain_example; // {{String}} The organization domain
var enable = true; // {{Boolean}} Indicate if route to PBX should be enabled or disabled

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setRouteToPBX(number, domain, enable, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setRouteToPBXExample
    {
        public void main()
        {


            var apiInstance = new MobileSubscribersApi();
            var number = number_example;  // String | The mobile number of the subscriber
            var domain = domain_example;  // String | The organization domain
            var enable = true;  // Boolean | Indicate if route to PBX should be enabled or disabled

            try
            {
                // Update route to PBX setting
                apiInstance.setRouteToPBX(number, domain, enable);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MobileSubscribersApi.setRouteToPBX: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiMobileSubscribersApi();
$number = number_example; // String | The mobile number of the subscriber
$domain = domain_example; // String | The organization domain
$enable = true; // Boolean | Indicate if route to PBX should be enabled or disabled

try {
    $api_instance->setRouteToPBX($number, $domain, $enable);
} catch (Exception $e) {
    echo 'Exception when calling MobileSubscribersApi->setRouteToPBX: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MobileSubscribersApi;


my $api_instance = WWW::SwaggerClient::MobileSubscribersApi->new();
my $number = number_example; # String | The mobile number of the subscriber
my $domain = domain_example; # String | The organization domain
my $enable = true; # Boolean | Indicate if route to PBX should be enabled or disabled

eval { 
    $api_instance->setRouteToPBX(number => $number, domain => $domain, enable => $enable);
};
if ($@) {
    warn "Exception when calling MobileSubscribersApi->setRouteToPBX: $@\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.MobileSubscribersApi()
number = number_example # String | The mobile number of the subscriber
domain = domain_example # String | The organization domain
enable = true # Boolean | Indicate if route to PBX should be enabled or disabled

try: 
    # Update route to PBX setting
    api_instance.set_route_to_pbx(number, domain, enable)
except ApiException as e:
    print("Exception when calling MobileSubscribersApi->setRouteToPBX: %s\n" % e)

Parameters

Path parameters
Name Description
number*
String
The mobile number of the subscriber
Required
domain*
String
The organization domain
Required
Query parameters
Name Description
enable*
Boolean
Indicate if route to PBX should be enabled or disabled
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


PersonalContacts

createNewPersonalContact

Create contact for user

Create a contact for a user in the organization.


/personal_contacts/user/{domain}/{user}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//personal_contacts/user/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 
        try {
            PersonalContactDto result = apiInstance.createNewPersonalContact(domain, user, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#createNewPersonalContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 
        try {
            PersonalContactDto result = apiInstance.createNewPersonalContact(domain, user, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#createNewPersonalContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user that owns the contact
String *user = user_example; // The username of the user that owns the contact
PersonalContactDto *body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; //  (optional)

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Create contact for user
[apiInstance createNewPersonalContactWith:domain
    user:user
    body:body
              completionHandler: ^(PersonalContactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user that owns the contact
var user = user_example; // {{String}} The username of the user that owns the contact
var opts = { 
  'body': {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
} // {{PersonalContactDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNewPersonalContact(domainuser, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNewPersonalContactExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user that owns the contact
            var user = user_example;  // String | The username of the user that owns the contact
            var body = new PersonalContactDto(); // PersonalContactDto |  (optional) 

            try
            {
                // Create contact for user
                PersonalContactDto result = apiInstance.createNewPersonalContact(domain, user, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.createNewPersonalContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user that owns the contact
$user = user_example; // String | The username of the user that owns the contact
$body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 

try {
    $result = $api_instance->createNewPersonalContact($domain, $user, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->createNewPersonalContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user that owns the contact
my $user = user_example; # String | The username of the user that owns the contact
my $body = WWW::SwaggerClient::Object::PersonalContactDto->new(); # PersonalContactDto | 

eval { 
    my $result = $api_instance->createNewPersonalContact(domain => $domain, user => $user, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->createNewPersonalContact: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user that owns the contact
user = user_example # String | The username of the user that owns the contact
body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
} # PersonalContactDto |  (optional)

try: 
    # Create contact for user
    api_response = api_instance.create_new_personal_contact(domain, user, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->createNewPersonalContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user that owns the contact
Required
user*
String
The username of the user that owns the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"USER","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}
{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"USER","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


createNewPersonalContactInGroup

Create contact for user group

Create a contact for a user group in the organization.


/personal_contacts/group/{domain}/{groupId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//personal_contacts/group/{domain}/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 
        try {
            PersonalContactDto result = apiInstance.createNewPersonalContactInGroup(domain, groupId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#createNewPersonalContactInGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 
        try {
            PersonalContactDto result = apiInstance.createNewPersonalContactInGroup(domain, groupId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#createNewPersonalContactInGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user group that owns the contact
String *groupId = groupId_example; // The name of the user group that owns the contact
PersonalContactDto *body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; //  (optional)

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Create contact for user group
[apiInstance createNewPersonalContactInGroupWith:domain
    groupId:groupId
    body:body
              completionHandler: ^(PersonalContactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user group that owns the contact
var groupId = groupId_example; // {{String}} The name of the user group that owns the contact
var opts = { 
  'body': {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
} // {{PersonalContactDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNewPersonalContactInGroup(domaingroupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNewPersonalContactInGroupExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user group that owns the contact
            var groupId = groupId_example;  // String | The name of the user group that owns the contact
            var body = new PersonalContactDto(); // PersonalContactDto |  (optional) 

            try
            {
                // Create contact for user group
                PersonalContactDto result = apiInstance.createNewPersonalContactInGroup(domain, groupId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.createNewPersonalContactInGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user group that owns the contact
$groupId = groupId_example; // String | The name of the user group that owns the contact
$body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 

try {
    $result = $api_instance->createNewPersonalContactInGroup($domain, $groupId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->createNewPersonalContactInGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user group that owns the contact
my $groupId = groupId_example; # String | The name of the user group that owns the contact
my $body = WWW::SwaggerClient::Object::PersonalContactDto->new(); # PersonalContactDto | 

eval { 
    my $result = $api_instance->createNewPersonalContactInGroup(domain => $domain, groupId => $groupId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->createNewPersonalContactInGroup: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user group that owns the contact
groupId = groupId_example # String | The name of the user group that owns the contact
body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
} # PersonalContactDto |  (optional)

try: 
    # Create contact for user group
    api_response = api_instance.create_new_personal_contact_in_group(domain, groupId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->createNewPersonalContactInGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user group that owns the contact
Required
groupId*
String
The name of the user group that owns the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"GROUP","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}
{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"GROUP","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


createNewPersonalContactInOrg

Create contact for organization

Creates contact on organizaton level when requested by an administrator.


/personal_contacts/org/{domain}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//personal_contacts/org/{domain}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 
        try {
            PersonalContactDto result = apiInstance.createNewPersonalContactInOrg(domain, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#createNewPersonalContactInOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 
        try {
            PersonalContactDto result = apiInstance.createNewPersonalContactInOrg(domain, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#createNewPersonalContactInOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization that owns the contact
PersonalContactDto *body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; //  (optional)

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Create contact for organization
[apiInstance createNewPersonalContactInOrgWith:domain
    body:body
              completionHandler: ^(PersonalContactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the organization that owns the contact
var opts = { 
  'body': {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
} // {{PersonalContactDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNewPersonalContactInOrg(domain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNewPersonalContactInOrgExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the organization that owns the contact
            var body = new PersonalContactDto(); // PersonalContactDto |  (optional) 

            try
            {
                // Create contact for organization
                PersonalContactDto result = apiInstance.createNewPersonalContactInOrg(domain, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.createNewPersonalContactInOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the organization that owns the contact
$body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
}; // PersonalContactDto | 

try {
    $result = $api_instance->createNewPersonalContactInOrg($domain, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->createNewPersonalContactInOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the organization that owns the contact
my $body = WWW::SwaggerClient::Object::PersonalContactDto->new(); # PersonalContactDto | 

eval { 
    my $result = $api_instance->createNewPersonalContactInOrg(domain => $domain, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->createNewPersonalContactInOrg: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the organization that owns the contact
body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Rnd",
  "firstname" : "John",
  "lastname" : "Doe",
  "shortname" : "jodo",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 5,
  "showInDefaultContactList" : true,
  "contactStatus" : "VIP",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "WORK",
    "phoneNumber" : "+46850654760",
    "preferredNumber" : true,
    "abbreviatednumber" : "4760"
  } ]
} # PersonalContactDto |  (optional)

try: 
    # Create contact for organization
    api_response = api_instance.create_new_personal_contact_in_org(domain, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->createNewPersonalContactInOrg: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization that owns the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"ORG","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}
{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"ORG","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deletePersonalContact

Delete contact for user

Delete the specific contact for a user.


/personal_contacts/user/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/user/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.deletePersonalContact(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#deletePersonalContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.deletePersonalContact(domain, user, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#deletePersonalContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user that owns the contact
String *user = user_example; // The username of the user that owns the contact
String *cid = cid_example; // The ID of the contact

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Delete contact for user
[apiInstance deletePersonalContactWith:domain
    user:user
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user that owns the contact
var user = user_example; // {{String}} The username of the user that owns the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePersonalContact(domain, user, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePersonalContactExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user that owns the contact
            var user = user_example;  // String | The username of the user that owns the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Delete contact for user
                apiInstance.deletePersonalContact(domain, user, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.deletePersonalContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user that owns the contact
$user = user_example; // String | The username of the user that owns the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->deletePersonalContact($domain, $user, $cid);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->deletePersonalContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user that owns the contact
my $user = user_example; # String | The username of the user that owns the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->deletePersonalContact(domain => $domain, user => $user, cid => $cid);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->deletePersonalContact: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user that owns the contact
user = user_example # String | The username of the user that owns the contact
cid = cid_example # String | The ID of the contact

try: 
    # Delete contact for user
    api_instance.delete_personal_contact(domain, user, cid)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->deletePersonalContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user that owns the contact
Required
user*
String
The username of the user that owns the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deletePersonalContactForGroup

Delete contact for user group

Delete the specific contact for a user group in the organization.


/personal_contacts/group/{domain}/{groupId}/{cid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/group/{domain}/{groupId}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.deletePersonalContactForGroup(domain, groupId, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#deletePersonalContactForGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.deletePersonalContactForGroup(domain, groupId, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#deletePersonalContactForGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user group that owns the contact
String *groupId = groupId_example; // The name of the user group that owns the contact
String *cid = cid_example; // The ID of the contact

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Delete contact for user group
[apiInstance deletePersonalContactForGroupWith:domain
    groupId:groupId
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user group that owns the contact
var groupId = groupId_example; // {{String}} The name of the user group that owns the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePersonalContactForGroup(domain, groupId, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePersonalContactForGroupExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user group that owns the contact
            var groupId = groupId_example;  // String | The name of the user group that owns the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Delete contact for user group
                apiInstance.deletePersonalContactForGroup(domain, groupId, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.deletePersonalContactForGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user group that owns the contact
$groupId = groupId_example; // String | The name of the user group that owns the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->deletePersonalContactForGroup($domain, $groupId, $cid);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->deletePersonalContactForGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user group that owns the contact
my $groupId = groupId_example; # String | The name of the user group that owns the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->deletePersonalContactForGroup(domain => $domain, groupId => $groupId, cid => $cid);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->deletePersonalContactForGroup: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user group that owns the contact
groupId = groupId_example # String | The name of the user group that owns the contact
cid = cid_example # String | The ID of the contact

try: 
    # Delete contact for user group
    api_instance.delete_personal_contact_for_group(domain, groupId, cid)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->deletePersonalContactForGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user group that owns the contact
Required
groupId*
String
The name of the user group that owns the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


deletePersonalContactForOrg

Delete contact for organization

Delete the specific contact on organization level when requested by an administrator.


/personal_contacts/org/{domain}/{cid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/org/{domain}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.deletePersonalContactForOrg(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#deletePersonalContactForOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            apiInstance.deletePersonalContactForOrg(domain, cid);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#deletePersonalContactForOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization that owns the contact
String *cid = cid_example; // The ID of the contact

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Delete contact for organization
[apiInstance deletePersonalContactForOrgWith:domain
    cid:cid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the organization that owns the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePersonalContactForOrg(domain, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deletePersonalContactForOrgExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the organization that owns the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Delete contact for organization
                apiInstance.deletePersonalContactForOrg(domain, cid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.deletePersonalContactForOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the organization that owns the contact
$cid = cid_example; // String | The ID of the contact

try {
    $api_instance->deletePersonalContactForOrg($domain, $cid);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->deletePersonalContactForOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the organization that owns the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    $api_instance->deletePersonalContactForOrg(domain => $domain, cid => $cid);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->deletePersonalContactForOrg: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the organization that owns the contact
cid = cid_example # String | The ID of the contact

try: 
    # Delete contact for organization
    api_instance.delete_personal_contact_for_org(domain, cid)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->deletePersonalContactForOrg: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization that owns the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPersonalContact

Get contact for user

Retrieve the specific contact for a user in the organization.


/personal_contacts/user/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/user/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PersonalContactDto result = apiInstance.getPersonalContact(domain, user, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PersonalContactDto result = apiInstance.getPersonalContact(domain, user, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user that owns the contact
String *user = user_example; // The username of the user that owns the contact
String *cid = cid_example; // The ID of the contact

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Get contact for user
[apiInstance getPersonalContactWith:domain
    user:user
    cid:cid
              completionHandler: ^(PersonalContactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user that owns the contact
var user = user_example; // {{String}} The username of the user that owns the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonalContact(domain, user, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonalContactExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user that owns the contact
            var user = user_example;  // String | The username of the user that owns the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get contact for user
                PersonalContactDto result = apiInstance.getPersonalContact(domain, user, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPersonalContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user that owns the contact
$user = user_example; // String | The username of the user that owns the contact
$cid = cid_example; // String | The ID of the contact

try {
    $result = $api_instance->getPersonalContact($domain, $user, $cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPersonalContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user that owns the contact
my $user = user_example; # String | The username of the user that owns the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getPersonalContact(domain => $domain, user => $user, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPersonalContact: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user that owns the contact
user = user_example # String | The username of the user that owns the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get contact for user
    api_response = api_instance.get_personal_contact(domain, user, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPersonalContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user that owns the contact
Required
user*
String
The username of the user that owns the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"USER","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}
{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"USER","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPersonalContactForGroup

Get contact for user group

Retrieve a contact for a user group in the organization.


/personal_contacts/group/{domain}/{groupId}/{cid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/group/{domain}/{groupId}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PersonalContactDto result = apiInstance.getPersonalContactForGroup(domain, groupId, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactForGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PersonalContactDto result = apiInstance.getPersonalContactForGroup(domain, groupId, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactForGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user group that owns the contact
String *groupId = groupId_example; // The name of the user group that owns the contact
String *cid = cid_example; // The ID of the contact

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Get contact for user group
[apiInstance getPersonalContactForGroupWith:domain
    groupId:groupId
    cid:cid
              completionHandler: ^(PersonalContactDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user group that owns the contact
var groupId = groupId_example; // {{String}} The name of the user group that owns the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonalContactForGroup(domain, groupId, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonalContactForGroupExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user group that owns the contact
            var groupId = groupId_example;  // String | The name of the user group that owns the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get contact for user group
                PersonalContactDto result = apiInstance.getPersonalContactForGroup(domain, groupId, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPersonalContactForGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user group that owns the contact
$groupId = groupId_example; // String | The name of the user group that owns the contact
$cid = cid_example; // String | The ID of the contact

try {
    $result = $api_instance->getPersonalContactForGroup($domain, $groupId, $cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPersonalContactForGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user group that owns the contact
my $groupId = groupId_example; # String | The name of the user group that owns the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getPersonalContactForGroup(domain => $domain, groupId => $groupId, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPersonalContactForGroup: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user group that owns the contact
groupId = groupId_example # String | The name of the user group that owns the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get contact for user group
    api_response = api_instance.get_personal_contact_for_group(domain, groupId, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPersonalContactForGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user group that owns the contact
Required
groupId*
String
The name of the user group that owns the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"GROUP","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}
{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"GROUP","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPersonalContactForOrg

Get contact for organization

Retrieve the specific contact on the organization level when requested by an administrator.


/personal_contacts/org/{domain}/{cid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/org/{domain}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PersonalContactsDto result = apiInstance.getPersonalContactForOrg(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactForOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        String cid = cid_example; // String | The ID of the contact
        try {
            PersonalContactsDto result = apiInstance.getPersonalContactForOrg(domain, cid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactForOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization that owns the contact
String *cid = cid_example; // The ID of the contact

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Get contact for organization
[apiInstance getPersonalContactForOrgWith:domain
    cid:cid
              completionHandler: ^(PersonalContactsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the organization that owns the contact
var cid = cid_example; // {{String}} The ID of the contact

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonalContactForOrg(domain, cid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonalContactForOrgExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the organization that owns the contact
            var cid = cid_example;  // String | The ID of the contact

            try
            {
                // Get contact for organization
                PersonalContactsDto result = apiInstance.getPersonalContactForOrg(domain, cid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPersonalContactForOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the organization that owns the contact
$cid = cid_example; // String | The ID of the contact

try {
    $result = $api_instance->getPersonalContactForOrg($domain, $cid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPersonalContactForOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the organization that owns the contact
my $cid = cid_example; # String | The ID of the contact

eval { 
    my $result = $api_instance->getPersonalContactForOrg(domain => $domain, cid => $cid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPersonalContactForOrg: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the organization that owns the contact
cid = cid_example # String | The ID of the contact

try: 
    # Get contact for organization
    api_response = api_instance.get_personal_contact_for_org(domain, cid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPersonalContactForOrg: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization that owns the contact
Required
cid*
String
The ID of the contact
Required

Responses

Status: 200 - OK

{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"ORG","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}
{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"ORG","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPersonalContacts

List contacts for user

List all contacts for a user in the organization.


/personal_contacts/user/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/user/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contacts
        String user = user_example; // String | The username of the user that owns the contacts
        try {
            PersonalContactsDto result = apiInstance.getPersonalContacts(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContacts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contacts
        String user = user_example; // String | The username of the user that owns the contacts
        try {
            PersonalContactsDto result = apiInstance.getPersonalContacts(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContacts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user that owns the contacts
String *user = user_example; // The username of the user that owns the contacts

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// List contacts for user
[apiInstance getPersonalContactsWith:domain
    user:user
              completionHandler: ^(PersonalContactsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user that owns the contacts
var user = user_example; // {{String}} The username of the user that owns the contacts

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonalContacts(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonalContactsExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user that owns the contacts
            var user = user_example;  // String | The username of the user that owns the contacts

            try
            {
                // List contacts for user
                PersonalContactsDto result = apiInstance.getPersonalContacts(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPersonalContacts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user that owns the contacts
$user = user_example; // String | The username of the user that owns the contacts

try {
    $result = $api_instance->getPersonalContacts($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPersonalContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user that owns the contacts
my $user = user_example; # String | The username of the user that owns the contacts

eval { 
    my $result = $api_instance->getPersonalContacts(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPersonalContacts: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user that owns the contacts
user = user_example # String | The username of the user that owns the contacts

try: 
    # List contacts for user
    api_response = api_instance.get_personal_contacts(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPersonalContacts: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user that owns the contacts
Required
user*
String
The username of the user that owns the contacts
Required

Responses

Status: 200 - OK

{"personal_contact":[{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"USER","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]},{"cid":"167271@internal","company":"Telepo AB","department":"Support","firstname":"Bob","lastname":"Dilen","shortname":"bodi","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":7,"showInDefaultContactList":true,"contactStatus":"CONTACT","ownerType":"USER","phoneNumbers":[{"type":"MAIN","phoneNumber":"+46890657890","preferredNumber":true,"abbreviatednumber":"7890"}]}]}
{"personal_contact":[{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"USER","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]},{"cid":"167271@internal","company":"Telepo AB","department":"Support","firstname":"Bob","lastname":"Dilen","shortname":"bodi","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":7,"showInDefaultContactList":true,"contactStatus":"CONTACT","ownerType":"USER","phoneNumbers":[{"type":"MAIN","phoneNumber":"+46890657890","preferredNumber":true,"abbreviatednumber":"7890"}]}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPersonalContactsForGroup

List contacts for user group

List all contacts for a user group in the organization.


/personal_contacts/group/{domain}/{groupId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/group/{domain}/{groupId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contacts
        String groupId = groupId_example; // String | The name of the user group that owns the contacts
        try {
            PersonalContactsDto result = apiInstance.getPersonalContactsForGroup(domain, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactsForGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contacts
        String groupId = groupId_example; // String | The name of the user group that owns the contacts
        try {
            PersonalContactsDto result = apiInstance.getPersonalContactsForGroup(domain, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactsForGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user group that owns the contacts
String *groupId = groupId_example; // The name of the user group that owns the contacts

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// List contacts for user group
[apiInstance getPersonalContactsForGroupWith:domain
    groupId:groupId
              completionHandler: ^(PersonalContactsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user group that owns the contacts
var groupId = groupId_example; // {{String}} The name of the user group that owns the contacts

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonalContactsForGroup(domain, groupId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonalContactsForGroupExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user group that owns the contacts
            var groupId = groupId_example;  // String | The name of the user group that owns the contacts

            try
            {
                // List contacts for user group
                PersonalContactsDto result = apiInstance.getPersonalContactsForGroup(domain, groupId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPersonalContactsForGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user group that owns the contacts
$groupId = groupId_example; // String | The name of the user group that owns the contacts

try {
    $result = $api_instance->getPersonalContactsForGroup($domain, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPersonalContactsForGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user group that owns the contacts
my $groupId = groupId_example; # String | The name of the user group that owns the contacts

eval { 
    my $result = $api_instance->getPersonalContactsForGroup(domain => $domain, groupId => $groupId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPersonalContactsForGroup: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user group that owns the contacts
groupId = groupId_example # String | The name of the user group that owns the contacts

try: 
    # List contacts for user group
    api_response = api_instance.get_personal_contacts_for_group(domain, groupId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPersonalContactsForGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user group that owns the contacts
Required
groupId*
String
The name of the user group that owns the contacts
Required

Responses

Status: 200 - OK

{"personal_contact":[{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"GROUP","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]},{"cid":"167271@internal","company":"Telepo AB","department":"Support","firstname":"Bob","lastname":"Dilen","shortname":"bodi","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":7,"showInDefaultContactList":true,"contactStatus":"CONTACT","ownerType":"GROUP","phoneNumbers":[{"type":"MAIN","phoneNumber":"+46890657890","preferredNumber":true,"abbreviatednumber":"7890"}]}]}
{"personal_contact":[{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"GROUP","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]},{"cid":"167271@internal","company":"Telepo AB","department":"Support","firstname":"Bob","lastname":"Dilen","shortname":"bodi","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":7,"showInDefaultContactList":true,"contactStatus":"CONTACT","ownerType":"GROUP","phoneNumbers":[{"type":"MAIN","phoneNumber":"+46890657890","preferredNumber":true,"abbreviatednumber":"7890"}]}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPersonalContactsForOrg

List contacts for organization

List all contacts on orgnizaton level when requested by an administrator.


/personal_contacts/org/{domain}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/org/{domain}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contacts
        try {
            PersonalContactsDto result = apiInstance.getPersonalContactsForOrg(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactsForOrg");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contacts
        try {
            PersonalContactsDto result = apiInstance.getPersonalContactsForOrg(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPersonalContactsForOrg");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization that owns the contacts

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// List contacts for organization
[apiInstance getPersonalContactsForOrgWith:domain
              completionHandler: ^(PersonalContactsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the organization that owns the contacts

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPersonalContactsForOrg(domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonalContactsForOrgExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the organization that owns the contacts

            try
            {
                // List contacts for organization
                PersonalContactsDto result = apiInstance.getPersonalContactsForOrg(domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPersonalContactsForOrg: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the organization that owns the contacts

try {
    $result = $api_instance->getPersonalContactsForOrg($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPersonalContactsForOrg: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the organization that owns the contacts

eval { 
    my $result = $api_instance->getPersonalContactsForOrg(domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPersonalContactsForOrg: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the organization that owns the contacts

try: 
    # List contacts for organization
    api_response = api_instance.get_personal_contacts_for_org(domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPersonalContactsForOrg: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization that owns the contacts
Required

Responses

Status: 200 - OK

{"personal_contact":[{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"ORG","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]},{"cid":"167271@internal","company":"Telepo AB","department":"Support","firstname":"Bob","lastname":"Dilen","shortname":"bodi","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":7,"showInDefaultContactList":true,"contactStatus":"CONTACT","ownerType":"ORG","phoneNumbers":[{"type":"MAIN","phoneNumber":"+46890657890","preferredNumber":true,"abbreviatednumber":"7890"}]}]}
{"personal_contact":[{"cid":"167271@internal","company":"Telepo AB","department":"Rnd","firstname":"John","lastname":"Doe","shortname":"jodo","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":5,"showInDefaultContactList":true,"contactStatus":"VIP","ownerType":"ORG","phoneNumbers":[{"type":"WORK","phoneNumber":"+46850654760","preferredNumber":true,"abbreviatednumber":"4760"}]},{"cid":"167271@internal","company":"Telepo AB","department":"Support","firstname":"Bob","lastname":"Dilen","shortname":"bodi","email":"info@mitel.com","street":"Arenavagen 63","city":"Stockholm","postalcode":"12177","country":"Sweden","speeddial":7,"showInDefaultContactList":true,"contactStatus":"CONTACT","ownerType":"ORG","phoneNumbers":[{"type":"MAIN","phoneNumber":"+46890657890","preferredNumber":true,"abbreviatednumber":"7890"}]}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getPhoneLabels

Get localized phone labels

Retrieve localized phone labels.


/personal_contacts/phone_labels/{domain}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//personal_contacts/phone_labels/{domain}?locale="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization
        String locale = locale_example; // String | The locale to be translated to
        try {
            PhoneLabelsDto result = apiInstance.getPhoneLabels(domain, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPhoneLabels");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization
        String locale = locale_example; // String | The locale to be translated to
        try {
            PhoneLabelsDto result = apiInstance.getPhoneLabels(domain, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#getPhoneLabels");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization
String *locale = locale_example; // The locale to be translated to

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Get localized phone labels
[apiInstance getPhoneLabelsWith:domain
    locale:locale
              completionHandler: ^(PhoneLabelsDto output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the organization
var locale = locale_example; // {{String}} The locale to be translated to

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPhoneLabels(domain, locale, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPhoneLabelsExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the organization
            var locale = locale_example;  // String | The locale to be translated to

            try
            {
                // Get localized phone labels
                PhoneLabelsDto result = apiInstance.getPhoneLabels(domain, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.getPhoneLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the organization
$locale = locale_example; // String | The locale to be translated to

try {
    $result = $api_instance->getPhoneLabels($domain, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->getPhoneLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the organization
my $locale = locale_example; # String | The locale to be translated to

eval { 
    my $result = $api_instance->getPhoneLabels(domain => $domain, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->getPhoneLabels: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the organization
locale = locale_example # String | The locale to be translated to

try: 
    # Get localized phone labels
    api_response = api_instance.get_phone_labels(domain, locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->getPhoneLabels: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
Query parameters
Name Description
locale*
String
The locale to be translated to
Required

Responses

Status: 200 - OK

{"phoneLabels":[{"labelValue":"HOME","labelName":"Home"},{"labelValue":"WORK","labelName":"Work"},{"labelValue":"MOBILE","labelName":"Mobile"},{"labelValue":"MAIN","labelName":"Main"},{"labelValue":"WORK_FAX","labelName":"Work fax"},{"labelValue":"HOME_FAX","labelName":"Home fax"},{"labelValue":"PAGER","labelName":"Pager"},{"labelValue":"OTHER","labelName":"Other"}]}
{"phoneLabels":[{"labelValue":"HOME","labelName":"Home"},{"labelValue":"WORK","labelName":"Work"},{"labelValue":"MOBILE","labelName":"Mobile"},{"labelValue":"MAIN","labelName":"Main"},{"labelValue":"WORK_FAX","labelName":"Work fax"},{"labelValue":"HOME_FAX","labelName":"Home fax"},{"labelValue":"PAGER","labelName":"Pager"},{"labelValue":"OTHER","labelName":"Other"}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updatePersonalContact

Update contact for user

Update the specific contact for a user in the organization.


/personal_contacts/user/{domain}/{user}/{cid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//personal_contacts/user/{domain}/{user}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        String cid = cid_example; // String | The ID of the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 
        try {
            apiInstance.updatePersonalContact(domain, user, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#updatePersonalContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user that owns the contact
        String user = user_example; // String | The username of the user that owns the contact
        String cid = cid_example; // String | The ID of the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 
        try {
            apiInstance.updatePersonalContact(domain, user, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#updatePersonalContact");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user that owns the contact
String *user = user_example; // The username of the user that owns the contact
String *cid = cid_example; // The ID of the contact
PersonalContactDto *body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; //  (optional)

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Update contact for user
[apiInstance updatePersonalContactWith:domain
    user:user
    cid:cid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user that owns the contact
var user = user_example; // {{String}} The username of the user that owns the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'body': {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
} // {{PersonalContactDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePersonalContact(domainusercid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePersonalContactExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user that owns the contact
            var user = user_example;  // String | The username of the user that owns the contact
            var cid = cid_example;  // String | The ID of the contact
            var body = new PersonalContactDto(); // PersonalContactDto |  (optional) 

            try
            {
                // Update contact for user
                apiInstance.updatePersonalContact(domain, user, cid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.updatePersonalContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user that owns the contact
$user = user_example; // String | The username of the user that owns the contact
$cid = cid_example; // String | The ID of the contact
$body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 

try {
    $api_instance->updatePersonalContact($domain, $user, $cid, $body);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->updatePersonalContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user that owns the contact
my $user = user_example; # String | The username of the user that owns the contact
my $cid = cid_example; # String | The ID of the contact
my $body = WWW::SwaggerClient::Object::PersonalContactDto->new(); # PersonalContactDto | 

eval { 
    $api_instance->updatePersonalContact(domain => $domain, user => $user, cid => $cid, body => $body);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->updatePersonalContact: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user that owns the contact
user = user_example # String | The username of the user that owns the contact
cid = cid_example # String | The ID of the contact
body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "USER",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
} # PersonalContactDto |  (optional)

try: 
    # Update contact for user
    api_instance.update_personal_contact(domain, user, cid, body=body)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->updatePersonalContact: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user that owns the contact
Required
user*
String
The username of the user that owns the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updatePersonalContactInGroup

Update contact for organization

Update the specific contact on organization level when requested by an administrator.


/personal_contacts/org/{domain}/{cid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//personal_contacts/org/{domain}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        String cid = cid_example; // String | The ID of the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 
        try {
            apiInstance.updatePersonalContactInGroup(domain, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#updatePersonalContactInGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the organization that owns the contact
        String cid = cid_example; // String | The ID of the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 
        try {
            apiInstance.updatePersonalContactInGroup(domain, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#updatePersonalContactInGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization that owns the contact
String *cid = cid_example; // The ID of the contact
PersonalContactDto *body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; //  (optional)

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Update contact for organization
[apiInstance updatePersonalContactInGroupWith:domain
    cid:cid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the organization that owns the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'body': {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
} // {{PersonalContactDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePersonalContactInGroup(domaincid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePersonalContactInGroupExample
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the organization that owns the contact
            var cid = cid_example;  // String | The ID of the contact
            var body = new PersonalContactDto(); // PersonalContactDto |  (optional) 

            try
            {
                // Update contact for organization
                apiInstance.updatePersonalContactInGroup(domain, cid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.updatePersonalContactInGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the organization that owns the contact
$cid = cid_example; // String | The ID of the contact
$body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 

try {
    $api_instance->updatePersonalContactInGroup($domain, $cid, $body);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->updatePersonalContactInGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the organization that owns the contact
my $cid = cid_example; # String | The ID of the contact
my $body = WWW::SwaggerClient::Object::PersonalContactDto->new(); # PersonalContactDto | 

eval { 
    $api_instance->updatePersonalContactInGroup(domain => $domain, cid => $cid, body => $body);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->updatePersonalContactInGroup: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the organization that owns the contact
cid = cid_example # String | The ID of the contact
body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "ORG",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
} # PersonalContactDto |  (optional)

try: 
    # Update contact for organization
    api_instance.update_personal_contact_in_group(domain, cid, body=body)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->updatePersonalContactInGroup: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization that owns the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updatePersonalContactInGroup1

Update contact for user group

Update the specific contact for a user group in the organization.


/personal_contacts/group/{domain}/{groupId}/{cid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//personal_contacts/group/{domain}/{groupId}/{cid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PersonalContactsApi;

import java.io.File;
import java.util.*;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        String cid = cid_example; // String | The ID of the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 
        try {
            apiInstance.updatePersonalContactInGroup1(domain, groupId, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#updatePersonalContactInGroup1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PersonalContactsApi;

public class PersonalContactsApiExample {

    public static void main(String[] args) {
        PersonalContactsApi apiInstance = new PersonalContactsApi();
        String domain = domain_example; // String | The domain of the user group that owns the contact
        String groupId = groupId_example; // String | The name of the user group that owns the contact
        String cid = cid_example; // String | The ID of the contact
        PersonalContactDto body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 
        try {
            apiInstance.updatePersonalContactInGroup1(domain, groupId, cid, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PersonalContactsApi#updatePersonalContactInGroup1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user group that owns the contact
String *groupId = groupId_example; // The name of the user group that owns the contact
String *cid = cid_example; // The ID of the contact
PersonalContactDto *body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; //  (optional)

PersonalContactsApi *apiInstance = [[PersonalContactsApi alloc] init];

// Update contact for user group
[apiInstance updatePersonalContactInGroup1With:domain
    groupId:groupId
    cid:cid
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PersonalContactsApi()
var domain = domain_example; // {{String}} The domain of the user group that owns the contact
var groupId = groupId_example; // {{String}} The name of the user group that owns the contact
var cid = cid_example; // {{String}} The ID of the contact
var opts = { 
  'body': {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
} // {{PersonalContactDto}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updatePersonalContactInGroup1(domaingroupIdcid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updatePersonalContactInGroup1Example
    {
        public void main()
        {


            var apiInstance = new PersonalContactsApi();
            var domain = domain_example;  // String | The domain of the user group that owns the contact
            var groupId = groupId_example;  // String | The name of the user group that owns the contact
            var cid = cid_example;  // String | The ID of the contact
            var body = new PersonalContactDto(); // PersonalContactDto |  (optional) 

            try
            {
                // Update contact for user group
                apiInstance.updatePersonalContactInGroup1(domain, groupId, cid, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PersonalContactsApi.updatePersonalContactInGroup1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPersonalContactsApi();
$domain = domain_example; // String | The domain of the user group that owns the contact
$groupId = groupId_example; // String | The name of the user group that owns the contact
$cid = cid_example; // String | The ID of the contact
$body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
}; // PersonalContactDto | 

try {
    $api_instance->updatePersonalContactInGroup1($domain, $groupId, $cid, $body);
} catch (Exception $e) {
    echo 'Exception when calling PersonalContactsApi->updatePersonalContactInGroup1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PersonalContactsApi;


my $api_instance = WWW::SwaggerClient::PersonalContactsApi->new();
my $domain = domain_example; # String | The domain of the user group that owns the contact
my $groupId = groupId_example; # String | The name of the user group that owns the contact
my $cid = cid_example; # String | The ID of the contact
my $body = WWW::SwaggerClient::Object::PersonalContactDto->new(); # PersonalContactDto | 

eval { 
    $api_instance->updatePersonalContactInGroup1(domain => $domain, groupId => $groupId, cid => $cid, body => $body);
};
if ($@) {
    warn "Exception when calling PersonalContactsApi->updatePersonalContactInGroup1: $@\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.PersonalContactsApi()
domain = domain_example # String | The domain of the user group that owns the contact
groupId = groupId_example # String | The name of the user group that owns the contact
cid = cid_example # String | The ID of the contact
body = {
  "cid" : "167271@internal",
  "company" : "Telepo AB",
  "department" : "Support",
  "firstname" : "Bob",
  "lastname" : "Dilen",
  "shortname" : "bodi",
  "email" : "info@mitel.com",
  "street" : "Arenavagen 63",
  "city" : "Stockholm",
  "postalcode" : "12177",
  "country" : "Sweden",
  "speeddial" : 7,
  "showInDefaultContactList" : true,
  "contactStatus" : "CONTACT",
  "ownerType" : "GROUP",
  "phoneNumbers" : [ {
    "type" : "MAIN",
    "phoneNumber" : "+46890657890",
    "preferredNumber" : true,
    "abbreviatednumber" : "7890"
  } ]
} # PersonalContactDto |  (optional)

try: 
    # Update contact for user group
    api_instance.update_personal_contact_in_group1(domain, groupId, cid, body=body)
except ApiException as e:
    print("Exception when calling PersonalContactsApi->updatePersonalContactInGroup1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user group that owns the contact
Required
groupId*
String
The name of the user group that owns the contact
Required
cid*
String
The ID of the contact
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


PresenceShortcuts

deleteShortcut

Delete a presence shortcut

Delete a specific presence shortcut for a user.


/presence/shortcut/{domain}/{user}/{id}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//presence/shortcut/{domain}/{user}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PresenceShortcutsApi;

import java.io.File;
import java.util.*;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String id = id_example; // String | The ID of the presence shortcut that should be deleted
        try {
            apiInstance.deleteShortcut(domain, user, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#deleteShortcut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PresenceShortcutsApi;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String id = id_example; // String | The ID of the presence shortcut that should be deleted
        try {
            apiInstance.deleteShortcut(domain, user, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#deleteShortcut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API
String *id = id_example; // The ID of the presence shortcut that should be deleted

PresenceShortcutsApi *apiInstance = [[PresenceShortcutsApi alloc] init];

// Delete a presence shortcut
[apiInstance deleteShortcutWith:domain
    user:user
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PresenceShortcutsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API
var id = id_example; // {{String}} The ID of the presence shortcut that should be deleted

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteShortcut(domain, user, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteShortcutExample
    {
        public void main()
        {


            var apiInstance = new PresenceShortcutsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API
            var id = id_example;  // String | The ID of the presence shortcut that should be deleted

            try
            {
                // Delete a presence shortcut
                apiInstance.deleteShortcut(domain, user, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PresenceShortcutsApi.deleteShortcut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPresenceShortcutsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API
$id = id_example; // String | The ID of the presence shortcut that should be deleted

try {
    $api_instance->deleteShortcut($domain, $user, $id);
} catch (Exception $e) {
    echo 'Exception when calling PresenceShortcutsApi->deleteShortcut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PresenceShortcutsApi;


my $api_instance = WWW::SwaggerClient::PresenceShortcutsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API
my $id = id_example; # String | The ID of the presence shortcut that should be deleted

eval { 
    $api_instance->deleteShortcut(domain => $domain, user => $user, id => $id);
};
if ($@) {
    warn "Exception when calling PresenceShortcutsApi->deleteShortcut: $@\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.PresenceShortcutsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API
id = id_example # String | The ID of the presence shortcut that should be deleted

try: 
    # Delete a presence shortcut
    api_instance.delete_shortcut(domain, user, id)
except ApiException as e:
    print("Exception when calling PresenceShortcutsApi->deleteShortcut: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required
id*
String
The ID of the presence shortcut that should be deleted
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


deleteShortcuts

Delete presence shortcuts

Delete all presence shortcuts for a user.


/presence/shortcut/{domain}/{user}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//presence/shortcut/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PresenceShortcutsApi;

import java.io.File;
import java.util.*;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            apiInstance.deleteShortcuts(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#deleteShortcuts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PresenceShortcutsApi;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            apiInstance.deleteShortcuts(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#deleteShortcuts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

PresenceShortcutsApi *apiInstance = [[PresenceShortcutsApi alloc] init];

// Delete presence shortcuts
[apiInstance deleteShortcutsWith:domain
    user:user
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PresenceShortcutsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteShortcuts(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteShortcutsExample
    {
        public void main()
        {


            var apiInstance = new PresenceShortcutsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // Delete presence shortcuts
                apiInstance.deleteShortcuts(domain, user);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PresenceShortcutsApi.deleteShortcuts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPresenceShortcutsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $api_instance->deleteShortcuts($domain, $user);
} catch (Exception $e) {
    echo 'Exception when calling PresenceShortcutsApi->deleteShortcuts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PresenceShortcutsApi;


my $api_instance = WWW::SwaggerClient::PresenceShortcutsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    $api_instance->deleteShortcuts(domain => $domain, user => $user);
};
if ($@) {
    warn "Exception when calling PresenceShortcutsApi->deleteShortcuts: $@\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.PresenceShortcutsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # Delete presence shortcuts
    api_instance.delete_shortcuts(domain, user)
except ApiException as e:
    print("Exception when calling PresenceShortcutsApi->deleteShortcuts: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getShortcut

Read a presence shortcut

Read a specific presence shortcut for the user.


/presence/shortcut/{domain}/{user}/{id}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//presence/shortcut/{domain}/{user}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PresenceShortcutsApi;

import java.io.File;
import java.util.*;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String id = id_example; // String | The ID of the presence shortcut that should be read
        try {
            PresenceShortcutDTO result = apiInstance.getShortcut(domain, user, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#getShortcut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PresenceShortcutsApi;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String id = id_example; // String | The ID of the presence shortcut that should be read
        try {
            PresenceShortcutDTO result = apiInstance.getShortcut(domain, user, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#getShortcut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API
String *id = id_example; // The ID of the presence shortcut that should be read

PresenceShortcutsApi *apiInstance = [[PresenceShortcutsApi alloc] init];

// Read a presence shortcut
[apiInstance getShortcutWith:domain
    user:user
    id:id
              completionHandler: ^(PresenceShortcutDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PresenceShortcutsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API
var id = id_example; // {{String}} The ID of the presence shortcut that should be read

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShortcut(domain, user, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShortcutExample
    {
        public void main()
        {


            var apiInstance = new PresenceShortcutsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API
            var id = id_example;  // String | The ID of the presence shortcut that should be read

            try
            {
                // Read a presence shortcut
                PresenceShortcutDTO result = apiInstance.getShortcut(domain, user, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PresenceShortcutsApi.getShortcut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPresenceShortcutsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API
$id = id_example; // String | The ID of the presence shortcut that should be read

try {
    $result = $api_instance->getShortcut($domain, $user, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PresenceShortcutsApi->getShortcut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PresenceShortcutsApi;


my $api_instance = WWW::SwaggerClient::PresenceShortcutsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API
my $id = id_example; # String | The ID of the presence shortcut that should be read

eval { 
    my $result = $api_instance->getShortcut(domain => $domain, user => $user, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PresenceShortcutsApi->getShortcut: $@\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.PresenceShortcutsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API
id = id_example # String | The ID of the presence shortcut that should be read

try: 
    # Read a presence shortcut
    api_response = api_instance.get_shortcut(domain, user, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PresenceShortcutsApi->getShortcut: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required
id*
String
The ID of the presence shortcut that should be read
Required

Responses

Status: 200 - OK

{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false}
{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false}

Status: 403 - Not Authorized

Status: 404 - Not Found


getShortcuts

List presence shortcuts

Read all presence shortcuts for a user.


/presence/shortcut/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//presence/shortcut/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PresenceShortcutsApi;

import java.io.File;
import java.util.*;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            PresenceShortcutsDTO result = apiInstance.getShortcuts(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#getShortcuts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PresenceShortcutsApi;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            PresenceShortcutsDTO result = apiInstance.getShortcuts(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#getShortcuts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

PresenceShortcutsApi *apiInstance = [[PresenceShortcutsApi alloc] init];

// List presence shortcuts
[apiInstance getShortcutsWith:domain
    user:user
              completionHandler: ^(PresenceShortcutsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PresenceShortcutsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShortcuts(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShortcutsExample
    {
        public void main()
        {


            var apiInstance = new PresenceShortcutsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // List presence shortcuts
                PresenceShortcutsDTO result = apiInstance.getShortcuts(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PresenceShortcutsApi.getShortcuts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPresenceShortcutsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getShortcuts($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PresenceShortcutsApi->getShortcuts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PresenceShortcutsApi;


my $api_instance = WWW::SwaggerClient::PresenceShortcutsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getShortcuts(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PresenceShortcutsApi->getShortcuts: $@\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.PresenceShortcutsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # List presence shortcuts
    api_response = api_instance.get_shortcuts(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PresenceShortcutsApi->getShortcuts: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

{"presenceShortcut":[{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false},{"id":"23342323232","name":"Short lunch break","activityId":"lunch","available":false,"durationType":"MINUTES","durationMinutes":45,"order":2,"imageId":"ic_shortcut_pizza","diversionPhoneNumber":"+5545445656","applyDiversionNumber":true}]}
{"presenceShortcut":[{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false},{"id":"23342323232","name":"Short lunch break","activityId":"lunch","available":false,"durationType":"MINUTES","durationMinutes":45,"order":2,"imageId":"ic_shortcut_pizza","diversionPhoneNumber":"+5545445656","applyDiversionNumber":true}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


setShortcut

Update a presence shortcut

Update a specific presence shortcut for a user. A new shortcut will be created if it does not already exist.


/presence/shortcut/{domain}/{user}/{id}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//presence/shortcut/{domain}/{user}/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PresenceShortcutsApi;

import java.io.File;
import java.util.*;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String id = id_example; // String | The ID of the presence shortcut that should be updated
        PresenceShortcutDTO body = ; // PresenceShortcutDTO | 
        try {
            PresenceShortcutDTO result = apiInstance.setShortcut(domain, user, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#setShortcut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PresenceShortcutsApi;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        String id = id_example; // String | The ID of the presence shortcut that should be updated
        PresenceShortcutDTO body = ; // PresenceShortcutDTO | 
        try {
            PresenceShortcutDTO result = apiInstance.setShortcut(domain, user, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#setShortcut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API
String *id = id_example; // The ID of the presence shortcut that should be updated
PresenceShortcutDTO *body = ; //  (optional)

PresenceShortcutsApi *apiInstance = [[PresenceShortcutsApi alloc] init];

// Update a presence shortcut
[apiInstance setShortcutWith:domain
    user:user
    id:id
    body:body
              completionHandler: ^(PresenceShortcutDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PresenceShortcutsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API
var id = id_example; // {{String}} The ID of the presence shortcut that should be updated
var opts = { 
  'body':  // {{PresenceShortcutDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setShortcut(domainuserid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setShortcutExample
    {
        public void main()
        {


            var apiInstance = new PresenceShortcutsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API
            var id = id_example;  // String | The ID of the presence shortcut that should be updated
            var body = new PresenceShortcutDTO(); // PresenceShortcutDTO |  (optional) 

            try
            {
                // Update a presence shortcut
                PresenceShortcutDTO result = apiInstance.setShortcut(domain, user, id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PresenceShortcutsApi.setShortcut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPresenceShortcutsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API
$id = id_example; // String | The ID of the presence shortcut that should be updated
$body = ; // PresenceShortcutDTO | 

try {
    $result = $api_instance->setShortcut($domain, $user, $id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PresenceShortcutsApi->setShortcut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PresenceShortcutsApi;


my $api_instance = WWW::SwaggerClient::PresenceShortcutsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API
my $id = id_example; # String | The ID of the presence shortcut that should be updated
my $body = WWW::SwaggerClient::Object::PresenceShortcutDTO->new(); # PresenceShortcutDTO | 

eval { 
    my $result = $api_instance->setShortcut(domain => $domain, user => $user, id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PresenceShortcutsApi->setShortcut: $@\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.PresenceShortcutsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API
id = id_example # String | The ID of the presence shortcut that should be updated
body =  # PresenceShortcutDTO |  (optional)

try: 
    # Update a presence shortcut
    api_response = api_instance.set_shortcut(domain, user, id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PresenceShortcutsApi->setShortcut: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required
id*
String
The ID of the presence shortcut that should be updated
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false}
{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setShortcuts

Update presence shortcuts

Update all presence shortcuts for a user. Any existing presence shortcut for the user will be overwritten by this list.


/presence/shortcut/{domain}/{user}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//presence/shortcut/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PresenceShortcutsApi;

import java.io.File;
import java.util.*;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        PresenceShortcutsDTO body = ; // PresenceShortcutsDTO | 
        try {
            PresenceShortcutsDTO result = apiInstance.setShortcuts(domain, user, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#setShortcuts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PresenceShortcutsApi;

public class PresenceShortcutsApiExample {

    public static void main(String[] args) {
        PresenceShortcutsApi apiInstance = new PresenceShortcutsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        PresenceShortcutsDTO body = ; // PresenceShortcutsDTO | 
        try {
            PresenceShortcutsDTO result = apiInstance.setShortcuts(domain, user, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PresenceShortcutsApi#setShortcuts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API
PresenceShortcutsDTO *body = ; //  (optional)

PresenceShortcutsApi *apiInstance = [[PresenceShortcutsApi alloc] init];

// Update presence shortcuts
[apiInstance setShortcutsWith:domain
    user:user
    body:body
              completionHandler: ^(PresenceShortcutsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.PresenceShortcutsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API
var opts = { 
  'body':  // {{PresenceShortcutsDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setShortcuts(domainuser, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setShortcutsExample
    {
        public void main()
        {


            var apiInstance = new PresenceShortcutsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API
            var body = new PresenceShortcutsDTO(); // PresenceShortcutsDTO |  (optional) 

            try
            {
                // Update presence shortcuts
                PresenceShortcutsDTO result = apiInstance.setShortcuts(domain, user, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PresenceShortcutsApi.setShortcuts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiPresenceShortcutsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API
$body = ; // PresenceShortcutsDTO | 

try {
    $result = $api_instance->setShortcuts($domain, $user, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PresenceShortcutsApi->setShortcuts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PresenceShortcutsApi;


my $api_instance = WWW::SwaggerClient::PresenceShortcutsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API
my $body = WWW::SwaggerClient::Object::PresenceShortcutsDTO->new(); # PresenceShortcutsDTO | 

eval { 
    my $result = $api_instance->setShortcuts(domain => $domain, user => $user, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PresenceShortcutsApi->setShortcuts: $@\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.PresenceShortcutsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API
body =  # PresenceShortcutsDTO |  (optional)

try: 
    # Update presence shortcuts
    api_response = api_instance.set_shortcuts(domain, user, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PresenceShortcutsApi->setShortcuts: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

{"presenceShortcut":[{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false},{"id":"23342323232","name":"Short lunch break","activityId":"lunch","available":false,"durationType":"MINUTES","durationMinutes":45,"order":2,"imageId":"ic_shortcut_pizza","diversionPhoneNumber":"+5545445656","applyDiversionNumber":true}]}
{"presenceShortcut":[{"id":"sdfdsf3333","name":"Weekend","activityId":"busy","available":false,"durationType":"UNTIL_NEXT_WORKING_DAY","order":1,"imageId":"ic_shortcut_big_red","applyDiversionNumber":false},{"id":"23342323232","name":"Short lunch break","activityId":"lunch","available":false,"durationType":"MINUTES","durationMinutes":45,"order":2,"imageId":"ic_shortcut_pizza","diversionPhoneNumber":"+5545445656","applyDiversionNumber":true}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


QueueStatistics

getOrgStatistics

Get organization queue statistics

Retrieve the queue statistics for an organization.


/queue/statistics/v1/list/{domain}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//queue/statistics/v1/list/{domain}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueueStatisticsApi;

import java.io.File;
import java.util.*;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain queue statistics shall be fetched for
        try {
            QueueStatsDTO result = apiInstance.getOrgStatistics(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getOrgStatistics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueueStatisticsApi;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain queue statistics shall be fetched for
        try {
            QueueStatsDTO result = apiInstance.getOrgStatistics(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getOrgStatistics");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain queue statistics shall be fetched for

QueueStatisticsApi *apiInstance = [[QueueStatisticsApi alloc] init];

// Get organization queue statistics
[apiInstance getOrgStatisticsWith:domain
              completionHandler: ^(QueueStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.QueueStatisticsApi()
var domain = domain_example; // {{String}} The domain queue statistics shall be fetched for

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgStatistics(domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrgStatisticsExample
    {
        public void main()
        {

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new QueueStatisticsApi();
            var domain = domain_example;  // String | The domain queue statistics shall be fetched for

            try
            {
                // Get organization queue statistics
                QueueStatsDTO result = apiInstance.getOrgStatistics(domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueueStatisticsApi.getOrgStatistics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiQueueStatisticsApi();
$domain = domain_example; // String | The domain queue statistics shall be fetched for

try {
    $result = $api_instance->getOrgStatistics($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueueStatisticsApi->getOrgStatistics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueueStatisticsApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QueueStatisticsApi->new();
my $domain = domain_example; # String | The domain queue statistics shall be fetched for

eval { 
    my $result = $api_instance->getOrgStatistics(domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueueStatisticsApi->getOrgStatistics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QueueStatisticsApi()
domain = domain_example # String | The domain queue statistics shall be fetched for

try: 
    # Get organization queue statistics
    api_response = api_instance.get_org_statistics(domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueueStatisticsApi->getOrgStatistics: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain queue statistics shall be fetched for
Required
Query parameters
Name Description

Responses

Status: 200 - OK

{"queue":[{"name":"ACD_Tax","domain":"test.com","number":"+123415","id":67899,"queueLength":3,"availableAgents":2,"loggedInAgents":5,"longestWaiting":20,"lastWait":15,"averageWait":14,"droppedCallsForPeriod":6,"totalCallsForPeriod":60,"answeredCallsForPeriod":41,"totalCallsLast24h":50,"droppedCallsLast24h":4,"answeredCallsLast24h":38,"current-agent-presence":[{"name":"Available","count":1}]}]}

Status: 404 - Not Found


getOrgStatisticsDeprecated

Get organization queue statistics

Retrieve the queue statistics for an organization.<br><br><i>NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.</i>


/queue/statistics/{domain}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//queue/statistics/{domain}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueueStatisticsApi;

import java.io.File;
import java.util.*;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain queue statistics shall be fetched for
        try {
            QueueStatsDTO result = apiInstance.getOrgStatisticsDeprecated(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getOrgStatisticsDeprecated");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueueStatisticsApi;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain queue statistics shall be fetched for
        try {
            QueueStatsDTO result = apiInstance.getOrgStatisticsDeprecated(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getOrgStatisticsDeprecated");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain queue statistics shall be fetched for

QueueStatisticsApi *apiInstance = [[QueueStatisticsApi alloc] init];

// Get organization queue statistics
[apiInstance getOrgStatisticsDeprecatedWith:domain
              completionHandler: ^(QueueStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.QueueStatisticsApi()
var domain = domain_example; // {{String}} The domain queue statistics shall be fetched for

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrgStatisticsDeprecated(domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrgStatisticsDeprecatedExample
    {
        public void main()
        {

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new QueueStatisticsApi();
            var domain = domain_example;  // String | The domain queue statistics shall be fetched for

            try
            {
                // Get organization queue statistics
                QueueStatsDTO result = apiInstance.getOrgStatisticsDeprecated(domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueueStatisticsApi.getOrgStatisticsDeprecated: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiQueueStatisticsApi();
$domain = domain_example; // String | The domain queue statistics shall be fetched for

try {
    $result = $api_instance->getOrgStatisticsDeprecated($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueueStatisticsApi->getOrgStatisticsDeprecated: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueueStatisticsApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QueueStatisticsApi->new();
my $domain = domain_example; # String | The domain queue statistics shall be fetched for

eval { 
    my $result = $api_instance->getOrgStatisticsDeprecated(domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueueStatisticsApi->getOrgStatisticsDeprecated: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QueueStatisticsApi()
domain = domain_example # String | The domain queue statistics shall be fetched for

try: 
    # Get organization queue statistics
    api_response = api_instance.get_org_statistics_deprecated(domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueueStatisticsApi->getOrgStatisticsDeprecated: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain queue statistics shall be fetched for
Required
Query parameters
Name Description

Responses

Status: 200 - OK

{"queue":[{"name":"ACD_Tax","domain":"test.com","number":"+123415","id":67899,"queueLength":3,"availableAgents":2,"loggedInAgents":5,"longestWaiting":20,"lastWait":15,"averageWait":14,"droppedCallsForPeriod":6,"totalCallsForPeriod":60,"answeredCallsForPeriod":41,"totalCallsLast24h":50,"droppedCallsLast24h":4,"answeredCallsLast24h":38,"current-agent-presence":[{"name":"Available","count":1}]}]}
{"queue":[{"name":"ACD_Tax","domain":"test.com","number":"+123415","id":67899,"queueLength":3,"availableAgents":2,"loggedInAgents":5,"longestWaiting":20,"lastWait":15,"averageWait":14,"droppedCallsForPeriod":6,"totalCallsForPeriod":60,"answeredCallsForPeriod":41,"totalCallsLast24h":50,"droppedCallsLast24h":4,"answeredCallsLast24h":38,"current-agent-presence":[{"name":"Available","count":1}]}]}

Status: 404 - Not Found


getUserStatistics

Get user queue statistics

Retrieve queue statistics for a user who is authorized to supervise specific groups.


/queue/statistics/v1/list/{domain}/{user}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//queue/statistics/v1/list/{domain}/{user}?includeFederation="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueueStatisticsApi;

import java.io.File;
import java.util.*;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain of the user queue statistics shall be fetched for
        String user = user_example; // String | The username of the user queue statistics shall be fetched for
        Boolean includeFederation = true; // Boolean | If queue statistics from federated organizations shall be included (default false)
        try {
            QueueStatsDTO result = apiInstance.getUserStatistics(domain, user, includeFederation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getUserStatistics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueueStatisticsApi;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain of the user queue statistics shall be fetched for
        String user = user_example; // String | The username of the user queue statistics shall be fetched for
        Boolean includeFederation = true; // Boolean | If queue statistics from federated organizations shall be included (default false)
        try {
            QueueStatsDTO result = apiInstance.getUserStatistics(domain, user, includeFederation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getUserStatistics");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the user queue statistics shall be fetched for
String *user = user_example; // The username of the user queue statistics shall be fetched for
Boolean *includeFederation = true; // If queue statistics from federated organizations shall be included (default false) (optional)

QueueStatisticsApi *apiInstance = [[QueueStatisticsApi alloc] init];

// Get user queue statistics
[apiInstance getUserStatisticsWith:domain
    user:user
    includeFederation:includeFederation
              completionHandler: ^(QueueStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.QueueStatisticsApi()
var domain = domain_example; // {{String}} The domain of the user queue statistics shall be fetched for
var user = user_example; // {{String}} The username of the user queue statistics shall be fetched for
var opts = { 
  'includeFederation': true // {{Boolean}} If queue statistics from federated organizations shall be included (default false)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserStatistics(domain, user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserStatisticsExample
    {
        public void main()
        {

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new QueueStatisticsApi();
            var domain = domain_example;  // String | The domain of the user queue statistics shall be fetched for
            var user = user_example;  // String | The username of the user queue statistics shall be fetched for
            var includeFederation = true;  // Boolean | If queue statistics from federated organizations shall be included (default false) (optional) 

            try
            {
                // Get user queue statistics
                QueueStatsDTO result = apiInstance.getUserStatistics(domain, user, includeFederation);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueueStatisticsApi.getUserStatistics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiQueueStatisticsApi();
$domain = domain_example; // String | The domain of the user queue statistics shall be fetched for
$user = user_example; // String | The username of the user queue statistics shall be fetched for
$includeFederation = true; // Boolean | If queue statistics from federated organizations shall be included (default false)

try {
    $result = $api_instance->getUserStatistics($domain, $user, $includeFederation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueueStatisticsApi->getUserStatistics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueueStatisticsApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QueueStatisticsApi->new();
my $domain = domain_example; # String | The domain of the user queue statistics shall be fetched for
my $user = user_example; # String | The username of the user queue statistics shall be fetched for
my $includeFederation = true; # Boolean | If queue statistics from federated organizations shall be included (default false)

eval { 
    my $result = $api_instance->getUserStatistics(domain => $domain, user => $user, includeFederation => $includeFederation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueueStatisticsApi->getUserStatistics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QueueStatisticsApi()
domain = domain_example # String | The domain of the user queue statistics shall be fetched for
user = user_example # String | The username of the user queue statistics shall be fetched for
includeFederation = true # Boolean | If queue statistics from federated organizations shall be included (default false) (optional)

try: 
    # Get user queue statistics
    api_response = api_instance.get_user_statistics(domain, user, includeFederation=includeFederation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueueStatisticsApi->getUserStatistics: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user queue statistics shall be fetched for
Required
user*
String
The username of the user queue statistics shall be fetched for
Required
Query parameters
Name Description
includeFederation
Boolean
If queue statistics from federated organizations shall be included (default false)

Responses

Status: 200 - OK

{"queue":[{"name":"ACD_Tax","domain":"test.com","number":"+123415","id":67899,"queueLength":3,"availableAgents":2,"loggedInAgents":5,"longestWaiting":20,"lastWait":15,"averageWait":14,"droppedCallsForPeriod":6,"totalCallsForPeriod":60,"answeredCallsForPeriod":41,"totalCallsLast24h":50,"droppedCallsLast24h":4,"answeredCallsLast24h":38,"current-agent-presence":[{"name":"Available","count":1}]}]}

Status: 404 - Not Found


getUserStatisticsDeprecated

Get user queue statistics

Retrieve queue statistics based on a specific supervisor who is authorized to supervise specific groups.<br><br><i>NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.</i>


/queue/statistics/{domain}/{user}

Usage and SDK Samples

curl -X GET\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//queue/statistics/{domain}/{user}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QueueStatisticsApi;

import java.io.File;
import java.util.*;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain queue statistics shall be fetched for
        String user = user_example; // String | The username of the user accessing the API
        try {
            QueueStatsDTO result = apiInstance.getUserStatisticsDeprecated(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getUserStatisticsDeprecated");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QueueStatisticsApi;

public class QueueStatisticsApiExample {

    public static void main(String[] args) {
        QueueStatisticsApi apiInstance = new QueueStatisticsApi();
        String domain = domain_example; // String | The domain queue statistics shall be fetched for
        String user = user_example; // String | The username of the user accessing the API
        try {
            QueueStatsDTO result = apiInstance.getUserStatisticsDeprecated(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QueueStatisticsApi#getUserStatisticsDeprecated");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain queue statistics shall be fetched for
String *user = user_example; // The username of the user accessing the API

QueueStatisticsApi *apiInstance = [[QueueStatisticsApi alloc] init];

// Get user queue statistics
[apiInstance getUserStatisticsDeprecatedWith:domain
    user:user
              completionHandler: ^(QueueStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.QueueStatisticsApi()
var domain = domain_example; // {{String}} The domain queue statistics shall be fetched for
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserStatisticsDeprecated(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserStatisticsDeprecatedExample
    {
        public void main()
        {

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new QueueStatisticsApi();
            var domain = domain_example;  // String | The domain queue statistics shall be fetched for
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // Get user queue statistics
                QueueStatsDTO result = apiInstance.getUserStatisticsDeprecated(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QueueStatisticsApi.getUserStatisticsDeprecated: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiQueueStatisticsApi();
$domain = domain_example; // String | The domain queue statistics shall be fetched for
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getUserStatisticsDeprecated($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QueueStatisticsApi->getUserStatisticsDeprecated: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QueueStatisticsApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::QueueStatisticsApi->new();
my $domain = domain_example; # String | The domain queue statistics shall be fetched for
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getUserStatisticsDeprecated(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QueueStatisticsApi->getUserStatisticsDeprecated: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.QueueStatisticsApi()
domain = domain_example # String | The domain queue statistics shall be fetched for
user = user_example # String | The username of the user accessing the API

try: 
    # Get user queue statistics
    api_response = api_instance.get_user_statistics_deprecated(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QueueStatisticsApi->getUserStatisticsDeprecated: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain queue statistics shall be fetched for
Required
user*
String
The username of the user accessing the API
Required
Query parameters
Name Description

Responses

Status: 200 - OK

{"queue":[{"name":"ACD_Tax","domain":"test.com","number":"+123415","id":67899,"queueLength":3,"availableAgents":2,"loggedInAgents":5,"longestWaiting":20,"lastWait":15,"averageWait":14,"droppedCallsForPeriod":6,"totalCallsForPeriod":60,"answeredCallsForPeriod":41,"totalCallsLast24h":50,"droppedCallsLast24h":4,"answeredCallsLast24h":38,"current-agent-presence":[{"name":"Available","count":1}]}]}
{"queue":[{"name":"ACD_Tax","domain":"test.com","number":"+123415","id":67899,"queueLength":3,"availableAgents":2,"loggedInAgents":5,"longestWaiting":20,"lastWait":15,"averageWait":14,"droppedCallsForPeriod":6,"totalCallsForPeriod":60,"answeredCallsForPeriod":41,"totalCallsLast24h":50,"droppedCallsLast24h":4,"answeredCallsLast24h":38,"current-agent-presence":[{"name":"Available","count":1}]}]}

Status: 404 - Not Found


Tickets

createTicket

Create ticket

There are two authentication approaches for this method. One approach is to use Password based ticket and the other one is to use Superuser Ticket.<br>For details on how to calculate the ticket string for the password based ticket, please see Using the API within the API reference.


/tickets/{domain}/{user}

Usage and SDK Samples

curl -X POST\
\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//tickets/{domain}/{user}?api=&platform=&ver=&number=&name=&expires=&deviceDisplayName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketsApi;

import java.io.File;
import java.util.*;

public class TicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        TicketsApi apiInstance = new TicketsApi();
        String domain = domain_example; // String | The domain of the user to create an API ticket for
        String user = user_example; // String | The username of the user to create an API ticket for
        array[String] api = ; // array[String] | One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings String platform = platform_example; // String | Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other String ver = ver_example; // String | The version of the platform. Not required when the value of the platform is other String number = number_example; // String | The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. String name = name_example; // String | A user defined name of the ticket Integer expires = 56; // Integer | Expiration time of the ticket in seconds String deviceDisplayName = deviceDisplayName_example; // String | A user defined name of the device try { UserApiTicketDTO result = apiInstance.createTicket(domain, user, api, platform, ver, number, name, expires, deviceDisplayName); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TicketsApi#createTicket"); e.printStackTrace(); } } }
import io.swagger.client.api.TicketsApi;

public class TicketsApiExample {

    public static void main(String[] args) {
        TicketsApi apiInstance = new TicketsApi();
        String domain = domain_example; // String | The domain of the user to create an API ticket for
        String user = user_example; // String | The username of the user to create an API ticket for
        array[String] api = ; // array[String] | One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings String platform = platform_example; // String | Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other String ver = ver_example; // String | The version of the platform. Not required when the value of the platform is other String number = number_example; // String | The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. String name = name_example; // String | A user defined name of the ticket Integer expires = 56; // Integer | Expiration time of the ticket in seconds String deviceDisplayName = deviceDisplayName_example; // String | A user defined name of the device try { UserApiTicketDTO result = apiInstance.createTicket(domain, user, api, platform, ver, number, name, expires, deviceDisplayName); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TicketsApi#createTicket"); e.printStackTrace(); } } }
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the user to create an API ticket for
String *user = user_example; // The username of the user to create an API ticket for
array[String] *api = ; // One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings String *platform = platform_example; // Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other String *ver = ver_example; // The version of the platform. Not required when the value of the platform is other (optional) String *number = number_example; // The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. (optional) String *name = name_example; // A user defined name of the ticket (optional) Integer *expires = 56; // Expiration time of the ticket in seconds (optional) String *deviceDisplayName = deviceDisplayName_example; // A user defined name of the device (optional) TicketsApi *apiInstance = [[TicketsApi alloc] init]; // Create ticket [apiInstance createTicketWith:domain user:user api:api platform:platform ver:ver number:number name:name expires:expires deviceDisplayName:deviceDisplayName completionHandler: ^(UserApiTicketDTO output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error: %@", error); } }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.TicketsApi()
var domain = domain_example; // {{String}} The domain of the user to create an API ticket for
var user = user_example; // {{String}} The username of the user to create an API ticket for
var api = ; // {{array[String]}} One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings var platform = platform_example; // {{String}} Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other var opts = { 'ver': ver_example, // {{String}} The version of the platform. Not required when the value of the platform is other 'number': number_example, // {{String}} The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. 'name': name_example, // {{String}} A user defined name of the ticket 'expires': 56, // {{Integer}} Expiration time of the ticket in seconds 'deviceDisplayName': deviceDisplayName_example // {{String}} A user defined name of the device }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.createTicket(domain, user, api, platform, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTicketExample
    {
        public void main()
        {

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new TicketsApi();
            var domain = domain_example;  // String | The domain of the user to create an API ticket for
            var user = user_example;  // String | The username of the user to create an API ticket for
            var api = new array[String](); // array[String] | One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings var platform = platform_example; // String | Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other var ver = ver_example; // String | The version of the platform. Not required when the value of the platform is other (optional) var number = number_example; // String | The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. (optional) var name = name_example; // String | A user defined name of the ticket (optional) var expires = 56; // Integer | Expiration time of the ticket in seconds (optional) var deviceDisplayName = deviceDisplayName_example; // String | A user defined name of the device (optional) try { // Create ticket UserApiTicketDTO result = apiInstance.createTicket(domain, user, api, platform, ver, number, name, expires, deviceDisplayName); Debug.WriteLine(result); } catch (Exception e) { Debug.Print("Exception when calling TicketsApi.createTicket: " + e.Message ); } } } }
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketsApi();
$domain = domain_example; // String | The domain of the user to create an API ticket for
$user = user_example; // String | The username of the user to create an API ticket for
$api = ; // array[String] | One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings $platform = platform_example; // String | Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other $ver = ver_example; // String | The version of the platform. Not required when the value of the platform is other $number = number_example; // String | The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. $name = name_example; // String | A user defined name of the ticket $expires = 56; // Integer | Expiration time of the ticket in seconds $deviceDisplayName = deviceDisplayName_example; // String | A user defined name of the device try { $result = $api_instance->createTicket($domain, $user, $api, $platform, $ver, $number, $name, $expires, $deviceDisplayName); print_r($result); } catch (Exception $e) { echo 'Exception when calling TicketsApi->createTicket: ', $e->getMessage(), PHP_EOL; } ?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketsApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketsApi->new();
my $domain = domain_example; # String | The domain of the user to create an API ticket for
my $user = user_example; # String | The username of the user to create an API ticket for
my $api = []; # array[String] | One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings my $platform = platform_example; # String | Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other my $ver = ver_example; # String | The version of the platform. Not required when the value of the platform is other my $number = number_example; # String | The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. my $name = name_example; # String | A user defined name of the ticket my $expires = 56; # Integer | Expiration time of the ticket in seconds my $deviceDisplayName = deviceDisplayName_example; # String | A user defined name of the device eval { my $result = $api_instance->createTicket(domain => $domain, user => $user, api => $api, platform => $platform, ver => $ver, number => $number, name => $name, expires => $expires, deviceDisplayName => $deviceDisplayName); print Dumper($result); }; if ($@) { warn "Exception when calling TicketsApi->createTicket: $@\n"; }
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketsApi()
domain = domain_example # String | The domain of the user to create an API ticket for
user = user_example # String | The username of the user to create an API ticket for
api =  # array[String] | One or more valid external APIs (e.g. ?api=CALLS&api=USER).

The following APIs are available:
CALL_CONTROL - Call control
CALL_RECORDING - Call recording
CALLS - Call setup
CDR_READER - Reports
COMMUNICATION_LOG - Communication Log
CONTACT - Contact search
DISTRIBUTION_GROUP - ACD/attendant queues
EVENTCHANNEL - Event channel
LINE_STATE - Line state
PERSONAL_CONTACTS - Personal contacts
QUEUE_STATS - Queue statistics
SMS - SMS sending
USER - User info
VOICEMAIL_SETTINGS - Voicemail Settings platform = platform_example # String | Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other ver = ver_example # String | The version of the platform. Not required when the value of the platform is other (optional) number = number_example # String | The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. (optional) name = name_example # String | A user defined name of the ticket (optional) expires = 56 # Integer | Expiration time of the ticket in seconds (optional) deviceDisplayName = deviceDisplayName_example # String | A user defined name of the device (optional) try: # Create ticket api_response = api_instance.create_ticket(domain, user, api, platform, ver=ver, number=number, name=name, expires=expires, deviceDisplayName=deviceDisplayName) pprint(api_response) except ApiException as e: print("Exception when calling TicketsApi->createTicket: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user to create an API ticket for
Required
user*
String
The username of the user to create an API ticket for
Required
Query parameters
Name Description
api*
array[String]
One or more valid external APIs (e.g. ?api=CALLS&api=USER).<br/><br/>The following APIs are available:<br/><b>CALL_CONTROL</b> - Call control<br/><b>CALL_RECORDING</b> - Call recording<br/><b>CALLS</b> - Call setup<br/><b>CDR_READER</b> - Reports<br/><b>COMMUNICATION_LOG</b> - Communication Log<br/><b>CONTACT</b> - Contact search<br/><b>DISTRIBUTION_GROUP</b> - ACD/attendant queues <br/><b>EVENTCHANNEL</b> - Event channel<br/><b>LINE_STATE</b> - Line state<br/><b>PERSONAL_CONTACTS</b> - Personal contacts<br/><b>QUEUE_STATS</b> - Queue statistics<br/><b>SMS</b> - SMS sending<br/><b>USER</b> - User info<br/><b>VOICEMAIL_SETTINGS</b> - Voicemail Settings
Required
platform*
String
Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other
Required
ver
String
The version of the platform. Not required when the value of the platform is other
number
String
The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user.
name
String
A user defined name of the ticket
expires
Integer (int32)
Expiration time of the ticket in seconds
deviceDisplayName
String
A user defined name of the device

Responses

Status: 200 - User ticket created

{"expires":"2023-04-10T13:38:39.482+00:00","name":"ALL_CALLS","token":"2343.ZSDjndiJSDjksHj","baseUrl":"https://www.example.com","allowedApis":["CALLS"]}
{"expires":"2023-04-10T11:28:14.237+00:00","name":"phone_alice_uwbt","token":"1234.AbCdEf0123aHfgTDhjkGR","secret":"96181cd2034a873f","baseUrl":"https://www.example.com","allowedApis":["CONTACT"]}

Status: 400 - Bad Request

Status: 404 - Not Found


deleteUserApiTicket

Delete ticket

If the ticket is deleted or revoked, it returns API ticket deleted successfully. The method is accessible through Password based ticket and Superuser Ticket.


/tickets/{domain}/{user}/{ticketName}

Usage and SDK Samples

curl -X DELETE\
\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//tickets/{domain}/{user}/{ticketName}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketsApi;

import java.io.File;
import java.util.*;

public class TicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Admin
        ApiKeyAuth Admin = (ApiKeyAuth) defaultClient.getAuthentication("Admin");
        Admin.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Admin.setApiKeyPrefix("Token");


        TicketsApi apiInstance = new TicketsApi();
        String domain = domain_example; // String | The domain of the user of the API ticket to delete
        String user = user_example; // String | The username of the user of the API ticket to delete
        String ticketName = ticketName_example; // String | The user defined name of the ticket to delete
        try {
            apiInstance.deleteUserApiTicket(domain, user, ticketName);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#deleteUserApiTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketsApi;

public class TicketsApiExample {

    public static void main(String[] args) {
        TicketsApi apiInstance = new TicketsApi();
        String domain = domain_example; // String | The domain of the user of the API ticket to delete
        String user = user_example; // String | The username of the user of the API ticket to delete
        String ticketName = ticketName_example; // String | The user defined name of the ticket to delete
        try {
            apiInstance.deleteUserApiTicket(domain, user, ticketName);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#deleteUserApiTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: Admin)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the user of the API ticket to delete
String *user = user_example; // The username of the user of the API ticket to delete
String *ticketName = ticketName_example; // The user defined name of the ticket to delete

TicketsApi *apiInstance = [[TicketsApi alloc] init];

// Delete ticket
[apiInstance deleteUserApiTicketWith:domain
    user:user
    ticketName:ticketName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;

// Configure API key authorization: Admin
var Admin = defaultClient.authentications['Admin'];
Admin.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Admin.apiKeyPrefix['t'] = "Token"


var api = new TelepoApi.TicketsApi()
var domain = domain_example; // {{String}} The domain of the user of the API ticket to delete
var user = user_example; // {{String}} The username of the user of the API ticket to delete
var ticketName = ticketName_example; // {{String}} The user defined name of the ticket to delete

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUserApiTicket(domain, user, ticketName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteUserApiTicketExample
    {
        public void main()
        {

            // Configure API key authorization: Admin
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new TicketsApi();
            var domain = domain_example;  // String | The domain of the user of the API ticket to delete
            var user = user_example;  // String | The username of the user of the API ticket to delete
            var ticketName = ticketName_example;  // String | The user defined name of the ticket to delete

            try
            {
                // Delete ticket
                apiInstance.deleteUserApiTicket(domain, user, ticketName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketsApi.deleteUserApiTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Admin
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketsApi();
$domain = domain_example; // String | The domain of the user of the API ticket to delete
$user = user_example; // String | The username of the user of the API ticket to delete
$ticketName = ticketName_example; // String | The user defined name of the ticket to delete

try {
    $api_instance->deleteUserApiTicket($domain, $user, $ticketName);
} catch (Exception $e) {
    echo 'Exception when calling TicketsApi->deleteUserApiTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketsApi;

# Configure API key authorization: Admin
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketsApi->new();
my $domain = domain_example; # String | The domain of the user of the API ticket to delete
my $user = user_example; # String | The username of the user of the API ticket to delete
my $ticketName = ticketName_example; # String | The user defined name of the ticket to delete

eval { 
    $api_instance->deleteUserApiTicket(domain => $domain, user => $user, ticketName => $ticketName);
};
if ($@) {
    warn "Exception when calling TicketsApi->deleteUserApiTicket: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Admin
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketsApi()
domain = domain_example # String | The domain of the user of the API ticket to delete
user = user_example # String | The username of the user of the API ticket to delete
ticketName = ticketName_example # String | The user defined name of the ticket to delete

try: 
    # Delete ticket
    api_instance.delete_user_api_ticket(domain, user, ticketName)
except ApiException as e:
    print("Exception when calling TicketsApi->deleteUserApiTicket: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user of the API ticket to delete
Required
user*
String
The username of the user of the API ticket to delete
Required
ticketName*
String
The user defined name of the ticket to delete
Required
Query parameters
Name Description

Responses

Status: 200 - API ticket deleted successfully

Status: 400 - Bad Request

Status: 404 - API ticket does not exist


UserConfigurationSettings

getAnswerplaces

Get answer places

Retrieve mapping for the possible devices the user can set up calls from.


/config/user/{domain}/{user}/answerplaces

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//config/user/{domain}/{user}/answerplaces"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            AnswerplacesDTO result = apiInstance.getAnswerplaces(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getAnswerplaces");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            AnswerplacesDTO result = apiInstance.getAnswerplaces(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getAnswerplaces");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// Get answer places
[apiInstance getAnswerplacesWith:domain
    user:user
              completionHandler: ^(AnswerplacesDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnswerplaces(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnswerplacesExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // Get answer places
                AnswerplacesDTO result = apiInstance.getAnswerplaces(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getAnswerplaces: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getAnswerplaces($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getAnswerplaces: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getAnswerplaces(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getAnswerplaces: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # Get answer places
    api_response = api_instance.get_answerplaces(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getAnswerplaces: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

{"answerplace":[{"id":"desktop","name":"SIP desktop phone"}]}
{"answerplace":[{"id":"mobile","name":"Mobile"}]}
{"answerplace":[{"id":"soft","name":"Softphone"}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


getLegalStatementUrl

Get legal statement URL

Retrieve a legal statement URL


/config/organisation/{domain}/legal

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//config/organisation/{domain}/legal"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            'String' result = apiInstance.getLegalStatementUrl(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getLegalStatementUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            'String' result = apiInstance.getLegalStatementUrl(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getLegalStatementUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// Get legal statement URL
[apiInstance getLegalStatementUrlWith:domain
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLegalStatementUrl(domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLegalStatementUrlExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Get legal statement URL
                'String' result = apiInstance.getLegalStatementUrl(domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getLegalStatementUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $result = $api_instance->getLegalStatementUrl($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getLegalStatementUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    my $result = $api_instance->getLegalStatementUrl(domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getLegalStatementUrl: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Get legal statement URL
    api_response = api_instance.get_legal_statement_url(domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getLegalStatementUrl: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

https://www.test.se/sv-se/legalt
https://www.test.se/sv-se/legalt

Status: 400 - Bad Request

Status: 404 - Not Found


getPrivacyPolicyUrl

Get privacy policy URL

Retrieve a privacy policy URL.


/config/organisation/{domain}/privacy

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//config/organisation/{domain}/privacy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            'String' result = apiInstance.getPrivacyPolicyUrl(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getPrivacyPolicyUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        try {
            'String' result = apiInstance.getPrivacyPolicyUrl(domain);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getPrivacyPolicyUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// Get privacy policy URL
[apiInstance getPrivacyPolicyUrlWith:domain
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPrivacyPolicyUrl(domain, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPrivacyPolicyUrlExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API

            try
            {
                // Get privacy policy URL
                'String' result = apiInstance.getPrivacyPolicyUrl(domain);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getPrivacyPolicyUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API

try {
    $result = $api_instance->getPrivacyPolicyUrl($domain);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getPrivacyPolicyUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API

eval { 
    my $result = $api_instance->getPrivacyPolicyUrl(domain => $domain);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getPrivacyPolicyUrl: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API

try: 
    # Get privacy policy URL
    api_response = api_instance.get_privacy_policy_url(domain)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getPrivacyPolicyUrl: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required

Responses

Status: 200 - OK

https://www.test.se/sv-se/legalt/policies/privacy-policy
https://www.test.se/sv-se/legalt/policies/privacy-policy

Status: 400 - Bad Request

Status: 404 - Not Found


getRoles

List presence roles

Retrieve the localized strings for presence roles. Roles may also be used to define different work situations.


/config/user/{domain}/{user}/presence/role

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//config/user/{domain}/{user}/presence/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            RolesDTO result = apiInstance.getRoles(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            RolesDTO result = apiInstance.getRoles(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getRoles");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// List presence roles
[apiInstance getRolesWith:domain
    user:user
              completionHandler: ^(RolesDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRoles(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRolesExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // List presence roles
                RolesDTO result = apiInstance.getRoles(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getRoles($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getRoles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getRoles(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getRoles: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # List presence roles
    api_response = api_instance.get_roles(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getRoles: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

{"role":[{"id":"1400593658949","name":"Support","stateName":"Support"}]}
{"role":[{"id":"Private","name":"Private","stateName":"Private"}]}
{"role":[{"id":"Business","name":"Business","stateName":"Business"}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


getSelfProfileUrl

Get self profile URL

Retrieve a one-time self profile URL.


/config/v1/user/userprofile/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//config/v1/user/userprofile/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            'String' result = apiInstance.getSelfProfileUrl(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getSelfProfileUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            'String' result = apiInstance.getSelfProfileUrl(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getSelfProfileUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// Get self profile URL
[apiInstance getSelfProfileUrlWith:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSelfProfileUrl(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSelfProfileUrlExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // Get self profile URL
                'String' result = apiInstance.getSelfProfileUrl(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getSelfProfileUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getSelfProfileUrl($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getSelfProfileUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getSelfProfileUrl(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getSelfProfileUrl: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # Get self profile URL
    api_response = api_instance.get_self_profile_url(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getSelfProfileUrl: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

http://192.168.1.215/admin/userprofile?t=7.VDo0NzE0ZDE5ZjBmZWI1OWEz

Status: 403 - Not Authorized

Status: 404 - Not Found


getSelfProvisioningUrl

Get self provisioning URL

Retrieve a one-time self provisioning URL.


/config/v1/user/selfprovisioning/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//config/v1/user/selfprovisioning/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            'String' result = apiInstance.getSelfProvisioningUrl(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getSelfProvisioningUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            'String' result = apiInstance.getSelfProvisioningUrl(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getSelfProvisioningUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// Get self provisioning URL
[apiInstance getSelfProvisioningUrlWith:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSelfProvisioningUrl(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSelfProvisioningUrlExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // Get self provisioning URL
                'String' result = apiInstance.getSelfProvisioningUrl(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getSelfProvisioningUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getSelfProvisioningUrl($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getSelfProvisioningUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getSelfProvisioningUrl(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getSelfProvisioningUrl: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # Get self provisioning URL
    api_response = api_instance.get_self_provisioning_url(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getSelfProvisioningUrl: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

http://192.168.1.215/admin/directlogin?t=7.VDo3MWM4MzRmNzQ1ZjU2ODkx

Status: 403 - Not Authorized

Status: 404 - Not Found


getTranslatedActivities

List presence activites

Retrieve the localized strings for presence activities.


/config/user/{domain}/{user}/presence/activity

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//config/user/{domain}/{user}/presence/activity"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            ActivitiesDTO result = apiInstance.getTranslatedActivities(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getTranslatedActivities");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            ActivitiesDTO result = apiInstance.getTranslatedActivities(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getTranslatedActivities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// List presence activites
[apiInstance getTranslatedActivitiesWith:domain
    user:user
              completionHandler: ^(ActivitiesDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTranslatedActivities(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTranslatedActivitiesExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // List presence activites
                ActivitiesDTO result = apiInstance.getTranslatedActivities(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getTranslatedActivities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getTranslatedActivities($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getTranslatedActivities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getTranslatedActivities(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getTranslatedActivities: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # List presence activites
    api_response = api_instance.get_translated_activities(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getTranslatedActivities: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

{"activity":[{"id":"meeting","name":"Meeting","available":true,"stateName":"Meeting"}]}
{"activity":[{"id":"available","name":"Available","available":true,"stateName":"Available"}]}
{"activity":[{"id":"lunch","name":"Lunch","available":true,"stateName":"Lunch"}]}

Status: 403 - Not Authorized

Status: 404 - Not Found


getUserConfig

List settings

Retrieve an aggregated document of all the configuration settings.


/config/user/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//config/user/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            UserConfigDTO result = apiInstance.getUserConfig(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getUserConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            UserConfigDTO result = apiInstance.getUserConfig(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#getUserConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// List settings
[apiInstance getUserConfigWith:domain
    user:user
              completionHandler: ^(UserConfigDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserConfig(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserConfigExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // List settings
                UserConfigDTO result = apiInstance.getUserConfig(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.getUserConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $result = $api_instance->getUserConfig($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->getUserConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    my $result = $api_instance->getUserConfig(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->getUserConfig: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # List settings
    api_response = api_instance.get_user_config(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->getUserConfig: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - OK

{"activities":{"activity":[{"id":"available","name":"Available","available":true,"stateName":"Available"}]},"roles":{"role":[{"id":"Business","name":"Business","stateName":"Business"}]},"answerplaces":{"answerplace":[{"id":"mobile","name":"Mobile"}]},"topics-enabled":true,"sms-allowed":true,"fallbackToDefaultPresenceState":false,"defaultPresenceState":"Available","callrouting-enabled":true,"fields":{"field":[{"id":"field7","label":"Department","currentValue":"Field7","requestedValue":"Field7","editable":true,"dateRequested":"2020-10-10T13:12:12Z"}]}}
{"activities":{"activity":[{"id":"available","name":"Available","available":true,"stateName":"Available"}]},"roles":{"role":[{"id":"Business","name":"Business","stateName":"Business"}]},"answerplaces":{"answerplace":[{"id":"mobile","name":"Mobile"}]},"topics-enabled":true,"sms-allowed":true,"fallbackToDefaultPresenceState":false,"defaultPresenceState":"Available","callrouting-enabled":true,"fields":{"field":[{"id":"field7","label":"Department","currentValue":"Field7","requestedValue":"Field7","editable":true,"dateRequested":"2020-10-10T13:12:12Z"}]}}

Status: 403 - Not Authorized

Status: 404 - Not Found


subscribeForAppConfigData

Subscribe on configuration data

The method will produce an SSE stream of application configuration data in application/app-config-data format.


/config/v1/user/{domain}/{user}/app-config

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: text/event-stream"\
"/api//config/v1/user/{domain}/{user}/app-config"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserConfigurationSettingsApi;

import java.io.File;
import java.util.*;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            apiInstance.subscribeForAppConfigData(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#subscribeForAppConfigData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserConfigurationSettingsApi;

public class UserConfigurationSettingsApiExample {

    public static void main(String[] args) {
        UserConfigurationSettingsApi apiInstance = new UserConfigurationSettingsApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The username of the user accessing the API
        try {
            apiInstance.subscribeForAppConfigData(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserConfigurationSettingsApi#subscribeForAppConfigData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The username of the user accessing the API

UserConfigurationSettingsApi *apiInstance = [[UserConfigurationSettingsApi alloc] init];

// Subscribe on configuration data
[apiInstance subscribeForAppConfigDataWith:domain
    user:user
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserConfigurationSettingsApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The username of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeForAppConfigData(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subscribeForAppConfigDataExample
    {
        public void main()
        {


            var apiInstance = new UserConfigurationSettingsApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The username of the user accessing the API

            try
            {
                // Subscribe on configuration data
                apiInstance.subscribeForAppConfigData(domain, user);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserConfigurationSettingsApi.subscribeForAppConfigData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserConfigurationSettingsApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The username of the user accessing the API

try {
    $api_instance->subscribeForAppConfigData($domain, $user);
} catch (Exception $e) {
    echo 'Exception when calling UserConfigurationSettingsApi->subscribeForAppConfigData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserConfigurationSettingsApi;


my $api_instance = WWW::SwaggerClient::UserConfigurationSettingsApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The username of the user accessing the API

eval { 
    $api_instance->subscribeForAppConfigData(domain => $domain, user => $user);
};
if ($@) {
    warn "Exception when calling UserConfigurationSettingsApi->subscribeForAppConfigData: $@\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.UserConfigurationSettingsApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The username of the user accessing the API

try: 
    # Subscribe on configuration data
    api_instance.subscribe_for_app_config_data(domain, user)
except ApiException as e:
    print("Exception when calling UserConfigurationSettingsApi->subscribeForAppConfigData: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The username of the user accessing the API
Required

Responses

Status: 200 - A document stream in 'application/app-config-data' format

Status: 403 - Not Authorized

Status: 404 - Not Found


UserDeviceInformation

deleteDeviceInfoWebHook

Unregister device updates webhook

Unregister an existing webhook registered for the user.


/device/info/v1/monitor/{domain}/{userId}/{targetId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//device/info/v1/monitor/{domain}/{userId}/{targetId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String targetId = targetId_example; // String | The unique id of the webhook that should be unregistered
        try {
            apiInstance.deleteDeviceInfoWebHook(domain, userId, targetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#deleteDeviceInfoWebHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        String targetId = targetId_example; // String | The unique id of the webhook that should be unregistered
        try {
            apiInstance.deleteDeviceInfoWebHook(domain, userId, targetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#deleteDeviceInfoWebHook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
String *targetId = targetId_example; // The unique id of the webhook that should be unregistered

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Unregister device updates webhook
[apiInstance deleteDeviceInfoWebHookWith:domain
    userId:userId
    targetId:targetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var targetId = targetId_example; // {{String}} The unique id of the webhook that should be unregistered

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDeviceInfoWebHook(domain, userId, targetId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteDeviceInfoWebHookExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var targetId = targetId_example;  // String | The unique id of the webhook that should be unregistered

            try
            {
                // Unregister device updates webhook
                apiInstance.deleteDeviceInfoWebHook(domain, userId, targetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.deleteDeviceInfoWebHook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$targetId = targetId_example; // String | The unique id of the webhook that should be unregistered

try {
    $api_instance->deleteDeviceInfoWebHook($domain, $userId, $targetId);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->deleteDeviceInfoWebHook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $targetId = targetId_example; # String | The unique id of the webhook that should be unregistered

eval { 
    $api_instance->deleteDeviceInfoWebHook(domain => $domain, userId => $userId, targetId => $targetId);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->deleteDeviceInfoWebHook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
targetId = targetId_example # String | The unique id of the webhook that should be unregistered

try: 
    # Unregister device updates webhook
    api_instance.delete_device_info_web_hook(domain, userId, targetId)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->deleteDeviceInfoWebHook: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
targetId*
String
The unique id of the webhook that should be unregistered
Required
Query parameters
Name Description

Responses

Status: 200 - OK


getUserDeviceDetails

Get user device

Retrieve detailed information about a certain user device. The returned document contains a list of attributes providing detailed information about the user's device.


/device/info/v1/details/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"/api//device/info/v1/details/{domain}/{userId}/{deviceId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        try {
            array[UserDeviceAttributeDTO] result = apiInstance.getUserDeviceDetails(domain, userId, deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        try {
            array[UserDeviceAttributeDTO] result = apiInstance.getUserDeviceDetails(domain, userId, deviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *deviceId = deviceId_example; // The device ID

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Get user device
[apiInstance getUserDeviceDetailsWith:domain
    userId:userId
    deviceId:deviceId
              completionHandler: ^(array[UserDeviceAttributeDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var deviceId = deviceId_example; // {{String}} The device ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDeviceDetails(domain, userId, deviceId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserDeviceDetailsExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var deviceId = deviceId_example;  // String | The device ID

            try
            {
                // Get user device
                array[UserDeviceAttributeDTO] result = apiInstance.getUserDeviceDetails(domain, userId, deviceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.getUserDeviceDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$deviceId = deviceId_example; // String | The device ID

try {
    $result = $api_instance->getUserDeviceDetails($domain, $userId, $deviceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->getUserDeviceDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $deviceId = deviceId_example; # String | The device ID

eval { 
    my $result = $api_instance->getUserDeviceDetails(domain => $domain, userId => $userId, deviceId => $deviceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->getUserDeviceDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
deviceId = deviceId_example # String | The device ID

try: 
    # Get user device
    api_response = api_instance.get_user_device_details(domain, userId, deviceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->getUserDeviceDetails: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
deviceId*
String
The device ID
Required
Query parameters
Name Description

Responses

Status: 200 - OK

[{"name":"USER_AGENT","value":"Telepo Softphone/Mac/5.x.x.xxxx"}]

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization, user or device does not exist


getUserDeviceIcon

Get user device icon name

Retrieve display icon name for a certain user device. If no icon has been configured for the device, the default icon of the type of the device is returned.


/device/info/v1/icon/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json,text/plain"\
"/api//device/info/v1/icon/{domain}/{userId}/{deviceId}?fallback="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        Boolean fallback = true; // Boolean | If true, the default icon name will be returned if no name is configured
        try {
            'String' result = apiInstance.getUserDeviceIcon(domain, userId, deviceId, fallback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceIcon");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        Boolean fallback = true; // Boolean | If true, the default icon name will be returned if no name is configured
        try {
            'String' result = apiInstance.getUserDeviceIcon(domain, userId, deviceId, fallback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceIcon");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *deviceId = deviceId_example; // The device ID
Boolean *fallback = true; // If true, the default icon name will be returned if no name is configured (optional)

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Get user device icon name
[apiInstance getUserDeviceIconWith:domain
    userId:userId
    deviceId:deviceId
    fallback:fallback
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var deviceId = deviceId_example; // {{String}} The device ID
var opts = { 
  'fallback': true // {{Boolean}} If true, the default icon name will be returned if no name is configured
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDeviceIcon(domain, userId, deviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserDeviceIconExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var deviceId = deviceId_example;  // String | The device ID
            var fallback = true;  // Boolean | If true, the default icon name will be returned if no name is configured (optional) 

            try
            {
                // Get user device icon name
                'String' result = apiInstance.getUserDeviceIcon(domain, userId, deviceId, fallback);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.getUserDeviceIcon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$deviceId = deviceId_example; // String | The device ID
$fallback = true; // Boolean | If true, the default icon name will be returned if no name is configured

try {
    $result = $api_instance->getUserDeviceIcon($domain, $userId, $deviceId, $fallback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->getUserDeviceIcon: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $deviceId = deviceId_example; # String | The device ID
my $fallback = true; # Boolean | If true, the default icon name will be returned if no name is configured

eval { 
    my $result = $api_instance->getUserDeviceIcon(domain => $domain, userId => $userId, deviceId => $deviceId, fallback => $fallback);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->getUserDeviceIcon: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
deviceId = deviceId_example # String | The device ID
fallback = true # Boolean | If true, the default icon name will be returned if no name is configured (optional)

try: 
    # Get user device icon name
    api_response = api_instance.get_user_device_icon(domain, userId, deviceId, fallback=fallback)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->getUserDeviceIcon: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
deviceId*
String
The device ID
Required
Query parameters
Name Description
fallback
Boolean
If true, the default icon name will be returned if no name is configured

Responses

Status: 200 - Success. The returned string contains the name of the icon used for the device.

Status: 403 - Not Authorized

Status: 404 - Organization, user or device does not exist


getUserDeviceList

List all user devices

Retrieve a list with all the user's devices. The returned document contains a list with information on all the user's devices. If there are no devices, an empty document is returned.


/device/info/v1/list/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"/api//device/info/v1/list/{domain}/{userId}?type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String type = type_example; // String | The type of devices to fetch. If not stated, all device types are retrieved.
        try {
            array[UserDeviceListItemDTO] result = apiInstance.getUserDeviceList(domain, userId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String type = type_example; // String | The type of devices to fetch. If not stated, all device types are retrieved.
        try {
            array[UserDeviceListItemDTO] result = apiInstance.getUserDeviceList(domain, userId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *type = type_example; // The type of devices to fetch. If not stated, all device types are retrieved. (optional)

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// List all user devices
[apiInstance getUserDeviceListWith:domain
    userId:userId
    type:type
              completionHandler: ^(array[UserDeviceListItemDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var opts = { 
  'type': type_example // {{String}} The type of devices to fetch. If not stated, all device types are retrieved.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDeviceList(domain, userId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserDeviceListExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var type = type_example;  // String | The type of devices to fetch. If not stated, all device types are retrieved. (optional) 

            try
            {
                // List all user devices
                array[UserDeviceListItemDTO] result = apiInstance.getUserDeviceList(domain, userId, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.getUserDeviceList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$type = type_example; // String | The type of devices to fetch. If not stated, all device types are retrieved.

try {
    $result = $api_instance->getUserDeviceList($domain, $userId, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->getUserDeviceList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $type = type_example; # String | The type of devices to fetch. If not stated, all device types are retrieved.

eval { 
    my $result = $api_instance->getUserDeviceList(domain => $domain, userId => $userId, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->getUserDeviceList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
type = type_example # String | The type of devices to fetch. If not stated, all device types are retrieved. (optional)

try: 
    # List all user devices
    api_response = api_instance.get_user_device_list(domain, userId, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->getUserDeviceList: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
Query parameters
Name Description
type
String
The type of devices to fetch. If not stated, all device types are retrieved.

Responses

Status: 200 - OK

[{"deviceId":"kf45ffr3dd3dtj7r","deviceType":"SOFTPHONE","deviceName":"My work laptop","deviceIcon":"DEFAULT","deviceTypeName":"Application for Desktop","deviceStatus":"INACTIVE","revocable":true,"hasAttributes":true},{"deviceId":"dhhjhdsb008jnnh","deviceType":"MOBILE","deviceName":"My black iPhone XS","deviceIcon":"TYPE_2","deviceTypeName":"Mobile Application","deviceStatus":"ACTIVE","revocable":true,"hasAttributes":true}]

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist


getUserDeviceName

Get user device name

Retrieve display name of certain user device.


/device/info/v1/name/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json,text/plain"\
"/api//device/info/v1/name/{domain}/{userId}/{deviceId}?fallback="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        Boolean fallback = true; // Boolean | If true, the default name will be returned if no name is configured
        try {
            'String' result = apiInstance.getUserDeviceName(domain, userId, deviceId, fallback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        Boolean fallback = true; // Boolean | If true, the default name will be returned if no name is configured
        try {
            'String' result = apiInstance.getUserDeviceName(domain, userId, deviceId, fallback);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *deviceId = deviceId_example; // The device ID
Boolean *fallback = true; // If true, the default name will be returned if no name is configured (optional)

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Get user device name
[apiInstance getUserDeviceNameWith:domain
    userId:userId
    deviceId:deviceId
    fallback:fallback
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var deviceId = deviceId_example; // {{String}} The device ID
var opts = { 
  'fallback': true // {{Boolean}} If true, the default name will be returned if no name is configured
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDeviceName(domain, userId, deviceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserDeviceNameExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var deviceId = deviceId_example;  // String | The device ID
            var fallback = true;  // Boolean | If true, the default name will be returned if no name is configured (optional) 

            try
            {
                // Get user device name
                'String' result = apiInstance.getUserDeviceName(domain, userId, deviceId, fallback);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.getUserDeviceName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$deviceId = deviceId_example; // String | The device ID
$fallback = true; // Boolean | If true, the default name will be returned if no name is configured

try {
    $result = $api_instance->getUserDeviceName($domain, $userId, $deviceId, $fallback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->getUserDeviceName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $deviceId = deviceId_example; # String | The device ID
my $fallback = true; # Boolean | If true, the default name will be returned if no name is configured

eval { 
    my $result = $api_instance->getUserDeviceName(domain => $domain, userId => $userId, deviceId => $deviceId, fallback => $fallback);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->getUserDeviceName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
deviceId = deviceId_example # String | The device ID
fallback = true # Boolean | If true, the default name will be returned if no name is configured (optional)

try: 
    # Get user device name
    api_response = api_instance.get_user_device_name(domain, userId, deviceId, fallback=fallback)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->getUserDeviceName: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
deviceId*
String
The device ID
Required
Query parameters
Name Description
fallback
Boolean
If true, the default name will be returned if no name is configured

Responses

Status: 200 - Success. The returned string contains the name of the user's device.

Status: 403 - Not Authorized

Status: 404 - Organization, user or device does not exist


getUserDeviceShortlist

List active user devices

Retrieve a compact list with all the user's active devices. The returned document contains all the user's devices that are not known to be currently unreachable. If there are no active devices, an empty document is returned.


/device/info/v1/shortlist/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"/api//device/info/v1/shortlist/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        try {
            array[UserDeviceShortlistItemDTO] result = apiInstance.getUserDeviceShortlist(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceShortlist");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        try {
            array[UserDeviceShortlistItemDTO] result = apiInstance.getUserDeviceShortlist(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#getUserDeviceShortlist");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// List active user devices
[apiInstance getUserDeviceShortlistWith:domain
    userId:userId
              completionHandler: ^(array[UserDeviceShortlistItemDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserDeviceShortlist(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserDeviceShortlistExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID

            try
            {
                // List active user devices
                array[UserDeviceShortlistItemDTO] result = apiInstance.getUserDeviceShortlist(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.getUserDeviceShortlist: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID

try {
    $result = $api_instance->getUserDeviceShortlist($domain, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->getUserDeviceShortlist: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID

eval { 
    my $result = $api_instance->getUserDeviceShortlist(domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->getUserDeviceShortlist: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID

try: 
    # List active user devices
    api_response = api_instance.get_user_device_shortlist(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->getUserDeviceShortlist: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
Query parameters
Name Description

Responses

Status: 200 - OK

[{"deviceId":"dhhjhdsb008jnnh","deviceType":"MOBILE","deviceName":"My black iPhone XS","deviceIcon":"TYPE_2"}]

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist


registerDeviceInfoWebHook

Register device updates webhook

Register a webhook where notifications when there are any changes in the user's device set.


/device/info/v1/monitor/{domain}/{userId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api//device/info/v1/monitor/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        WebhookDTO body = ; // WebhookDTO | 
        try {
            ExpiresDTO result = apiInstance.registerDeviceInfoWebHook(domain, userId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#registerDeviceInfoWebHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The ID of the user
        WebhookDTO body = ; // WebhookDTO | 
        try {
            ExpiresDTO result = apiInstance.registerDeviceInfoWebHook(domain, userId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#registerDeviceInfoWebHook");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The ID of the user
WebhookDTO *body = ; //  (optional)

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Register device updates webhook
[apiInstance registerDeviceInfoWebHookWith:domain
    userId:userId
    body:body
              completionHandler: ^(ExpiresDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The ID of the user
var opts = { 
  'body':  // {{WebhookDTO}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerDeviceInfoWebHook(domainuserId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerDeviceInfoWebHookExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The ID of the user
            var body = new WebhookDTO(); // WebhookDTO |  (optional) 

            try
            {
                // Register device updates webhook
                ExpiresDTO result = apiInstance.registerDeviceInfoWebHook(domain, userId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.registerDeviceInfoWebHook: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The ID of the user
$body = ; // WebhookDTO | 

try {
    $result = $api_instance->registerDeviceInfoWebHook($domain, $userId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->registerDeviceInfoWebHook: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The ID of the user
my $body = WWW::SwaggerClient::Object::WebhookDTO->new(); # WebhookDTO | 

eval { 
    my $result = $api_instance->registerDeviceInfoWebHook(domain => $domain, userId => $userId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->registerDeviceInfoWebHook: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The ID of the user
body =  # WebhookDTO |  (optional)

try: 
    # Register device updates webhook
    api_response = api_instance.register_device_info_web_hook(domain, userId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->registerDeviceInfoWebHook: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The ID of the user
Required
Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 400 - Bad Request


revokeDevice

Revoke user device

Revoke the installation of a device.


/device/info/v1/revoke/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//device/info/v1/revoke/{domain}/{userId}/{deviceId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        try {
            apiInstance.revokeDevice(domain, userId, deviceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#revokeDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        try {
            apiInstance.revokeDevice(domain, userId, deviceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#revokeDevice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *deviceId = deviceId_example; // The device ID

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Revoke user device
[apiInstance revokeDeviceWith:domain
    userId:userId
    deviceId:deviceId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var deviceId = deviceId_example; // {{String}} The device ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.revokeDevice(domain, userId, deviceId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class revokeDeviceExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var deviceId = deviceId_example;  // String | The device ID

            try
            {
                // Revoke user device
                apiInstance.revokeDevice(domain, userId, deviceId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.revokeDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$deviceId = deviceId_example; // String | The device ID

try {
    $api_instance->revokeDevice($domain, $userId, $deviceId);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->revokeDevice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $deviceId = deviceId_example; # String | The device ID

eval { 
    $api_instance->revokeDevice(domain => $domain, userId => $userId, deviceId => $deviceId);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->revokeDevice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
deviceId = deviceId_example # String | The device ID

try: 
    # Revoke user device
    api_instance.revoke_device(domain, userId, deviceId)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->revokeDevice: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
deviceId*
String
The device ID
Required
Query parameters
Name Description

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization or user does not exist


setOrUpdateUserDeviceIcon

Update user device icon name

Set or Update the display icon name for a certain user device. The icon name must correspond to the type of the device.


/device/info/v1/icon/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//device/info/v1/icon/{domain}/{userId}/{deviceId}?name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        String name = name_example; // String | The display icon name of the device to be updated
        try {
            apiInstance.setOrUpdateUserDeviceIcon(domain, userId, deviceId, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#setOrUpdateUserDeviceIcon");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        String name = name_example; // String | The display icon name of the device to be updated
        try {
            apiInstance.setOrUpdateUserDeviceIcon(domain, userId, deviceId, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#setOrUpdateUserDeviceIcon");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *deviceId = deviceId_example; // The device ID
String *name = name_example; // The display icon name of the device to be updated

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Update user device icon name
[apiInstance setOrUpdateUserDeviceIconWith:domain
    userId:userId
    deviceId:deviceId
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var deviceId = deviceId_example; // {{String}} The device ID
var name = name_example; // {{String}} The display icon name of the device to be updated

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setOrUpdateUserDeviceIcon(domain, userId, deviceId, name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setOrUpdateUserDeviceIconExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var deviceId = deviceId_example;  // String | The device ID
            var name = name_example;  // String | The display icon name of the device to be updated

            try
            {
                // Update user device icon name
                apiInstance.setOrUpdateUserDeviceIcon(domain, userId, deviceId, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.setOrUpdateUserDeviceIcon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$deviceId = deviceId_example; // String | The device ID
$name = name_example; // String | The display icon name of the device to be updated

try {
    $api_instance->setOrUpdateUserDeviceIcon($domain, $userId, $deviceId, $name);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->setOrUpdateUserDeviceIcon: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $deviceId = deviceId_example; # String | The device ID
my $name = name_example; # String | The display icon name of the device to be updated

eval { 
    $api_instance->setOrUpdateUserDeviceIcon(domain => $domain, userId => $userId, deviceId => $deviceId, name => $name);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->setOrUpdateUserDeviceIcon: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
deviceId = deviceId_example # String | The device ID
name = name_example # String | The display icon name of the device to be updated

try: 
    # Update user device icon name
    api_instance.set_or_update_user_device_icon(domain, userId, deviceId, name)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->setOrUpdateUserDeviceIcon: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
deviceId*
String
The device ID
Required
Query parameters
Name Description
name*
String
The display icon name of the device to be updated
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization, user or device does not exist


setOrUpdateUserDeviceName

Update user device name

Set or Update the display name of a certain user device.


/device/info/v1/name/{domain}/{userId}/{deviceId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
\
"/api//device/info/v1/name/{domain}/{userId}/{deviceId}?name="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        String name = name_example; // String | The display name of the device to be updated (max 32 characters)
        try {
            apiInstance.setOrUpdateUserDeviceName(domain, userId, deviceId, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#setOrUpdateUserDeviceName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user ID
        String deviceId = deviceId_example; // String | The device ID
        String name = name_example; // String | The display name of the device to be updated (max 32 characters)
        try {
            apiInstance.setOrUpdateUserDeviceName(domain, userId, deviceId, name);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#setOrUpdateUserDeviceName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user ID
String *deviceId = deviceId_example; // The device ID
String *name = name_example; // The display name of the device to be updated (max 32 characters)

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Update user device name
[apiInstance setOrUpdateUserDeviceNameWith:domain
    userId:userId
    deviceId:deviceId
    name:name
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user ID
var deviceId = deviceId_example; // {{String}} The device ID
var name = name_example; // {{String}} The display name of the device to be updated (max 32 characters)

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setOrUpdateUserDeviceName(domain, userId, deviceId, name, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setOrUpdateUserDeviceNameExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user ID
            var deviceId = deviceId_example;  // String | The device ID
            var name = name_example;  // String | The display name of the device to be updated (max 32 characters)

            try
            {
                // Update user device name
                apiInstance.setOrUpdateUserDeviceName(domain, userId, deviceId, name);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.setOrUpdateUserDeviceName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user ID
$deviceId = deviceId_example; // String | The device ID
$name = name_example; // String | The display name of the device to be updated (max 32 characters)

try {
    $api_instance->setOrUpdateUserDeviceName($domain, $userId, $deviceId, $name);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->setOrUpdateUserDeviceName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user ID
my $deviceId = deviceId_example; # String | The device ID
my $name = name_example; # String | The display name of the device to be updated (max 32 characters)

eval { 
    $api_instance->setOrUpdateUserDeviceName(domain => $domain, userId => $userId, deviceId => $deviceId, name => $name);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->setOrUpdateUserDeviceName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user ID
deviceId = deviceId_example # String | The device ID
name = name_example # String | The display name of the device to be updated (max 32 characters)

try: 
    # Update user device name
    api_instance.set_or_update_user_device_name(domain, userId, deviceId, name)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->setOrUpdateUserDeviceName: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user ID
Required
deviceId*
String
The device ID
Required
Query parameters
Name Description
name*
String
The display name of the device to be updated (max 32 characters)
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Organization, user or device does not exist


subscribeForUserDeviceInfoUpdates

Subscribe for user devices updates

Subscribe for update events when there are any changes in the users device set. Subscription data is in application/app-config-data format.


/device/info/v1/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: text/event-stream"\
"/api//device/info/v1/{domain}/{userId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserDeviceInformationApi;

import java.io.File;
import java.util.*;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        // Configure API key authorization: System
        ApiKeyAuth System = (ApiKeyAuth) defaultClient.getAuthentication("System");
        System.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //System.setApiKeyPrefix("Token");

        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        try {
            apiInstance.subscribeForUserDeviceInfoUpdates(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#subscribeForUserDeviceInfoUpdates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserDeviceInformationApi;

public class UserDeviceInformationApiExample {

    public static void main(String[] args) {
        UserDeviceInformationApi apiInstance = new UserDeviceInformationApi();
        String domain = domain_example; // String | The domain of the organization the user belongs to
        String userId = userId_example; // String | The user id
        try {
            apiInstance.subscribeForUserDeviceInfoUpdates(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserDeviceInformationApi#subscribeForUserDeviceInfoUpdates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: System)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"t"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"t"];
String *domain = domain_example; // The domain of the organization the user belongs to
String *userId = userId_example; // The user id

UserDeviceInformationApi *apiInstance = [[UserDeviceInformationApi alloc] init];

// Subscribe for user devices updates
[apiInstance subscribeForUserDeviceInfoUpdatesWith:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


// Configure API key authorization: System
var System = defaultClient.authentications['System'];
System.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//System.apiKeyPrefix['t'] = "Token"

var api = new TelepoApi.UserDeviceInformationApi()
var domain = domain_example; // {{String}} The domain of the organization the user belongs to
var userId = userId_example; // {{String}} The user id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscribeForUserDeviceInfoUpdates(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subscribeForUserDeviceInfoUpdatesExample
    {
        public void main()
        {

            // Configure API key authorization: System
            Configuration.Default.ApiKey.Add("t", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("t", "Bearer");

            var apiInstance = new UserDeviceInformationApi();
            var domain = domain_example;  // String | The domain of the organization the user belongs to
            var userId = userId_example;  // String | The user id

            try
            {
                // Subscribe for user devices updates
                apiInstance.subscribeForUserDeviceInfoUpdates(domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserDeviceInformationApi.subscribeForUserDeviceInfoUpdates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: System
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('t', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('t', 'Bearer');

$api_instance = new Swagger\Client\ApiUserDeviceInformationApi();
$domain = domain_example; // String | The domain of the organization the user belongs to
$userId = userId_example; // String | The user id

try {
    $api_instance->subscribeForUserDeviceInfoUpdates($domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling UserDeviceInformationApi->subscribeForUserDeviceInfoUpdates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserDeviceInformationApi;

# Configure API key authorization: System
$WWW::SwaggerClient::Configuration::api_key->{'t'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'t'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UserDeviceInformationApi->new();
my $domain = domain_example; # String | The domain of the organization the user belongs to
my $userId = userId_example; # String | The user id

eval { 
    $api_instance->subscribeForUserDeviceInfoUpdates(domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling UserDeviceInformationApi->subscribeForUserDeviceInfoUpdates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: System
swagger_client.configuration.api_key['t'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['t'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UserDeviceInformationApi()
domain = domain_example # String | The domain of the organization the user belongs to
userId = userId_example # String | The user id

try: 
    # Subscribe for user devices updates
    api_instance.subscribe_for_user_device_info_updates(domain, userId)
except ApiException as e:
    print("Exception when calling UserDeviceInformationApi->subscribeForUserDeviceInfoUpdates: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization the user belongs to
Required
userId*
String
The user id
Required
Query parameters
Name Description

Responses

Status: 200 - A document stream in 'application/app-config-data' format

Status: 404 - Not Found


UserInformation

deleteContactPhoto

Delete photo

Delete photo associated with the user.


/user/info/{domain}/{user}/photo

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//user/info/{domain}/{user}/photo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            apiInstance.deleteContactPhoto(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#deleteContactPhoto");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            apiInstance.deleteContactPhoto(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#deleteContactPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Delete photo
[apiInstance deleteContactPhotoWith:domain
    user:user
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteContactPhoto(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteContactPhotoExample
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Delete photo
                apiInstance.deleteContactPhoto(domain, user);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.deleteContactPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $api_instance->deleteContactPhoto($domain, $user);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->deleteContactPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    $api_instance->deleteContactPhoto(domain => $domain, user => $user);
};
if ($@) {
    warn "Exception when calling UserInformationApi->deleteContactPhoto: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Delete photo
    api_instance.delete_contact_photo(domain, user)
except ApiException as e:
    print("Exception when calling UserInformationApi->deleteContactPhoto: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPhoto

Get photo

Get the photo associated with a user.


/user/info/{domain}/{user}/photo

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: image/jpeg"\
"/api//user/info/{domain}/{user}/photo?prefWidth=&prefHeight="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        Integer prefWidth = 56; // Integer | The preferred width of the photo
        Integer prefHeight = 56; // Integer | The preferred height of the photo
        try {
            'String' result = apiInstance.getContactPhoto(domain, user, prefWidth, prefHeight);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPhoto");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        Integer prefWidth = 56; // Integer | The preferred width of the photo
        Integer prefHeight = 56; // Integer | The preferred height of the photo
        try {
            'String' result = apiInstance.getContactPhoto(domain, user, prefWidth, prefHeight);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user
Integer *prefWidth = 56; // The preferred width of the photo (optional)
Integer *prefHeight = 56; // The preferred height of the photo (optional)

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get photo
[apiInstance getContactPhotoWith:domain
    user:user
    prefWidth:prefWidth
    prefHeight:prefHeight
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user
var opts = { 
  'prefWidth': 56, // {{Integer}} The preferred width of the photo
  'prefHeight': 56 // {{Integer}} The preferred height of the photo
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPhoto(domain, user, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPhotoExample
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user
            var prefWidth = 56;  // Integer | The preferred width of the photo (optional) 
            var prefHeight = 56;  // Integer | The preferred height of the photo (optional) 

            try
            {
                // Get photo
                'String' result = apiInstance.getContactPhoto(domain, user, prefWidth, prefHeight);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user
$prefWidth = 56; // Integer | The preferred width of the photo
$prefHeight = 56; // Integer | The preferred height of the photo

try {
    $result = $api_instance->getContactPhoto($domain, $user, $prefWidth, $prefHeight);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user
my $prefWidth = 56; # Integer | The preferred width of the photo
my $prefHeight = 56; # Integer | The preferred height of the photo

eval { 
    my $result = $api_instance->getContactPhoto(domain => $domain, user => $user, prefWidth => $prefWidth, prefHeight => $prefHeight);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPhoto: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user
prefWidth = 56 # Integer | The preferred width of the photo (optional)
prefHeight = 56 # Integer | The preferred height of the photo (optional)

try: 
    # Get photo
    api_response = api_instance.get_contact_photo(domain, user, prefWidth=prefWidth, prefHeight=prefHeight)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPhoto: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required
Query parameters
Name Description
prefWidth
Integer (int32)
The preferred width of the photo
prefHeight
Integer (int32)
The preferred height of the photo

Responses

Status: 200 - OK

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresence1

Get presence state

Get the presence state for the accessing user.


/user/info/{domain}/{user}/presence

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/info/{domain}/{user}/presence"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The user ID of the user accessing the API
        try {
            presence result = apiInstance.getContactPresence1(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresence1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user accessing the API
        String user = user_example; // String | The user ID of the user accessing the API
        try {
            presence result = apiInstance.getContactPresence1(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresence1");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user accessing the API
String *user = user_example; // The user ID of the user accessing the API

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get presence state
[apiInstance getContactPresence1With:domain
    user:user
              completionHandler: ^(presence output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user accessing the API
var user = user_example; // {{String}} The user ID of the user accessing the API

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPresence1(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPresence1Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user accessing the API
            var user = user_example;  // String | The user ID of the user accessing the API

            try
            {
                // Get presence state
                presence result = apiInstance.getContactPresence1(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPresence1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user accessing the API
$user = user_example; // String | The user ID of the user accessing the API

try {
    $result = $api_instance->getContactPresence1($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPresence1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user accessing the API
my $user = user_example; # String | The user ID of the user accessing the API

eval { 
    my $result = $api_instance->getContactPresence1(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPresence1: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user accessing the API
user = user_example # String | The user ID of the user accessing the API

try: 
    # Get presence state
    api_response = api_instance.get_contact_presence1(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPresence1: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user accessing the API
Required
user*
String
The user ID of the user accessing the API
Required

Responses

Status: 200 - OK

{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","note":"Planning our upgrade","activity":{"id":"working","expiration":"2020-09-21T11:05:00Z","available":true},"idle":false,"available":true,"capabilities":["SMS"]}
{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","note":"Planning our upgrade","activity":{"id":"working","expiration":"2020-09-21T11:05:00Z","available":true},"idle":false,"available":true,"capabilities":["SMS"]}

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceActivity2

Get activity

Get the ID of the user's current activity.


/user/info/{domain}/{user}/activity

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/activity"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceActivity2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceActivity2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceActivity2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceActivity2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get activity
[apiInstance getContactPresenceActivity2With:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPresenceActivity2(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPresenceActivity2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Get activity
                'String' result = apiInstance.getContactPresenceActivity2(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPresenceActivity2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $result = $api_instance->getContactPresenceActivity2($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPresenceActivity2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    my $result = $api_instance->getContactPresenceActivity2(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPresenceActivity2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Get activity
    api_response = api_instance.get_contact_presence_activity2(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPresenceActivity2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

available

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceActivityExpiration2

Get activity end-time

Get end-time of the user's current activity. Returns 'never' if no end-time is set.


/user/info/{domain}/{user}/activityexpiration

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/activityexpiration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceActivityExpiration2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceActivityExpiration2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceActivityExpiration2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceActivityExpiration2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get activity end-time
[apiInstance getContactPresenceActivityExpiration2With:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPresenceActivityExpiration2(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPresenceActivityExpiration2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Get activity end-time
                'String' result = apiInstance.getContactPresenceActivityExpiration2(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPresenceActivityExpiration2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $result = $api_instance->getContactPresenceActivityExpiration2($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPresenceActivityExpiration2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    my $result = $api_instance->getContactPresenceActivityExpiration2(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPresenceActivityExpiration2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Get activity end-time
    api_response = api_instance.get_contact_presence_activity_expiration2(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPresenceActivityExpiration2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

2020-01-31T20:00:00Z

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceAvailable

Get availability state

Get the availability state for the user. The operation returns "true" if the user is available, and "false" otherwise.


/user/info/{domain}/{user}/available

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/available"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceAvailable(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceAvailable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceAvailable(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceAvailable");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get availability state
[apiInstance getContactPresenceAvailableWith:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPresenceAvailable(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPresenceAvailableExample
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Get availability state
                'String' result = apiInstance.getContactPresenceAvailable(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPresenceAvailable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $result = $api_instance->getContactPresenceAvailable($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPresenceAvailable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    my $result = $api_instance->getContactPresenceAvailable(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPresenceAvailable: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Get availability state
    api_response = api_instance.get_contact_presence_available(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPresenceAvailable: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

true

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceNote2

Get presence note

Get presence note of a user.


/user/info/{domain}/{user}/note

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/note"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceNote2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceNote2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceNote2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceNote2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get presence note
[apiInstance getContactPresenceNote2With:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPresenceNote2(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPresenceNote2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Get presence note
                'String' result = apiInstance.getContactPresenceNote2(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPresenceNote2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $result = $api_instance->getContactPresenceNote2($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPresenceNote2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    my $result = $api_instance->getContactPresenceNote2(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPresenceNote2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Get presence note
    api_response = api_instance.get_contact_presence_note2(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPresenceNote2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

Analyzing requirements

Status: 403 - Not Authorized

Status: 404 - Not Found


getContactPresenceRole2

Get role

Get the role of a user.


/user/info/{domain}/{user}/role

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/role"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceRole2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceRole2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            'String' result = apiInstance.getContactPresenceRole2(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#getContactPresenceRole2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Get role
[apiInstance getContactPresenceRole2With:domain
    user:user
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContactPresenceRole2(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactPresenceRole2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Get role
                'String' result = apiInstance.getContactPresenceRole2(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.getContactPresenceRole2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $result = $api_instance->getContactPresenceRole2($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->getContactPresenceRole2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    my $result = $api_instance->getContactPresenceRole2(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->getContactPresenceRole2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Get role
    api_response = api_instance.get_contact_presence_role2(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->getContactPresenceRole2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

private

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceActivity2

Set activity

Set the activity of the user.


/user/info/{domain}/{user}/activity/{activity}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/activity/{activity}?available="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String activity = activity_example; // String | The new activity ID
        Boolean available = true; // Boolean | The new availability of the user
        try {
            'String' result = apiInstance.setContactPresenceActivity2(domain, user, activity, available);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceActivity2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String activity = activity_example; // String | The new activity ID
        Boolean available = true; // Boolean | The new availability of the user
        try {
            'String' result = apiInstance.setContactPresenceActivity2(domain, user, activity, available);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceActivity2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user
String *activity = activity_example; // The new activity ID
Boolean *available = true; // The new availability of the user (optional)

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Set activity
[apiInstance setContactPresenceActivity2With:domain
    user:user
    activity:activity
    available:available
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user
var activity = activity_example; // {{String}} The new activity ID
var opts = { 
  'available': true // {{Boolean}} The new availability of the user
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setContactPresenceActivity2(domain, user, activity, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setContactPresenceActivity2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user
            var activity = activity_example;  // String | The new activity ID
            var available = true;  // Boolean | The new availability of the user (optional) 

            try
            {
                // Set activity
                'String' result = apiInstance.setContactPresenceActivity2(domain, user, activity, available);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.setContactPresenceActivity2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user
$activity = activity_example; // String | The new activity ID
$available = true; // Boolean | The new availability of the user

try {
    $result = $api_instance->setContactPresenceActivity2($domain, $user, $activity, $available);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->setContactPresenceActivity2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user
my $activity = activity_example; # String | The new activity ID
my $available = true; # Boolean | The new availability of the user

eval { 
    my $result = $api_instance->setContactPresenceActivity2(domain => $domain, user => $user, activity => $activity, available => $available);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->setContactPresenceActivity2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user
activity = activity_example # String | The new activity ID
available = true # Boolean | The new availability of the user (optional)

try: 
    # Set activity
    api_response = api_instance.set_contact_presence_activity2(domain, user, activity, available=available)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->setContactPresenceActivity2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required
activity*
String
The new activity ID
Required
Query parameters
Name Description
available
Boolean
The new availability of the user

Responses

Status: 200 - OK

available

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceActivityExpiration2

Set activity end-time

Set a user's current activity's end-time.


/user/info/{domain}/{user}/activityexpiration/{expires}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/activityexpiration/{expires}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String expires = expires_example; // String | The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time
        try {
            'String' result = apiInstance.setContactPresenceActivityExpiration2(domain, user, expires);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceActivityExpiration2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String expires = expires_example; // String | The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time
        try {
            'String' result = apiInstance.setContactPresenceActivityExpiration2(domain, user, expires);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceActivityExpiration2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user
String *expires = expires_example; // The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Set activity end-time
[apiInstance setContactPresenceActivityExpiration2With:domain
    user:user
    expires:expires
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user
var expires = expires_example; // {{String}} The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setContactPresenceActivityExpiration2(domain, user, expires, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setContactPresenceActivityExpiration2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user
            var expires = expires_example;  // String | The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time

            try
            {
                // Set activity end-time
                'String' result = apiInstance.setContactPresenceActivityExpiration2(domain, user, expires);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.setContactPresenceActivityExpiration2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user
$expires = expires_example; // String | The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time

try {
    $result = $api_instance->setContactPresenceActivityExpiration2($domain, $user, $expires);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->setContactPresenceActivityExpiration2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user
my $expires = expires_example; # String | The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time

eval { 
    my $result = $api_instance->setContactPresenceActivityExpiration2(domain => $domain, user => $user, expires => $expires);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->setContactPresenceActivityExpiration2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user
expires = expires_example # String | The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time

try: 
    # Set activity end-time
    api_response = api_instance.set_contact_presence_activity_expiration2(domain, user, expires)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->setContactPresenceActivityExpiration2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required
expires*
String
The activity end-time in ISO-8601 format, or 'never' if the activity should not have an expiry time
Required

Responses

Status: 200 - OK

2020-05-09T08:45:00Z

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceNote2

Set presence note

Set the presence note for a user.


/user/info/{domain}/{user}/note/{note}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/note/{note}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String note = note_example; // String | The new note
        try {
            'String' result = apiInstance.setContactPresenceNote2(domain, user, note);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceNote2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String note = note_example; // String | The new note
        try {
            'String' result = apiInstance.setContactPresenceNote2(domain, user, note);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceNote2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user
String *note = note_example; // The new note

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Set presence note
[apiInstance setContactPresenceNote2With:domain
    user:user
    note:note
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user
var note = note_example; // {{String}} The new note

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setContactPresenceNote2(domain, user, note, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setContactPresenceNote2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user
            var note = note_example;  // String | The new note

            try
            {
                // Set presence note
                'String' result = apiInstance.setContactPresenceNote2(domain, user, note);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.setContactPresenceNote2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user
$note = note_example; // String | The new note

try {
    $result = $api_instance->setContactPresenceNote2($domain, $user, $note);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->setContactPresenceNote2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user
my $note = note_example; # String | The new note

eval { 
    my $result = $api_instance->setContactPresenceNote2(domain => $domain, user => $user, note => $note);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->setContactPresenceNote2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user
note = note_example # String | The new note

try: 
    # Set presence note
    api_response = api_instance.set_contact_presence_note2(domain, user, note)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->setContactPresenceNote2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required
note*
String
The new note
Required

Responses

Status: 200 - OK

Waiting for our flight

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


setContactPresenceRole2

Set role

Set the role of a user.


/user/info/{domain}/{user}/role/{role}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
"/api//user/info/{domain}/{user}/role/{role}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String role = role_example; // String | The new role
        try {
            'String' result = apiInstance.setContactPresenceRole2(domain, user, role);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceRole2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        String role = role_example; // String | The new role
        try {
            'String' result = apiInstance.setContactPresenceRole2(domain, user, role);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#setContactPresenceRole2");
            e.printStackTrace();
        }
    }
}
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user
String *role = role_example; // The new role

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Set role
[apiInstance setContactPresenceRole2With:domain
    user:user
    role:role
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');

var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user
var role = role_example; // {{String}} The new role

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setContactPresenceRole2(domain, user, role, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setContactPresenceRole2Example
    {
        public void main()
        {

            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user
            var role = role_example;  // String | The new role

            try
            {
                // Set role
                'String' result = apiInstance.setContactPresenceRole2(domain, user, role);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.setContactPresenceRole2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user
$role = role_example; // String | The new role

try {
    $result = $api_instance->setContactPresenceRole2($domain, $user, $role);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->setContactPresenceRole2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;

my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user
my $role = role_example; # String | The new role

eval { 
    my $result = $api_instance->setContactPresenceRole2(domain => $domain, user => $user, role => $role);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->setContactPresenceRole2: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user
role = role_example # String | The new role

try: 
    # Set role
    api_response = api_instance.set_contact_presence_role2(domain, user, role)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->setContactPresenceRole2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required
role*
String
The new role
Required

Responses

Status: 200 - OK

business

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateContactPhoto

Upload photo

Upload a photo to be associated with a user. Both PUT and POST methods are accepted for this operation. <br>The photo shall be added in the HTTP body.


/user/info/{domain}/{user}/photo

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//user/info/{domain}/{user}/photo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            apiInstance.updateContactPhoto(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#updateContactPhoto");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        String domain = domain_example; // String | The domain of the user
        String user = user_example; // String | The user ID of the user
        try {
            apiInstance.updateContactPhoto(domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#updateContactPhoto");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the user
String *user = user_example; // The user ID of the user

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Upload photo
[apiInstance updateContactPhotoWith:domain
    user:user
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var domain = domain_example; // {{String}} The domain of the user
var user = user_example; // {{String}} The user ID of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateContactPhoto(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateContactPhotoExample
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var domain = domain_example;  // String | The domain of the user
            var user = user_example;  // String | The user ID of the user

            try
            {
                // Upload photo
                apiInstance.updateContactPhoto(domain, user);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.updateContactPhoto: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$domain = domain_example; // String | The domain of the user
$user = user_example; // String | The user ID of the user

try {
    $api_instance->updateContactPhoto($domain, $user);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->updateContactPhoto: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $domain = domain_example; # String | The domain of the user
my $user = user_example; # String | The user ID of the user

eval { 
    $api_instance->updateContactPhoto(domain => $domain, user => $user);
};
if ($@) {
    warn "Exception when calling UserInformationApi->updateContactPhoto: $@\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.UserInformationApi()
domain = domain_example # String | The domain of the user
user = user_example # String | The user ID of the user

try: 
    # Upload photo
    api_instance.update_contact_photo(domain, user)
except ApiException as e:
    print("Exception when calling UserInformationApi->updateContactPhoto: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user
Required
user*
String
The user ID of the user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found

Status: 413 - Image Too Large

Status: 415 - Unsupported Media Type


updateContactPresence2

Update presence state

Update the presence state of a user.


/user/info/{domain}/{user}/presence

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//user/info/{domain}/{user}/presence"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserInformationApi;

import java.io.File;
import java.util.*;

public class UserInformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserInformationApi apiInstance = new UserInformationApi();
        Presence body = {
  "description" : "Setting a new presence note",
  "value" : {
    "note" : "Presenting at the conference"
  }
}; // Presence | 
        String domain = domain_example; // String | The domain of the user to be updated
        String user = user_example; // String | The user ID of the user to be updated
        try {
            presence result = apiInstance.updateContactPresence2(body, domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#updateContactPresence2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserInformationApi;

public class UserInformationApiExample {

    public static void main(String[] args) {
        UserInformationApi apiInstance = new UserInformationApi();
        Presence body = {
  "description" : "Setting a new presence note",
  "value" : {
    "note" : "Presenting at the conference"
  }
}; // Presence | 
        String domain = domain_example; // String | The domain of the user to be updated
        String user = user_example; // String | The user ID of the user to be updated
        try {
            presence result = apiInstance.updateContactPresence2(body, domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserInformationApi#updateContactPresence2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Presence *body = {
  "description" : "Setting a new presence note",
  "value" : {
    "note" : "Presenting at the conference"
  }
}; // 
String *domain = domain_example; // The domain of the user to be updated
String *user = user_example; // The user ID of the user to be updated

UserInformationApi *apiInstance = [[UserInformationApi alloc] init];

// Update presence state
[apiInstance updateContactPresence2With:body
    domain:domain
    user:user
              completionHandler: ^(presence output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserInformationApi()
var body = {
  "description" : "Setting a new presence note",
  "value" : {
    "note" : "Presenting at the conference"
  }
}; // {{Presence}} 
var domain = domain_example; // {{String}} The domain of the user to be updated
var user = user_example; // {{String}} The user ID of the user to be updated

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateContactPresence2(bodydomainuser, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateContactPresence2Example
    {
        public void main()
        {


            var apiInstance = new UserInformationApi();
            var body = new Presence(); // Presence | 
            var domain = domain_example;  // String | The domain of the user to be updated
            var user = user_example;  // String | The user ID of the user to be updated

            try
            {
                // Update presence state
                presence result = apiInstance.updateContactPresence2(body, domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserInformationApi.updateContactPresence2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserInformationApi();
$body = {
  "description" : "Setting a new presence note",
  "value" : {
    "note" : "Presenting at the conference"
  }
}; // Presence | 
$domain = domain_example; // String | The domain of the user to be updated
$user = user_example; // String | The user ID of the user to be updated

try {
    $result = $api_instance->updateContactPresence2($body, $domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserInformationApi->updateContactPresence2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserInformationApi;


my $api_instance = WWW::SwaggerClient::UserInformationApi->new();
my $body = WWW::SwaggerClient::Object::Presence->new(); # Presence | 
my $domain = domain_example; # String | The domain of the user to be updated
my $user = user_example; # String | The user ID of the user to be updated

eval { 
    my $result = $api_instance->updateContactPresence2(body => $body, domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserInformationApi->updateContactPresence2: $@\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.UserInformationApi()
body = {
  "description" : "Setting a new presence note",
  "value" : {
    "note" : "Presenting at the conference"
  }
} # Presence | 
domain = domain_example # String | The domain of the user to be updated
user = user_example # String | The user ID of the user to be updated

try: 
    # Update presence state
    api_response = api_instance.update_contact_presence2(body, domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserInformationApi->updateContactPresence2: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the user to be updated
Required
user*
String
The user ID of the user to be updated
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","note":"Discuss UX with Dan","activity":{"id":"meeting","expiration":"2010-10-11T05:30:00Z","available":false},"idle":true,"available":false}
{"futurePresenceAccess":"NONE","activityAccess":"NONE","roleAccess":"NONE","noteAccess":"NONE","note":"Discuss UX with Dan","activity":{"id":"meeting","expiration":"2010-10-11T05:30:00Z","available":false},"idle":true,"available":false}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


UserLine

getAvailableOutboundDestinations

Get user lines

Get the list of all available lines that user can use


/user/line/{domain}/{user}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/line/{domain}/{user}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLineApi;

import java.io.File;
import java.util.*;

public class UserLineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserLineApi apiInstance = new UserLineApi();
        String domain = domain_example; // String | The organization domain
        String user = user_example; // String | The username of the user
        try {
            AllowedUserLinesDTO result = apiInstance.getAvailableOutboundDestinations(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLineApi#getAvailableOutboundDestinations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLineApi;

public class UserLineApiExample {

    public static void main(String[] args) {
        UserLineApi apiInstance = new UserLineApi();
        String domain = domain_example; // String | The organization domain
        String user = user_example; // String | The username of the user
        try {
            AllowedUserLinesDTO result = apiInstance.getAvailableOutboundDestinations(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLineApi#getAvailableOutboundDestinations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *user = user_example; // The username of the user

UserLineApi *apiInstance = [[UserLineApi alloc] init];

// Get user lines
[apiInstance getAvailableOutboundDestinationsWith:domain
    user:user
              completionHandler: ^(AllowedUserLinesDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserLineApi()
var domain = domain_example; // {{String}} The organization domain
var user = user_example; // {{String}} The username of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailableOutboundDestinations(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAvailableOutboundDestinationsExample
    {
        public void main()
        {


            var apiInstance = new UserLineApi();
            var domain = domain_example;  // String | The organization domain
            var user = user_example;  // String | The username of the user

            try
            {
                // Get user lines
                AllowedUserLinesDTO result = apiInstance.getAvailableOutboundDestinations(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLineApi.getAvailableOutboundDestinations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserLineApi();
$domain = domain_example; // String | The organization domain
$user = user_example; // String | The username of the user

try {
    $result = $api_instance->getAvailableOutboundDestinations($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserLineApi->getAvailableOutboundDestinations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserLineApi;


my $api_instance = WWW::SwaggerClient::UserLineApi->new();
my $domain = domain_example; # String | The organization domain
my $user = user_example; # String | The username of the user

eval { 
    my $result = $api_instance->getAvailableOutboundDestinations(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserLineApi->getAvailableOutboundDestinations: $@\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.UserLineApi()
domain = domain_example # String | The organization domain
user = user_example # String | The username of the user

try: 
    # Get user lines
    api_response = api_instance.get_available_outbound_destinations(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLineApi->getAvailableOutboundDestinations: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
user*
String
The username of the user
Required

Responses

Status: 200 - OK

{"line":[{"groupId":0,"type":"OFFICE_FIXED","number":"+123400","name":"office fixed","active":true}]}
{"line":[{"groupId":0,"type":"OFFICE_FIXED","number":"+123400","name":"office fixed","active":true}]}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


getOutboundStatus

Get active user line

Get the current active caller ID for a user.


/user/line/{domain}/{user}/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
"/api//user/line/{domain}/{user}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLineApi;

import java.io.File;
import java.util.*;

public class UserLineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserLineApi apiInstance = new UserLineApi();
        String domain = domain_example; // String | The organization domain
        String user = user_example; // String | The username of the user
        try {
            ActiveNumberDTO result = apiInstance.getOutboundStatus(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLineApi#getOutboundStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLineApi;

public class UserLineApiExample {

    public static void main(String[] args) {
        UserLineApi apiInstance = new UserLineApi();
        String domain = domain_example; // String | The organization domain
        String user = user_example; // String | The username of the user
        try {
            ActiveNumberDTO result = apiInstance.getOutboundStatus(domain, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLineApi#getOutboundStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *user = user_example; // The username of the user

UserLineApi *apiInstance = [[UserLineApi alloc] init];

// Get active user line
[apiInstance getOutboundStatusWith:domain
    user:user
              completionHandler: ^(ActiveNumberDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserLineApi()
var domain = domain_example; // {{String}} The organization domain
var user = user_example; // {{String}} The username of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOutboundStatus(domain, user, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOutboundStatusExample
    {
        public void main()
        {


            var apiInstance = new UserLineApi();
            var domain = domain_example;  // String | The organization domain
            var user = user_example;  // String | The username of the user

            try
            {
                // Get active user line
                ActiveNumberDTO result = apiInstance.getOutboundStatus(domain, user);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLineApi.getOutboundStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserLineApi();
$domain = domain_example; // String | The organization domain
$user = user_example; // String | The username of the user

try {
    $result = $api_instance->getOutboundStatus($domain, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserLineApi->getOutboundStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserLineApi;


my $api_instance = WWW::SwaggerClient::UserLineApi->new();
my $domain = domain_example; # String | The organization domain
my $user = user_example; # String | The username of the user

eval { 
    my $result = $api_instance->getOutboundStatus(domain => $domain, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserLineApi->getOutboundStatus: $@\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.UserLineApi()
domain = domain_example # String | The organization domain
user = user_example # String | The username of the user

try: 
    # Get active user line
    api_response = api_instance.get_outbound_status(domain, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserLineApi->getOutboundStatus: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
user*
String
The username of the user
Required

Responses

Status: 200 - OK

{"number":"+123400","type":"SWITCHBOARD","name":"swithboard","groupId":0}
{"number":"+123400","type":"SWITCHBOARD","name":"swithboard","groupId":0}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateOutboundStatus

Update user line

Update the current active caller ID for user.


/user/line/{domain}/{user}/status

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: application/json,application/xml"\
"/api//user/line/{domain}/{user}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserLineApi;

import java.io.File;
import java.util.*;

public class UserLineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserLineApi apiInstance = new UserLineApi();
        ActiveNumberKeyDTO body = {
  "type" : "OFFICE_FIXED",
  "groupId" : 1
}; // ActiveNumberKeyDTO | 
        String domain = domain_example; // String | The organization domain
        String user = user_example; // String | The username of the user
        try {
            apiInstance.updateOutboundStatus(body, domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLineApi#updateOutboundStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserLineApi;

public class UserLineApiExample {

    public static void main(String[] args) {
        UserLineApi apiInstance = new UserLineApi();
        ActiveNumberKeyDTO body = {
  "type" : "OFFICE_FIXED",
  "groupId" : 1
}; // ActiveNumberKeyDTO | 
        String domain = domain_example; // String | The organization domain
        String user = user_example; // String | The username of the user
        try {
            apiInstance.updateOutboundStatus(body, domain, user);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserLineApi#updateOutboundStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
ActiveNumberKeyDTO *body = {
  "type" : "OFFICE_FIXED",
  "groupId" : 1
}; // 
String *domain = domain_example; // The organization domain
String *user = user_example; // The username of the user

UserLineApi *apiInstance = [[UserLineApi alloc] init];

// Update user line
[apiInstance updateOutboundStatusWith:body
    domain:domain
    user:user
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserLineApi()
var body = {
  "type" : "OFFICE_FIXED",
  "groupId" : 1
}; // {{ActiveNumberKeyDTO}} 
var domain = domain_example; // {{String}} The organization domain
var user = user_example; // {{String}} The username of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateOutboundStatus(bodydomainuser, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateOutboundStatusExample
    {
        public void main()
        {


            var apiInstance = new UserLineApi();
            var body = new ActiveNumberKeyDTO(); // ActiveNumberKeyDTO | 
            var domain = domain_example;  // String | The organization domain
            var user = user_example;  // String | The username of the user

            try
            {
                // Update user line
                apiInstance.updateOutboundStatus(body, domain, user);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserLineApi.updateOutboundStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserLineApi();
$body = {
  "type" : "OFFICE_FIXED",
  "groupId" : 1
}; // ActiveNumberKeyDTO | 
$domain = domain_example; // String | The organization domain
$user = user_example; // String | The username of the user

try {
    $api_instance->updateOutboundStatus($body, $domain, $user);
} catch (Exception $e) {
    echo 'Exception when calling UserLineApi->updateOutboundStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserLineApi;


my $api_instance = WWW::SwaggerClient::UserLineApi->new();
my $body = WWW::SwaggerClient::Object::ActiveNumberKeyDTO->new(); # ActiveNumberKeyDTO | 
my $domain = domain_example; # String | The organization domain
my $user = user_example; # String | The username of the user

eval { 
    $api_instance->updateOutboundStatus(body => $body, domain => $domain, user => $user);
};
if ($@) {
    warn "Exception when calling UserLineApi->updateOutboundStatus: $@\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.UserLineApi()
body = {
  "type" : "OFFICE_FIXED",
  "groupId" : 1
} # ActiveNumberKeyDTO | 
domain = domain_example # String | The organization domain
user = user_example # String | The username of the user

try: 
    # Update user line
    api_instance.update_outbound_status(body, domain, user)
except ApiException as e:
    print("Exception when calling UserLineApi->updateOutboundStatus: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
user*
String
The username of the user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


UserSMS

sendSms

Send SMS

An end-user with authorized ticket could send SMS to recipient.


/user/sms/{to}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json,application/xml"\
-H "Content-Type: text/html,text/plain,text/xml,application/json,application/xml"\
"/api//user/sms/{to}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserSMSApi;

import java.io.File;
import java.util.*;

public class UserSMSApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UserSMSApi apiInstance = new UserSMSApi();
        SmsRequestDTO body = {
  "smsText" : "Everything’s going to be amazing"
}; // SmsRequestDTO | 
        String to = to_example; // String | The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.
        try {
            apiInstance.sendSms(body, to);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserSMSApi#sendSms");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserSMSApi;

public class UserSMSApiExample {

    public static void main(String[] args) {
        UserSMSApi apiInstance = new UserSMSApi();
        SmsRequestDTO body = {
  "smsText" : "Everything’s going to be amazing"
}; // SmsRequestDTO | 
        String to = to_example; // String | The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.
        try {
            apiInstance.sendSms(body, to);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserSMSApi#sendSms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
SmsRequestDTO *body = {
  "smsText" : "Everything’s going to be amazing"
}; // 
String *to = to_example; // The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.

UserSMSApi *apiInstance = [[UserSMSApi alloc] init];

// Send SMS
[apiInstance sendSmsWith:body
    to:to
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.UserSMSApi()
var body = {
  "smsText" : "Everything’s going to be amazing"
}; // {{SmsRequestDTO}} 
var to = to_example; // {{String}} The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.sendSms(bodyto, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class sendSmsExample
    {
        public void main()
        {


            var apiInstance = new UserSMSApi();
            var body = new SmsRequestDTO(); // SmsRequestDTO | 
            var to = to_example;  // String | The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.

            try
            {
                // Send SMS
                apiInstance.sendSms(body, to);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserSMSApi.sendSms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUserSMSApi();
$body = {
  "smsText" : "Everything’s going to be amazing"
}; // SmsRequestDTO | 
$to = to_example; // String | The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.

try {
    $api_instance->sendSms($body, $to);
} catch (Exception $e) {
    echo 'Exception when calling UserSMSApi->sendSms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserSMSApi;


my $api_instance = WWW::SwaggerClient::UserSMSApi->new();
my $body = WWW::SwaggerClient::Object::SmsRequestDTO->new(); # SmsRequestDTO | 
my $to = to_example; # String | The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.

eval { 
    $api_instance->sendSms(body => $body, to => $to);
};
if ($@) {
    warn "Exception when calling UserSMSApi->sendSms: $@\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.UserSMSApi()
body = {
  "smsText" : "Everything’s going to be amazing"
} # SmsRequestDTO | 
to = to_example # String | The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.

try: 
    # Send SMS
    api_instance.send_sms(body, to)
except ApiException as e:
    print("Exception when calling UserSMSApi->sendSms: %s\n" % e)

Parameters

Path parameters
Name Description
to*
String
The the number to send to. This number will be expanded according to the sending user's number plan. For example, if the user's organization has a number plan conversion of 08 -> +468, the user can send to 0890510 and the SMS will be routed to +46890510.
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found

Status: 503 - Service Unavailable


VoicemailSettings

getUserVoicemailSettings

Get user settings

Retrieve voicemail settings for a user.


/voicemailsettings/v1/{domain}/{userId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api//voicemailsettings/v1/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VoicemailSettingsApi;

import java.io.File;
import java.util.*;

public class VoicemailSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VoicemailSettingsApi apiInstance = new VoicemailSettingsApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user id of the user
        try {
            voicemailsetting result = apiInstance.getUserVoicemailSettings(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VoicemailSettingsApi#getUserVoicemailSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VoicemailSettingsApi;

public class VoicemailSettingsApiExample {

    public static void main(String[] args) {
        VoicemailSettingsApi apiInstance = new VoicemailSettingsApi();
        String domain = domain_example; // String | The domain of the organization
        String userId = userId_example; // String | The user id of the user
        try {
            voicemailsetting result = apiInstance.getUserVoicemailSettings(domain, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VoicemailSettingsApi#getUserVoicemailSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain of the organization
String *userId = userId_example; // The user id of the user

VoicemailSettingsApi *apiInstance = [[VoicemailSettingsApi alloc] init];

// Get user settings
[apiInstance getUserVoicemailSettingsWith:domain
    userId:userId
              completionHandler: ^(voicemailsetting output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.VoicemailSettingsApi()
var domain = domain_example; // {{String}} The domain of the organization
var userId = userId_example; // {{String}} The user id of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserVoicemailSettings(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserVoicemailSettingsExample
    {
        public void main()
        {


            var apiInstance = new VoicemailSettingsApi();
            var domain = domain_example;  // String | The domain of the organization
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Get user settings
                voicemailsetting result = apiInstance.getUserVoicemailSettings(domain, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VoicemailSettingsApi.getUserVoicemailSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVoicemailSettingsApi();
$domain = domain_example; // String | The domain of the organization
$userId = userId_example; // String | The user id of the user

try {
    $result = $api_instance->getUserVoicemailSettings($domain, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VoicemailSettingsApi->getUserVoicemailSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VoicemailSettingsApi;


my $api_instance = WWW::SwaggerClient::VoicemailSettingsApi->new();
my $domain = domain_example; # String | The domain of the organization
my $userId = userId_example; # String | The user id of the user

eval { 
    my $result = $api_instance->getUserVoicemailSettings(domain => $domain, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VoicemailSettingsApi->getUserVoicemailSettings: $@\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.VoicemailSettingsApi()
domain = domain_example # String | The domain of the organization
userId = userId_example # String | The user id of the user

try: 
    # Get user settings
    api_response = api_instance.get_user_voicemail_settings(domain, userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VoicemailSettingsApi->getUserVoicemailSettings: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The domain of the organization
Required
userId*
String
The user id of the user
Required

Responses

Status: 200 - OK

{"playActivity":true,"playMergedUnavailableEndTime":false,"playHumanAssistance":true,"humanAssistanceNumber":"+4676767676","smsNotification":false,"emailNotification":true,"fileAttached":false,"voicemailInboxFullSmsNotification":false,"voicemailInboxFullEmailNotification":true,"allowDownload":true,"allowVoicemail":true,"bypassVoicemail":false}

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


resetUserVoicemailSettings

Reset user settings

Reset voicemail settings for a user.


/voicemailsettings/v1/userreset/{domain}/{userId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
"/api//voicemailsettings/v1/userreset/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VoicemailSettingsApi;

import java.io.File;
import java.util.*;

public class VoicemailSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VoicemailSettingsApi apiInstance = new VoicemailSettingsApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            apiInstance.resetUserVoicemailSettings(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VoicemailSettingsApi#resetUserVoicemailSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VoicemailSettingsApi;

public class VoicemailSettingsApiExample {

    public static void main(String[] args) {
        VoicemailSettingsApi apiInstance = new VoicemailSettingsApi();
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            apiInstance.resetUserVoicemailSettings(domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VoicemailSettingsApi#resetUserVoicemailSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user

VoicemailSettingsApi *apiInstance = [[VoicemailSettingsApi alloc] init];

// Reset user settings
[apiInstance resetUserVoicemailSettingsWith:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.VoicemailSettingsApi()
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetUserVoicemailSettings(domain, userId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetUserVoicemailSettingsExample
    {
        public void main()
        {


            var apiInstance = new VoicemailSettingsApi();
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Reset user settings
                apiInstance.resetUserVoicemailSettings(domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VoicemailSettingsApi.resetUserVoicemailSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVoicemailSettingsApi();
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user

try {
    $api_instance->resetUserVoicemailSettings($domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling VoicemailSettingsApi->resetUserVoicemailSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VoicemailSettingsApi;


my $api_instance = WWW::SwaggerClient::VoicemailSettingsApi->new();
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user

eval { 
    $api_instance->resetUserVoicemailSettings(domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling VoicemailSettingsApi->resetUserVoicemailSettings: $@\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.VoicemailSettingsApi()
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user

try: 
    # Reset user settings
    api_instance.reset_user_voicemail_settings(domain, userId)
except ApiException as e:
    print("Exception when calling VoicemailSettingsApi->resetUserVoicemailSettings: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found


updateUserVoicemailSettings

Update user settings

Update voicemail settings for a user.


/voicemailsettings/v1/{domain}/{userId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Content-Type: application/json"\
"/api//voicemailsettings/v1/{domain}/{userId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VoicemailSettingsApi;

import java.io.File;
import java.util.*;

public class VoicemailSettingsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VoicemailSettingsApi apiInstance = new VoicemailSettingsApi();
        Voicemailsetting body = {
  "playActivity" : true,
  "playMergedUnavailableEndTime" : false,
  "playHumanAssistance" : true,
  "humanAssistanceNumber" : "+4676767676",
  "smsNotification" : false,
  "emailNotification" : true,
  "fileAttached" : false,
  "voicemailInboxFullSmsNotification" : false,
  "voicemailInboxFullEmailNotification" : true,
  "allowDownload" : true,
  "allowVoicemail" : true,
  "bypassVoicemail" : false
}; // Voicemailsetting | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            apiInstance.updateUserVoicemailSettings(body, domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VoicemailSettingsApi#updateUserVoicemailSettings");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VoicemailSettingsApi;

public class VoicemailSettingsApiExample {

    public static void main(String[] args) {
        VoicemailSettingsApi apiInstance = new VoicemailSettingsApi();
        Voicemailsetting body = {
  "playActivity" : true,
  "playMergedUnavailableEndTime" : false,
  "playHumanAssistance" : true,
  "humanAssistanceNumber" : "+4676767676",
  "smsNotification" : false,
  "emailNotification" : true,
  "fileAttached" : false,
  "voicemailInboxFullSmsNotification" : false,
  "voicemailInboxFullEmailNotification" : true,
  "allowDownload" : true,
  "allowVoicemail" : true,
  "bypassVoicemail" : false
}; // Voicemailsetting | 
        String domain = domain_example; // String | The organization domain
        String userId = userId_example; // String | The user id of the user
        try {
            apiInstance.updateUserVoicemailSettings(body, domain, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VoicemailSettingsApi#updateUserVoicemailSettings");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Voicemailsetting *body = {
  "playActivity" : true,
  "playMergedUnavailableEndTime" : false,
  "playHumanAssistance" : true,
  "humanAssistanceNumber" : "+4676767676",
  "smsNotification" : false,
  "emailNotification" : true,
  "fileAttached" : false,
  "voicemailInboxFullSmsNotification" : false,
  "voicemailInboxFullEmailNotification" : true,
  "allowDownload" : true,
  "allowVoicemail" : true,
  "bypassVoicemail" : false
}; // 
String *domain = domain_example; // The organization domain
String *userId = userId_example; // The user id of the user

VoicemailSettingsApi *apiInstance = [[VoicemailSettingsApi alloc] init];

// Update user settings
[apiInstance updateUserVoicemailSettingsWith:body
    domain:domain
    userId:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var TelepoApi = require('telepo_api');
var defaultClient = TelepoApi.ApiClient.instance;


var api = new TelepoApi.VoicemailSettingsApi()
var body = {
  "playActivity" : true,
  "playMergedUnavailableEndTime" : false,
  "playHumanAssistance" : true,
  "humanAssistanceNumber" : "+4676767676",
  "smsNotification" : false,
  "emailNotification" : true,
  "fileAttached" : false,
  "voicemailInboxFullSmsNotification" : false,
  "voicemailInboxFullEmailNotification" : true,
  "allowDownload" : true,
  "allowVoicemail" : true,
  "bypassVoicemail" : false
}; // {{Voicemailsetting}} 
var domain = domain_example; // {{String}} The organization domain
var userId = userId_example; // {{String}} The user id of the user

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateUserVoicemailSettings(bodydomainuserId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserVoicemailSettingsExample
    {
        public void main()
        {


            var apiInstance = new VoicemailSettingsApi();
            var body = new Voicemailsetting(); // Voicemailsetting | 
            var domain = domain_example;  // String | The organization domain
            var userId = userId_example;  // String | The user id of the user

            try
            {
                // Update user settings
                apiInstance.updateUserVoicemailSettings(body, domain, userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VoicemailSettingsApi.updateUserVoicemailSettings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVoicemailSettingsApi();
$body = {
  "playActivity" : true,
  "playMergedUnavailableEndTime" : false,
  "playHumanAssistance" : true,
  "humanAssistanceNumber" : "+4676767676",
  "smsNotification" : false,
  "emailNotification" : true,
  "fileAttached" : false,
  "voicemailInboxFullSmsNotification" : false,
  "voicemailInboxFullEmailNotification" : true,
  "allowDownload" : true,
  "allowVoicemail" : true,
  "bypassVoicemail" : false
}; // Voicemailsetting | 
$domain = domain_example; // String | The organization domain
$userId = userId_example; // String | The user id of the user

try {
    $api_instance->updateUserVoicemailSettings($body, $domain, $userId);
} catch (Exception $e) {
    echo 'Exception when calling VoicemailSettingsApi->updateUserVoicemailSettings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VoicemailSettingsApi;


my $api_instance = WWW::SwaggerClient::VoicemailSettingsApi->new();
my $body = WWW::SwaggerClient::Object::Voicemailsetting->new(); # Voicemailsetting | 
my $domain = domain_example; # String | The organization domain
my $userId = userId_example; # String | The user id of the user

eval { 
    $api_instance->updateUserVoicemailSettings(body => $body, domain => $domain, userId => $userId);
};
if ($@) {
    warn "Exception when calling VoicemailSettingsApi->updateUserVoicemailSettings: $@\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.VoicemailSettingsApi()
body = {
  "playActivity" : true,
  "playMergedUnavailableEndTime" : false,
  "playHumanAssistance" : true,
  "humanAssistanceNumber" : "+4676767676",
  "smsNotification" : false,
  "emailNotification" : true,
  "fileAttached" : false,
  "voicemailInboxFullSmsNotification" : false,
  "voicemailInboxFullEmailNotification" : true,
  "allowDownload" : true,
  "allowVoicemail" : true,
  "bypassVoicemail" : false
} # Voicemailsetting | 
domain = domain_example # String | The organization domain
userId = userId_example # String | The user id of the user

try: 
    # Update user settings
    api_instance.update_user_voicemail_settings(body, domain, userId)
except ApiException as e:
    print("Exception when calling VoicemailSettingsApi->updateUserVoicemailSettings: %s\n" % e)

Parameters

Path parameters
Name Description
domain*
String
The organization domain
Required
userId*
String
The user id of the user
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 403 - Not Authorized

Status: 404 - Not Found