SIP User

ListSIPUsersBySIPConnectionUUID

GET https://api.opentact.org/rest/sip/connection/{uuid}/users

Get SIP users by SIP connection

Path Parameters

Name	Type	Description
uuid	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name	Type	Description
X.Auth-Token	string	JWT_TOKEN

200

{
  "success": true,
  "payload": [
    {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "login": "string",
      "ha1": "string",
      "ha1b": "string",
      "remote_ip": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone_number": "string",
      "avatar": "string",
      "dob": "2019-08-24T14:15:22Z",
      "gender": "Agender",
      "groups": [
        {}
      ],
      "sip_connection": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "name": "string",
        "is_active": true,
        "tech_prefix": 0,
        "product": {},
        "subdomain": "string",
        "ip": "string",
        "port": 0,
        "class4_ingress_trunk_id": 0,
        "class4_ingress_trunk_settings": {},
        "class4_ingress_resource_ip_id": 0,
        "class4_egress_trunk_id": 0,
        "class4_egress_trunk_settings": {},
        "class4_egress_resource_ip_id": 0,
        "class4_trunk_prefix_id": 0,
        "tnleases": [],
        "sipusers": [],
        "sip_user_invites": [],
        "account": {},
        "created_by": {},
        "modified_by": {},
        "outbound_voice_profile": {}
      },
      "account": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "name": "string",
        "email": "string",
        "level": "ServiceAccount",
        "balance": 0,
        "class4_id": 0,
        "deleted_on": "2019-08-24T14:15:22Z",
        "time_zone": {},
        "users": [],
        "admin": {},
        "messaging_profile_default": {},
        "messaging_profiles": [],
        "addresses": []
      },
      "created_by": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "email": "string",
        "password": "string",
        "phone_number": "string",
        "first_name": "string",
        "last_name": "string",
        "avatar": "string",
        "gender": "Agender",
        "dob": "2019-08-24T14:15:22Z",
        "role": "Admin",
        "gmail_user_id": "string",
        "facebook_user_id": "string",
        "apple_user_id": "string",
        "wechat_user_id": "string",
        "deleted_on": "2019-08-24T14:15:22Z",
        "token": "string",
        "account": {}
      },
      "modified_by": {
        "created_on": "2019-08-24T14:15:22Z",
        "modified_on": "2019-08-24T14:15:22Z",
        "uuid": "string",
        "email": "string",
        "password": "string",
        "phone_number": "string",
        "first_name": "string",
        "last_name": "string",
        "avatar": "string",
        "gender": "Agender",
        "dob": "2019-08-24T14:15:22Z",
        "role": "Admin",
        "gmail_user_id": "string",
        "facebook_user_id": "string",
        "apple_user_id": "string",
        "wechat_user_id": "string",
        "deleted_on": "2019-08-24T14:15:22Z",
        "token": "string",
        "account": {}
      }
    }
  ]
}

401 Forbidden

{
  "success": false,
  "message": "string",
  "status": 401
}

404

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X GET "https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7/users" \
-H  "accept: application/json" \
-H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7/users', $headers);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
}

response = requests.get('https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7/users', headers=headers)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7/users', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7/users", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

CreateSIPUser

POST https://api.opentact.org/rest/sip/connection/{uuid}/Users

Create a new SIPUser

Headers

Name	Type	Description
X.Auth-Token	string	JWT_TOKEN
Content-Type	string	application/json

Request Body

Name	Type	Description
login	string	[ 7 .. 15 ] characters
password	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIP connection uuid
first_name	string	[ 1 .. 24 ] characters
last_name	string	[ 1 .. 24 ] characters
email	string	[ 6 .. 80 ] characters Remote SIP service IP
phone_number	number	[ 3 .. 16 ]
avatar	string	[ 10 .. 255 ] characters
dob	string	<date-time> Date of birth
gender	string	Enum: "Agender" "Androgyne" "Androgynous" "Bigender" "Cis" "Cisgender" "Cis Female" "Cis Male" "Cis Man" "Cis Woman" "Cisgender Female" "Cisgender Male" "Cisgender Man" "Cisgender Woman" "Female to Male" "FTM" "Gender Fluid" "Gender Nonconforming" "Gender Questioning" "Gender Variant" "Genderqueer" "Intersex" "Male to Female" "MTF" "Neither" "Neutrois" "Non-binary" "Other" "Pangender" "Trans" "Trans Female" "Trans Male" "Trans Man" "Trans Person" "Trans Woman" "Transfeminine" "Transgender" "Transgender Female" "Transgender Male" "Transgender Man" "Transgender Person" "Transgender Woman" "Transmasculine" "Transsexual" "Transsexual Female" "Transsexual Male" "Transsexual Man" "Transsexual Person" "Transsexual Woman" "Two-Spirit"
remote_ip	string	[ 7 .. 15 ] characters
sip_connection_uuid	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIP Connection uuid

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "login": "string",
    "ha1": "string",
    "ha1b": "string",
    "remote_ip": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "dob": "2019-08-24T14:15:22Z",
    "gender": "Agender",
    "groups": [],
    "sip_connection": {},
    "account": {},
    "created_by": {},
    "modified_by": {}
  }
}

