Suggest Edits

Get all toplevel API URLs

 
gethttps://api.sipgate.com/v1/
curl --request GET \
  --url https://api.sipgate.com/v1/
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

successful operation

accountUrlstring
accountVerifiedUrlstring
addressUrlstring
addressesUrlstring
addressNumbersUrlstring
authorizationOauthClientsSecretUrlstring
authorizationOauthClientsUrlstring
authorizationOauthTokenUrlstring
authorizationTokenUrlstring
balanceUrlstring
contactsUrlstring
internalContactsUrlstring
deviceCallerIdUrlstring
deviceUrlstring
devicesTariffAnnouncementUrlstring
devicesSingleRowDisplayUrlstring
deviceSimOrdersUrlstring
devicesUrlstring
faxlinesUrlstring
faxlineUrlstring
faxlineNumbersUrlstring
groupsUrlstring
groupUserUrlstring
groupNumbersUrlstring
historyEntryUrlstring
historyUrlstring
notificationsUrlstring
numberUrlstring
numbersUrlstring
addDirectDialUrlstring
changeDirectDialUrlstring
deleteDirectDialUrlstring
phonelineUrlstring
phonelineBlockAnonymousUrlstring
phonelineBusyOnBusyUrlstring
phonelineDevicesUrlstring
phonelineForwardingsUrlstring
phonelineNumbersUrlstring
phonelinesParallelForwardingUrlstring
phonelinesParallelForwardingsUrlstring
phonelineSipgateIoUrlstring
phonelineSipgateIoLogUrlstring
phonelineVoicemailGreetingUrlstring
phonelineVoicemailGreetingsUrlstring
phonelineVoicemailUrlstring
phonelineVoicemailsUrlstring
phonelinesUrlstring
portingUrlstring
portingsUrlstring
restrictionsUrlstring
sessionsCallUrlstring
settingsSipgateioUrlstring
smsUrlstring
smsCallerIdsUrlstring
translationsUrlstring
userInfoUrlstring
userUrlstring
userDefaultDeviceUrlstring
userDevicesUrlstring
userExternalDevicesUrlstring
userMobileDevicesUrlstring
userRegisterDevicesUrlstring
usersUrlstring
 
Suggest Edits

Returns account data

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/account
curl --request GET \
  --url https://api.sipgate.com/v1/account
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/account' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/account");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/account"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

companystring
mainProductTypestring
logoUrlstring
verifiedboolean

Account not found

Suggest Edits

Verify your account

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/account/verified
curl --request PUT \
  --url https://api.sipgate.com/v1/account/verified
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/account/verified' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/account/verified")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/account/verified");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/account/verified"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

Response

Verification code not found

Suggest Edits

addresses

 
Suggest Edits

Returns all addresses with their corresponding addressIds

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/addresses
curl --request GET \
  --url https://api.sipgate.com/v1/addresses
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/addresses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/addresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/addresses");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/addresses"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

itemsarray
Suggest Edits

Returns address with their corresponding addressId

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/addresses/addressId
curl --request GET \
  --url https://api.sipgate.com/v1/addresses/addressId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/addresses/addressId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/addresses/addressId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/addresses/addressId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/addresses/addressId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

addressId
string
required

e.g. 12345

Response

successful operation

poBoxstring
extendedAddressstring
streetAddressstring
localitystring
regionstring
postalCodestring
countrystring
Suggest Edits

Modify an address to change your location

Warning: Depending on your country of residence, a change of your address may lead to the deactivation of associated telephone numbers.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/addresses/addressId
curl --request PUT \
  --url https://api.sipgate.com/v1/addresses/addressId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/addresses/addressId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/addresses/addressId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/addresses/addressId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/addresses/addressId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

addressId
string
required

e.g. 12345

Body Params

countrycode
string
required
state
string
postcode
string
required
city
string
required
street
string
number
string
address1
string
address2
string

Response

Bad request

Suggest Edits