201

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "login": "string",
    "ha1": "string",
    "ha1b": "string",
    "remote_ip": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "dob": "2019-08-24T14:15:22Z",
    "gender": "Agender",
    "groups": [
      {}
    ],
    "sip_connection": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "is_active": true,
      "tech_prefix": 0,
      "product": {},
      "subdomain": "string",
      "ip": "string",
      "port": 0,
      "class4_ingress_trunk_id": 0,
      "class4_ingress_trunk_settings": {},
      "class4_ingress_resource_ip_id": 0,
      "class4_egress_trunk_id": 0,
      "class4_egress_trunk_settings": {},
      "class4_egress_resource_ip_id": 0,
      "class4_trunk_prefix_id": 0,
      "tnleases": [],
      "sipusers": [],
      "sip_user_invites": [],
      "account": {},
      "created_by": {},
      "modified_by": {},
      "outbound_voice_profile": {}
    },
    "account": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "email": "string",
      "level": "ServiceAccount",
      "balance": 0,
      "class4_id": 0,
      "deleted_on": "2019-08-24T14:15:22Z",
      "time_zone": {},
      "users": [],
      "admin": {},
      "messaging_profile_default": {},
      "messaging_profiles": [],
      "addresses": []
    },
    "created_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "modified_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    }
  }
}

401 Forbidden

{
  "success": false,
  "message": "string",
  "status": 0
}

404 SIP connection not found

{
  "success": false,
  "message": "string",
  "status": 0
}

Code Example

cURL

curl -X POST "https://api.opentact.org/rest/sip/connection/user" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" -d "{\"login\":\"string\",\"password\":\"string\",\"first_name\":\"string\",\"last_name\":\"string\",\"email\":\"string\",\"phone_number\":\"string\",\"avatar\":\"string\",\"dob\":\"2020-10-29T14:01:11.604Z\",\"gender\":\"Agender\",\"remote_ip\":\"string\",\"sip_connection_uuid\":\"string\"}"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN',
    'Content-Type' => 'application/json'
);
$data = '{"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T14:01:11.604Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"}';
$response = Requests::post('https://api.opentact.org/rest/sip/connection/user', $headers, $data);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
    'Content-Type': 'application/json',
}

data = '{"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T14:01:11.604Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"}'

response = requests.post('https://api.opentact.org/rest/sip/connection/user', headers=headers, data=data)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/user', {
    method: 'POST',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T14:01:11.604Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"})
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T14:01:11.604Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"}`)
	req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sip/connection/user", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	req.Header.Set("Content-Type", "application/json")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

ModifySIPUser

PATCH https://api.opentact.org/rest/sip/connection/user/{uuid}

Modify SIPUser

Headers

Name	Type	Description
X.Auth-Token	string	JWT_TOKEN
Content-Type	string	application/json

Request Body

Name	Type	Description
login	string	[ 3 .. 60 ] characters
password	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIP connection uuid
first_name	string	[ 1 .. 24 ] characters
last_name	string	[ 1 .. 24 ] characters
email	string	[ 6 .. 80 ] characters Remote SIP service IP
phone_number	number	[ 3 .. 16 ]
avatar	string	[ 10 .. 255 ] characters
dob	string	<date-time> Date of birth
gender	string	Enum: "Agender" "Androgyne" "Androgynous" "Bigender" "Cis" "Cisgender" "Cis Female" "Cis Male" "Cis Man" "Cis Woman" "Cisgender Female" "Cisgender Male" "Cisgender Man" "Cisgender Woman" "Female to Male" "FTM" "Gender Fluid" "Gender Nonconforming" "Gender Questioning" "Gender Variant" "Genderqueer" "Intersex" "Male to Female" "MTF" "Neither" "Neutrois" "Non-binary" "Other" "Pangender" "Trans" "Trans Female" "Trans Male" "Trans Man" "Trans Person" "Trans Woman" "Transfeminine" "Transgender" "Transgender Female" "Transgender Male" "Transgender Man" "Transgender Person" "Transgender Woman" "Transmasculine" "Transsexual" "Transsexual Female" "Transsexual Male" "Transsexual Man" "Transsexual Person" "Transsexual Woman" "Two-Spirit"
remote_ip	string	[ 7 .. 15 ] characters
sip_connection_uuid	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIP Connection uuid

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "login": "string",
    "ha1": "string",
    "ha1b": "string",
    "remote_ip": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "dob": "2019-08-24T14:15:22Z",
    "gender": "Agender",
    "groups": [],
    "sip_connection": {},
    "account": {},
    "created_by": {},
    "modified_by": {}
  }
}

201

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "login": "string",
    "ha1": "string",
    "ha1b": "string",
    "remote_ip": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "dob": "2019-08-24T14:15:22Z",
    "gender": "Agender",
    "groups": [
      {}
    ],
    "sip_connection": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "is_active": true,
      "tech_prefix": 0,
      "product": {},
      "subdomain": "string",
      "ip": "string",
      "port": 0,
      "class4_ingress_trunk_id": 0,
      "class4_ingress_trunk_settings": {},
      "class4_ingress_resource_ip_id": 0,
      "class4_egress_trunk_id": 0,
      "class4_egress_trunk_settings": {},
      "class4_egress_resource_ip_id": 0,
      "class4_trunk_prefix_id": 0,
      "tnleases": [],
      "sipusers": [],
      "sip_user_invites": [],
      "account": {},
      "created_by": {},
      "modified_by": {},
      "outbound_voice_profile": {}
    },
    "account": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "email": "string",
      "level": "ServiceAccount",
      "balance": 0,
      "class4_id": 0,
      "deleted_on": "2019-08-24T14:15:22Z",
      "time_zone": {},
      "users": [],
      "admin": {},
      "messaging_profile_default": {},
      "messaging_profiles": [],
      "addresses": []
    },
    "created_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "modified_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    }
  }
}

401 Forbidden

{
  "success": false,
  "message": "string",
  "status": 0
}

404 SIP connection not found

{
  "success": false,
  "message": "string",
  "status": 0
}

Code Example

cURL

curl -X PATCH "https://api.opentact.org/rest/sip/connection/user/{uuid}" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" \
-d "{\"login\":\"string\",\"password\":\"string\",\"first_name\":\"string\",\"last_name\":\"string\",\"email\":\"string\",\"phone_number\":\"string\",\"avatar\":\"string\",\"dob\":\"2020-10-29T15:43:03.274Z\",\"gender\":\"Agender\",\"remote_ip\":\"string\",\"sip_connection_uuid\":\"string\"}"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN',
    'Content-Type' => 'application/json'
);
$data = '{"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T15:43:03.274Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"}';
$response = Requests::patch('https://api.opentact.org/rest/sip/connection/user/{uuid}', $headers, $data);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
    'Content-Type': 'application/json',
}

data = '{"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T15:43:03.274Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"}'

response = requests.patch('https://api.opentact.org/rest/sip/connection/user/%7Buuid%7D', headers=headers, data=data)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/user/{uuid}', {
    method: 'PATCH',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T15:43:03.274Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"})
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"login":"string","password":"string","first_name":"string","last_name":"string","email":"string","phone_number":"string","avatar":"string","dob":"2020-10-29T15:43:03.274Z","gender":"Agender","remote_ip":"string","sip_connection_uuid":"string"}`)
	req, err := http.NewRequest("PATCH", "https://api.opentact.org/rest/sip/connection/user/{uuid}", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	req.Header.Set("Content-Type", "application/json")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

GetSIPUserByUUID

GET https://api.opentact.org/rest/sip/connection/user/{uuid}

Get SIP user by UUID

Path Parameters

Name	Type	Description
uuid	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name	Type	Description
X.Auth-Token	string	JWT_TOKEN

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "login": "string",
    "ha1": "string",
    "ha1b": "string",
    "remote_ip": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "dob": "2019-08-24T14:15:22Z",
    "gender": "Agender",
    "groups": [],
    "sip_connection": {},
    "account": {},
    "created_by": {},
    "modified_by": {}
  }
}

401 Forbidden

{
  "success": false,
  "message": "string",
  "status": 401
}

404

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X GET "https://api.opentact.org/rest/sip/connection/user/{uuid}" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/sip/connection/user/{uuid}', $headers);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
}

response = requests.get('https://api.opentact.org/rest/sip/connection/user/%7Buuid%7D', headers=headers)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/user/{uuid}', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.opentact.org/rest/sip/connection/user/{uuid}", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

RemoveSIPUserByUUID

DELETE https://api.opentact.org/rest/sip/connection/user/{uuid}

Get SIP user by UUID

Path Parameters

Name	Type	Description
uuid	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name	Type	Description
X.Auth-Token	string	JWT_TOKEN

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "login": "string",
    "ha1": "string",
    "ha1b": "string",
    "remote_ip": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "dob": "2019-08-24T14:15:22Z",
    "gender": "Agender",
    "groups": [],
    "sip_connection": {},
    "account": {},
    "created_by": {},
    "modified_by": {}
  }
}

404 SIP user not found

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X DELETE "https://api.opentact.org/rest/sip/connection/user/{uuid}" \
-H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::delete('https://api.opentact.org/rest/sip/connection/user/{uuid}', $headers);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
}

response = requests.delete('https://api.opentact.org/rest/sip/connection/user/%7Buuid%7D', headers=headers)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/user/{uuid}', {
    method: 'DELETE',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("DELETE", "https://api.opentact.org/rest/sip/connection/user/{uuid}", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}