Get the active events for this account

 
gethttps://api.sipgate.com/v1/app/events
curl --request GET \
  --url https://api.sipgate.com/v1/app/events
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/app/events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/app/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/app/events");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/app/events"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

successful operation

itemsarray
Suggest Edits

Deletes an event by ID

 
deletehttps://api.sipgate.com/v1/app/events/id
curl --request DELETE \
  --url https://api.sipgate.com/v1/app/events/id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/app/events/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/app/events/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/app/events/id");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/app/events/id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

id
int32
required

Response

successful operation

Suggest Edits

Returns true if terms and conditions for app.sipgate.com have been accepted

 
gethttps://api.sipgate.com/v1/app/tacs
curl --request GET \
  --url https://api.sipgate.com/v1/app/tacs
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/app/tacs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/app/tacs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/app/tacs");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/app/tacs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

successful operation

acceptedboolean
Suggest Edits

Accept/Revoke terms and conditions for app.sipgate.com

 
puthttps://api.sipgate.com/v1/app/tacs
curl --request PUT \
  --url https://api.sipgate.com/v1/app/tacs
var request = require("request");

var options = { method: 'PUT', url: 'https://api.sipgate.com/v1/app/tacs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/app/tacs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/app/tacs");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/app/tacs"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

accepted
boolean

Response

successful operation

Suggest Edits

Returns true if welcome screen should be enabled

 
gethttps://api.sipgate.com/v1/app/welcome
curl --request GET \
  --url https://api.sipgate.com/v1/app/welcome
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/app/welcome' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/app/welcome")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/app/welcome");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/app/welcome"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

successful operation

enabledboolean
Suggest Edits

Enable/Disable welcome screen

 
puthttps://api.sipgate.com/v1/app/welcome
curl --request PUT \
  --url https://api.sipgate.com/v1/app/welcome
var request = require("request");

var options = { method: 'PUT', url: 'https://api.sipgate.com/v1/app/welcome' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/app/welcome")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/app/welcome");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/app/welcome"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

enabled
boolean

Response

successful operation

Suggest Edits

authorization

 
Suggest Edits

Redirect the user here for them to authorize your application

 
gethttps://api.sipgate.com/v1/authorization/oauth/authorize
curl --request GET \
  --url 'https://api.sipgate.com/v1/authorization/oauth/authorize?scope=scope&response_type=response_type&client_id=client_id&redirect_uri=redirect_uri'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/authorization/oauth/authorize',
  qs: 
   { scope: 'scope',
     response_type: 'response_type',
     client_id: 'client_id',
     redirect_uri: 'redirect_uri' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/oauth/authorize?scope=scope&response_type=response_type&client_id=client_id&redirect_uri=redirect_uri")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/authorization/oauth/authorize?scope=scope&response_type=response_type&client_id=client_id&redirect_uri=redirect_uri");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/oauth/authorize"

querystring = {"scope":"scope","response_type":"response_type","client_id":"client_id","redirect_uri":"redirect_uri"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

scope
array of strings
required

The scope(s) for the authentication as a space separated list

response_type
string
required

The response type for the authentication

client_id
string
required

Your oauth client id

redirect_uri
string
required

the URL the user will be redirected to after authentication

state
string

You may provide a state, that we will return in the redirect

nonce
string

The Nonce will be returned in the id_token if the scope is openid

Response

See Other

Suggest Edits

Get all OAuth clients of user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/authorization/oauth/clients
curl --request GET \
  --url https://api.sipgate.com/v1/authorization/oauth/clients
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/authorization/oauth/clients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/oauth/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/authorization/oauth/clients");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/oauth/clients"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

itemsarray
Suggest Edits

Create a new OAuth client

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/authorization/oauth/clients
curl --request POST \
  --url https://api.sipgate.com/v1/authorization/oauth/clients
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/authorization/oauth/clients' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/oauth/clients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/authorization/oauth/clients");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/oauth/clients"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

name
string

Response

successful operation

Suggest Edits

Get OAuth client

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/authorization/oauth/clients/clientId
curl --request GET \
  --url https://api.sipgate.com/v1/authorization/oauth/clients/clientId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/authorization/oauth/clients/clientId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/oauth/clients/clientId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/authorization/oauth/clients/clientId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/oauth/clients/clientId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

clientId
string
required

abcdefghi

Response

successful operation

itemsarray
Suggest Edits

Reset oauth2 client-secret

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/authorization/oauth/clients/clientId/secret
curl --request POST \
  --url https://api.sipgate.com/v1/authorization/oauth/clients/clientId/secret
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/authorization/oauth/clients/clientId/secret' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/oauth/clients/clientId/secret")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/authorization/oauth/clients/clientId/secret");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/oauth/clients/clientId/secret"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

clientId
string
required

abcdefghi

Response

successful operation

Suggest Edits

Request an oauth session token

Use this session token in the Authorization header to access protected routes.
Example header:

Authorization: Bearer <token>

 
posthttps://api.sipgate.com/v1/authorization/oauth/token
curl --request POST \
  --url https://api.sipgate.com/v1/authorization/oauth/token
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/authorization/oauth/token' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/oauth/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/authorization/oauth/token");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/oauth/token"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Form Data

client_id
string
required

client_id

client_secret
string
required

client_secret

code
string
required

code

redirect_uri
string
required

redirect_uri

grant_type
string
required

grant_type

Response

successful operation

access_tokenstring
token_typestring
id_tokenstring

Invalid Request

errorstring
Suggest Edits

Create a session token

Use this session token in the Authorization header to access protected routes.
Example header:

Authorization: Bearer <token>

 
posthttps://api.sipgate.com/v1/authorization/token
curl --request POST \
  --url https://api.sipgate.com/v1/authorization/token
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/authorization/token' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/authorization/token");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/token"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

username
string
required
password
string
required

Response

successful operation

tokenstring

Invalid credentials supplied

Suggest Edits

Invalidate a session token

 
deletehttps://api.sipgate.com/v1/authorization/token
curl --request DELETE \
  --url https://api.sipgate.com/v1/authorization/token
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/authorization/token' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/authorization/token");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/token"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Headers

Authorization
string

token

Response

Invalid token supplied

Suggest Edits

Returns information about the logged in user

 
gethttps://api.sipgate.com/v1/authorization/userinfo
curl --request GET \
  --url https://api.sipgate.com/v1/authorization/userinfo
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/authorization/userinfo' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/authorization/userinfo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/authorization/userinfo");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/authorization/userinfo"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Headers

Authorization
string

token

Response

successful operation

substring
domainstring
masterSipIdstring
localestring

Invalid token supplied

 
Suggest Edits

Get the account balance

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/balance
curl --request GET \
  --url https://api.sipgate.com/v1/balance
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/balance' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/balance");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/balance"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

amountinteger
currencystring
Suggest Edits

internal contacts

 
Suggest Edits

Returns all contacts

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/contacts/internal
curl --request GET \
  --url https://api.sipgate.com/v1/contacts/internal
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/contacts/internal' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/contacts/internal")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/contacts/internal");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/contacts/internal"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

itemsarray
 
Suggest Edits

Returns a given devices

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/devices/deviceId
curl --request GET \
  --url https://api.sipgate.com/v1/devices/deviceId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/devices/deviceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/devices/deviceId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

idstring
aliasstring
typestring
onlineboolean
dndboolean
activePhonelinesarray
activeGroupsarray
Suggest Edits

Change device settings

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/devices/deviceId
curl --request PUT \
  --url https://api.sipgate.com/v1/devices/deviceId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/devices/deviceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/devices/deviceId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Body Params

dnd
boolean
emergencyAddressId
int32

Response

successful operation

Suggest Edits

Deletes a given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://api.sipgate.com/v1/devices/deviceId
curl --request DELETE \
  --url https://api.sipgate.com/v1/devices/deviceId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/devices/deviceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/devices/deviceId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

Suggest Edits

Change device alias

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/devices/deviceId/alias
curl --request PUT \
  --url https://api.sipgate.com/v1/devices/deviceId/alias
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/devices/deviceId/alias' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/alias")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/devices/deviceId/alias");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/alias"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Body Params

value
string

Response

Device not found

Suggest Edits

Caller ID for given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/devices/deviceId/callerid
curl --request GET \
  --url https://api.sipgate.com/v1/devices/deviceId/callerid
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/devices/deviceId/callerid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/callerid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/devices/deviceId/callerid");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/callerid"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

valuestring

Feature not booked

Suggest Edits

Change caller ID for device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/devices/deviceId/callerid
curl --request PUT \
  --url https://api.sipgate.com/v1/devices/deviceId/callerid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/devices/deviceId/callerid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/callerid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/devices/deviceId/callerid");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/callerid"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Body Params

value
string

Response

Feature not booked

Suggest Edits

Change device password

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/devices/deviceId/credentials/password
curl --request POST \
  --url https://api.sipgate.com/v1/devices/deviceId/credentials/password
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/devices/deviceId/credentials/password' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/credentials/password")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/devices/deviceId/credentials/password");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/credentials/password"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

Suggest Edits

Localprefix for given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/devices/deviceId/localprefix
curl --request GET \
  --url https://api.sipgate.com/v1/devices/deviceId/localprefix
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/devices/deviceId/localprefix' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/localprefix")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/devices/deviceId/localprefix");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/localprefix"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

valuestring
activeboolean
Suggest Edits

Change localprefix for device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/devices/deviceId/localprefix
curl --request PUT \
  --url https://api.sipgate.com/v1/devices/deviceId/localprefix
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/devices/deviceId/localprefix' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/localprefix")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/devices/deviceId/localprefix");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/localprefix"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Body Params

value
string
active
boolean

Response

successful operation

Suggest Edits

Returns whether single row display setting is enabled or disabled for the given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/devices/deviceId/singlerowdisplay
curl --request GET \
  --url https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

enabledboolean
Suggest Edits

Enable/Disable single row display setting for the given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/devices/deviceId/singlerowdisplay
curl --request PUT \
  --url https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/singlerowdisplay"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Body Params

enabled
boolean

Response

successful operation

Suggest Edits

Returns whether tariff announcement is enabled or disabled for the given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/devices/deviceId/tariffannouncement
curl --request GET \
  --url https://api.sipgate.com/v1/devices/deviceId/tariffannouncement
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/devices/deviceId/tariffannouncement' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/tariffannouncement")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/devices/deviceId/tariffannouncement");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/tariffannouncement"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Response

successful operation

enabledboolean

Feature not booked

Suggest Edits

Enable/Disable tariff announcement for the given device

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/devices/deviceId/tariffannouncement
curl --request PUT \
  --url https://api.sipgate.com/v1/devices/deviceId/tariffannouncement
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/devices/deviceId/tariffannouncement' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/devices/deviceId/tariffannouncement")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/devices/deviceId/tariffannouncement");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/devices/deviceId/tariffannouncement"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

deviceId
string
required

e.g. e0

Body Params

enabled
boolean

Response

Feature not booked

Suggest Edits

Creates a new register device for the user.

If you want to create a new register device the Restriction CAN_CREATE_REGISTER_DEVICE needs to be true for the specified userId.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/userId/devices/register
curl --request POST \
  --url https://api.sipgate.com/v1/userId/devices/register
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/userId/devices/register' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/devices/register")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/userId/devices/register");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/devices/register"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Body Params

alias
string

Response

successful operation

idstring
aliasstring
typestring
onlineboolean
dndboolean
activePhonelinesarray
activeGroupsarray
credentialsobject
credentials.usernamestring
credentials.passwordstring
credentials.sipServerstring
credentials.outboundProxystring
credentials.sipServerWebsocketUrlstring
registeredarray
emergencyAddressIdstring
addressUrlstring
Suggest Edits

Returns all user device contingents

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/userId/devices/deviceId/contingents
curl --request GET \
  --url https://api.sipgate.com/v1/userId/devices/deviceId/contingents
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/userId/devices/deviceId/contingents' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/devices/deviceId/contingents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/userId/devices/deviceId/contingents");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/devices/deviceId/contingents"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

deviceId
string
required

e.g. y0

Response

successful operation

contingentsarray
Suggest Edits

Activate a sim card

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/userId/devices/deviceId/sim
curl --request POST \
  --url https://api.sipgate.com/v1/userId/devices/deviceId/sim
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/userId/devices/deviceId/sim' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/devices/deviceId/sim")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/userId/devices/deviceId/sim");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/devices/deviceId/sim"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

deviceId
string
required

e.g. y0

Body Params

simId
string

Response

successful operation

Suggest Edits

Deactivate a sim card

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://api.sipgate.com/v1/userId/devices/deviceId/sim
curl --request DELETE \
  --url https://api.sipgate.com/v1/userId/devices/deviceId/sim
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/userId/devices/deviceId/sim' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/devices/deviceId/sim")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/userId/devices/deviceId/sim");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/devices/deviceId/sim"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

deviceId
string
required

e.g. y0

Response

successful operation

Suggest Edits

Order a new SIM card

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/userId/devices/deviceId/sim/orders
curl --request POST \
  --url https://api.sipgate.com/v1/userId/devices/deviceId/sim/orders
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/userId/devices/deviceId/sim/orders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/devices/deviceId/sim/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/userId/devices/deviceId/sim/orders");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/devices/deviceId/sim/orders"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

deviceId
string
required

e.g. y0

Body Params

addressId
string
required

Response

User or device not found

Suggest Edits

groupfaxlines

 
Suggest Edits

Returns the caller ID for a group fax

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/groupfaxlines/faxlineId/callerid
curl --request GET \
  --url https://api.sipgate.com/v1/groupfaxlines/faxlineId/callerid
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/groupfaxlines/faxlineId/callerid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/groupfaxlines/faxlineId/callerid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/groupfaxlines/faxlineId/callerid");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/groupfaxlines/faxlineId/callerid"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

faxlineId
string
required

e.g. f0

Response

successful operation

valuestring
Suggest Edits

Returns all phone numbers for a group fax

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/groupfaxlines/faxlineId/numbers
curl --request GET \
  --url https://api.sipgate.com/v1/groupfaxlines/faxlineId/numbers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/groupfaxlines/faxlineId/numbers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/groupfaxlines/faxlineId/numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/groupfaxlines/faxlineId/numbers");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/groupfaxlines/faxlineId/numbers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

faxlineId
string
required

e.g. f0

Response

successful operation

itemsarray
Suggest Edits

Returns all groups

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/groups
curl --request GET \
  --url https://api.sipgate.com/v1/groups
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/groups' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/groups");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/groups"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

userId
string

e.g. w0

Response

successful operation

itemsarray
Suggest Edits

Returns all numbers routed to group

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/groups/groupId/numbers
curl --request GET \
  --url https://api.sipgate.com/v1/groups/groupId/numbers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/groups/groupId/numbers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/groups/groupId/numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/groups/groupId/numbers");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/groups/groupId/numbers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

groupId
string
required

e.g. g0

Response

successful operation

itemsarray
Suggest Edits

Returns all users in group

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/groups/groupId/users
curl --request GET \
  --url https://api.sipgate.com/v1/groups/groupId/users
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/groups/groupId/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/groups/groupId/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/groups/groupId/users");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/groups/groupId/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

groupId
string
required

e.g. g0

Response

successful operation

itemsarray
Suggest Edits

Returns information about the group voicemail

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/groups/groupId/voicemail
curl --request GET \
  --url https://api.sipgate.com/v1/groups/groupId/voicemail
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/groups/groupId/voicemail' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/groups/groupId/voicemail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/groups/groupId/voicemail");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/groups/groupId/voicemail"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

groupId
string
required

e.g. g0

Response

successful operation

itemsarray
 
Suggest Edits

Adds a quick dial number

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/numbers/quickdial
curl --request POST \
  --url https://api.sipgate.com/v1/numbers/quickdial
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/numbers/quickdial' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/numbers/quickdial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/numbers/quickdial");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/numbers/quickdial"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

userId
string
required
number
string

Response

successful operation

Suggest Edits

Validate a dial number

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/numbers/quickdial/validation/quickDialNumber
curl --request GET \
  --url https://api.sipgate.com/v1/numbers/quickdial/validation/quickDialNumber
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/numbers/quickdial/validation/quickDialNumber' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/numbers/quickdial/validation/quickDialNumber")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/numbers/quickdial/validation/quickDialNumber");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/numbers/quickdial/validation/quickDialNumber"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

quickDialNumber
string
required

e.g. 10

Response

successful operation

Suggest Edits

Delete a quick dial number

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://api.sipgate.com/v1/numbers/quickdial/numberId
curl --request DELETE \
  --url https://api.sipgate.com/v1/numbers/quickdial/numberId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/numbers/quickdial/numberId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/numbers/quickdial/numberId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/numbers/quickdial/numberId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/numbers/quickdial/numberId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

numberId
string
required

e.g. 1234

Response

successful operation

Suggest Edits

Changes a quick dial number

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/numbers/quickdial/quickdialId
curl --request PUT \
  --url https://api.sipgate.com/v1/numbers/quickdial/quickdialId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/numbers/quickdial/quickdialId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/numbers/quickdial/quickdialId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/numbers/quickdial/quickdialId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/numbers/quickdial/quickdialId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

quickdialId
string
required

Body Params

userId
string
required
number
string

Response

successful operation

Suggest Edits

Changes number settings, e.g. route to endpoint

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/numbers/numberId
curl --request PUT \
  --url https://api.sipgate.com/v1/numbers/numberId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/numbers/numberId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/numbers/numberId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/numbers/numberId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/numbers/numberId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

numberId
string
required

e.g. 1337

Body Params

endpointId
string
releaseForMnp
boolean
quickDial
boolean

Response

Number not found

Suggest Edits

Returns all user numbers

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/userId/numbers
curl --request GET \
  --url https://api.sipgate.com/v1/userId/numbers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/userId/numbers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/userId/numbers");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/numbers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Response

successful operation

itemsarray
Suggest Edits

password reset

 
Suggest Edits

Request a password change

 
posthttps://api.sipgate.com/v1/passwordreset
curl --request POST \
  --url https://api.sipgate.com/v1/passwordreset
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/passwordreset' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/passwordreset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/passwordreset");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/passwordreset"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

username
string

Response

successful operation

Suggest Edits

Change the password

 
posthttps://api.sipgate.com/v1/passwordreset/nonce
curl --request POST \
  --url https://api.sipgate.com/v1/passwordreset/nonce
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/passwordreset/nonce' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/passwordreset/nonce")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/passwordreset/nonce");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/passwordreset/nonce"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

nonce
string
required

Body Params

password
string
passwordRepeat
string

Response

successful operation

 
Suggest Edits

Returns number portings

Possible status codes:

100: Waiting for user fax
150: WBCI waiting for mail opt-in
160: WBCI opt-in hash generated
170: WBCI opt-in link clicked
200: Waiting for fax from current network operator
250: WBCI send
251: WBCI network error
252: WBCI EKP rejected
400: Porting accepted
450: Waiting for data exchange
451: Data exchange error
500: Porting complete
600: Porting cancelled

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/portings
curl --request GET \
  --url https://api.sipgate.com/v1/portings
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/portings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/portings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/portings");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/portings"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

itemsarray
Suggest Edits

Revoke a porting

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://api.sipgate.com/v1/portings/portingId
curl --request DELETE \
  --url https://api.sipgate.com/v1/portings/portingId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/portings/portingId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/portings/portingId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/portings/portingId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/portings/portingId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

portingId
int32
required

Response

successful operation

itemsarray
Suggest Edits

restrictions

 
Suggest Edits

Restrictions based on the users product

Get restrictions for actions the authenticated user can perform for himself or another user.

 
gethttps://api.sipgate.com/v1/restrictions
curl --request GET \
  --url https://api.sipgate.com/v1/restrictions
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/restrictions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/restrictions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/restrictions");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/restrictions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

userId
string

e.g. w0

restriction
array of strings

e.g. CAN_CREATE_REGISTER_DEVICE

Response

successful operation

itemsarray
 
Suggest Edits

Initiates a new call

DeviceId is only required if the caller parameter is a phone number and not a deviceId itself.
Use callerId to set a custom number that will be displayed to the callee.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/sessions/calls
curl --request POST \
  --url https://api.sipgate.com/v1/sessions/calls
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/sessions/calls' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/sessions/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/sessions/calls");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/sessions/calls"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

deviceId
string
required
caller
string
required
callee
string
required
callerId
string

Response

successful operation

sessionIdstring

User supplied invalid callee number<br>User supplied invalid caller number<br>DeviceId is required if caller is a phone number

Insufficient funds

User is not allowed to initiate call with given parameters

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/sessions/fax
curl --request POST \
  --url https://api.sipgate.com/v1/sessions/fax
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/sessions/fax' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/sessions/fax")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/sessions/fax");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/sessions/fax"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

faxlineId
string
required
recipient
string
required
filename
string
required
base64Content
string
required

Response

successful operation

sessionIdstring

Insufficient funds

Suggest Edits

Resend FAX

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/sessions/fax/resend
curl --request POST \
  --url https://api.sipgate.com/v1/sessions/fax/resend
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/sessions/fax/resend' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/sessions/fax/resend")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/sessions/fax/resend");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/sessions/fax/resend"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

faxId
string
required
faxlineId
string
required

Response

Insufficient funds

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/sessions/sms
curl --request POST \
  --url https://api.sipgate.com/v1/sessions/sms
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/sessions/sms' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/sessions/sms")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/sessions/sms");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/sessions/sms"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

smsId
string
required
recipient
string
required
message
string
required

Response

Insufficient funds

 
Suggest Edits

Returns sipgate.io URLs

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/settings/sipgateio
curl --request GET \
  --url https://api.sipgate.com/v1/settings/sipgateio
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/settings/sipgateio' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/settings/sipgateio")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/settings/sipgateio");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/settings/sipgateio"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

incomingUrlstring
outgoingUrlstring

sipgate.io feature not booked

Suggest Edits

Set sipgate.io URLs

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/settings/sipgateio
curl --request PUT \
  --url https://api.sipgate.com/v1/settings/sipgateio
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/settings/sipgateio' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/settings/sipgateio")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/settings/sipgateio");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/settings/sipgateio"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Body Params

incomingUrl
string
required
outgoingUrl
string
required

Response

sipgate.io feature not booked

Suggest Edits

translations

 
Suggest Edits

Returns sipgate translations

 
gethttps://api.sipgate.com/v1/translations/language
curl --request GET \
  --url https://api.sipgate.com/v1/translations/language
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/translations/language' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/translations/language")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/translations/language");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/translations/language"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

language
string
required

e.g. de_DE

Response

successful operation

Suggest Edits

Returns all users

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/users
curl --request GET \
  --url https://api.sipgate.com/v1/users
var request = require("request");

var options = { method: 'GET', url: 'https://api.sipgate.com/v1/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/users");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Response

successful operation

itemsarray
Suggest Edits

Returns a user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/users/userId
curl --request GET \
  --url https://api.sipgate.com/v1/users/userId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/users/userId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/users/userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/users/userId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/users/userId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Response

successful operation

idstring
firstnamestring
lastnamestring
emailstring
defaultDevicestring
adminboolean

User not found

Suggest Edits

Sets default device for given user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/users/userId/defaultdevice
curl --request PUT \
  --url https://api.sipgate.com/v1/users/userId/defaultdevice
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/users/userId/defaultdevice' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/users/userId/defaultdevice")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/users/userId/defaultdevice");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/users/userId/defaultdevice"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Body Params

deviceId
string
required

Response

successful operation

 
Suggest Edits

Returns all fax lines

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/userId/faxlines
curl --request GET \
  --url https://api.sipgate.com/v1/userId/faxlines
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/userId/faxlines' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/userId/faxlines");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Response

successful operation

itemsarray

Feature not booked

Suggest Edits

Creates a new faxline for the user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.sipgate.com/v1/userId/faxlines
curl --request POST \
  --url https://api.sipgate.com/v1/userId/faxlines
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.sipgate.com/v1/userId/faxlines' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.sipgate.com/v1/userId/faxlines");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Response

successful operation

idstring
aliasstring
taglinestring
canSendboolean
canReceiveboolean
Suggest Edits

Change faxline alias

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/userId/faxlines/faxlineId
curl --request PUT \
  --url https://api.sipgate.com/v1/userId/faxlines/faxlineId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/userId/faxlines/faxlineId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines/faxlineId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/userId/faxlines/faxlineId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines/faxlineId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

faxlineId
string
required

e.g. f0

Body Params

alias
string

Response

Faxline not found

Suggest Edits

delete faxline

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://api.sipgate.com/v1/userId/faxlines/faxlineId
curl --request DELETE \
  --url https://api.sipgate.com/v1/userId/faxlines/faxlineId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.sipgate.com/v1/userId/faxlines/faxlineId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines/faxlineId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.sipgate.com/v1/userId/faxlines/faxlineId");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines/faxlineId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

faxlineId
string
required

e.g. f0

Response

successful operation

Suggest Edits

Caller ID for faxline

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid
curl --request GET \
  --url https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

faxlineId
string
required

e.g. f0

Response

successful operation

valuestring

Feature not booked

Suggest Edits

Change caller ID for faxline

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid
curl --request PUT \
  --url https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines/faxlineId/callerid"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

faxlineId
string
required

e.g. f0

Body Params

value
string

Response

Feature not booked

Suggest Edits

Returns all phone numbers

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/userId/faxlines/faxlineId/numbers
curl --request GET \
  --url https://api.sipgate.com/v1/userId/faxlines/faxlineId/numbers
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/userId/faxlines/faxlineId/numbers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines/faxlineId/numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/userId/faxlines/faxlineId/numbers");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines/faxlineId/numbers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

faxlineId
string
required

e.g. f0

Response

successful operation

itemsarray
Suggest Edits

Change tagline for faxline

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.sipgate.com/v1/userId/faxlines/faxlineId/tagline
curl --request PUT \
  --url https://api.sipgate.com/v1/userId/faxlines/faxlineId/tagline
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.sipgate.com/v1/userId/faxlines/faxlineId/tagline' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/faxlines/faxlineId/tagline")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.sipgate.com/v1/userId/faxlines/faxlineId/tagline");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/faxlines/faxlineId/tagline"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

faxlineId
string
required

e.g. f0

Body Params

value
string

Response

Feature not booked

 
Suggest Edits

Returns the history of calls and voicemails

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.sipgate.com/v1/userId/history
curl --request GET \
  --url https://api.sipgate.com/v1/userId/history
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.sipgate.com/v1/userId/history' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.sipgate.com/v1/userId/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.sipgate.com/v1/userId/history");

xhr.send(data);
import requests

url = "https://api.sipgate.com/v1/userId/history"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

userId
string
required

e.g. w0

Query Params

phonelineId
string

e.g. p0

types
array of strings

e.g. VOICEMAIL

directions
array of strings

e.g. MISSED_INCOMING

offset
int32

e.g. 42

limit
int32

e.g. 23

Response

successful operation

itemsarray