SIP User Group
GetSIPGroupsListApp
GET https://api.opentact.org/rest/app/group
Get the current user groups list
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"success": true,
"payload": [
{
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {}
},
"users": [
{}
]
}
]
}{
"success": false,
"message": "string",
"status": 400
}Code Example
curl -X GET "https://api.opentact.org/rest/app/group" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/app/group', $headers);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
}
response = requests.get('https://api.opentact.org/rest/app/group', headers=headers)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group', {
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN'
}
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://api.opentact.org/rest/app/group", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
CreateSIPUserGroupApp
POST https://api.opentact.org/rest/app/group
Create SIP user group
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
Request Body
name
string
[ 3 .. 80 ] characters
users
string
Array of strings List of sip_user_uuid's
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {}
},
"users": [
{
"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": {}
}
]
}
}{
"success": false,
"message": "string",
"status": 400
}Code Example
curl -X POST "https://api.opentact.org/rest/app/group" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"name\":\"string\",\"users\":[\"string\"]}"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN',
'Content-Type' => 'application/json'
);
$data = '{"name":"string","users":["string"]}';
$response = Requests::post('https://api.opentact.org/rest/app/group', $headers, $data);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
'Content-Type': 'application/json',
}
data = '{"name":"string","users":["string"]}'
response = requests.post('https://api.opentact.org/rest/app/group', headers=headers, data=data)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group', {
method: 'POST',
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({"name":"string","users":["string"]})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{"name":"string","users":["string"]}`)
req, err := http.NewRequest("POST", "https://api.opentact.org/rest/app/group", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
ModifySIPUserGroupApp
PATCH https://api.opentact.org/rest/app/group/{uuid}
Modify SIP user group
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
Request Body
name
string
[ 3 .. 80 ] characters
users
string
Array of strings List of sip_user_uuid's
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {},
"users": []
}
}{
"success": false,
"message": "string",
"status": 400
}Code Example
curl -X PATCH "https://api.opentact.org/rest/app/group/{uuid}" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"name\":\"string\",\"users\":[\"string\"]}"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN',
'Content-Type' => 'application/json'
);
$data = '{"name":"string","users":["string"]}';
$response = Requests::patch('https://api.opentact.org/rest/app/group/{uuid}', $headers, $data);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
'Content-Type': 'application/json',
}
data = '{"name":"string","users":["string"]}'
response = requests.patch('https://api.opentact.org/rest/app/group/%7Buuid%7D', headers=headers, data=data)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group/{uuid}', {
method: 'PATCH',
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({"name":"string","users":["string"]})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{"name":"string","users":["string"]}`)
req, err := http.NewRequest("PATCH", "https://api.opentact.org/rest/app/group/{uuid}", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
RemoveSIPUserGroupApp
DELETE https://api.opentact.org/rest/app/group/{uuid}
Delete SIP user group
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {},
"users": []
}
}{
"success": false,
"message": "string",
"status": 400
}{
"success": false,
"message": "string",
"status": 404
}Code Example
curl -X DELETE "https://api.opentact.org/rest/app/group/{uuid}" \
-H "accept: application/json" \
-H "X-Auth-HA1B-Token: HA1B_TOKEN"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN'
);
$response = Requests::delete('https://api.opentact.org/rest/app/group/{uuid}', $headers);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
}
response = requests.delete('https://api.opentact.org/rest/app/group/%7Buuid%7D', headers=headers)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group/{uuid}', {
method: 'DELETE',
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN'
}
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("DELETE", "https://api.opentact.org/rest/app/group/{uuid}", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
GetSIPUserGroupUsersApp
GET https://api.opentact.org/rest/app/group/{uuid}/users
Get SIP user group users
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"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": {}
}
]
}{
"success": false,
"message": "string",
"status": 400
}{
"success": false,
"message": "string",
"status": 404
}Code Example
curl -X GET "https://api.opentact.org/rest/app/group/{uuid}/users" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/app/group/{uuid}/users', $headers);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
}
response = requests.get('https://api.opentact.org/rest/app/group/%7Buuid%7D/users', headers=headers)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group/{uuid}/users', {
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN'
}
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://api.opentact.org/rest/app/group/{uuid}/users", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
AddSIPUsersToSIPUserGroupApp
POST https://api.opentact.org/rest/app/group/{uuid}/users
Add SIP users to group
Path Parameters
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUserGroup uuid
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
Content-Type
string
application/json
Request Body
users
string
Array of strings SIPUser uuid list
{
"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": {}
}
]
}{
"success": false,
"message": "string",
"status": 400
}{
"success": false,
"message": "string",
"status": 404
}Code Example
curl -X POST "https://api.opentact.org/rest/app/group/{uuid}/users" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"users\":[\"string\"]}"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN',
'Content-Type' => 'application/json'
);
$data = '{"users":["string"]}';
$response = Requests::post('https://api.opentact.org/rest/app/group/{uuid}/users', $headers, $data);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
'Content-Type': 'application/json',
}
data = '{"users":["string"]}'
response = requests.post('https://api.opentact.org/rest/app/group/%7Buuid%7D/users', headers=headers, data=data)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group/{uuid}/users', {
method: 'POST',
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({"users":["string"]})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{"users":["string"]}`)
req, err := http.NewRequest("POST", "https://api.opentact.org/rest/app/group/{uuid}/users", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
AddSIPUsersToSIPUserGroupApp
PATCH https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}
Add SIP user to group
Path Parameters
sip_user_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUser uuid
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUserGroup uuid
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {}
},
"users": [
{
"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": {}
}
]
}
}{
"success": false,
"message": "string",
"status": 400
}{
"success": false,
"message": "string",
"status": 404
}Code Example
curl -X PATCH "https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN'
);
$response = Requests::patch('https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}', $headers);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
}
response = requests.patch('https://api.opentact.org/rest/app/group/%7Buuid%7D/users/%7Bsip_user_uuid%7D', headers=headers)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}', {
method: 'PATCH',
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN'
}
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("PATCH", "https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
RemoveSIPUserFromSIPUserGroupApp
DELETE https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}
Remove SIP user from SIP User group
Path Parameters
sip_user_uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUser uuid
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SIPUserGroup uuid
Headers
X-Auth-HA1B-Token
string
HA1B_TOKEN
{
"success": true,
"payload": {
"created_on": "2019-08-24T14:15:22Z",
"modified_on": "2019-08-24T14:15:22Z",
"uuid": "string",
"name": "string",
"owner": {
"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": {}
},
"users": [
{
"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": {}
}
]
}
}{
"success": false,
"message": "string",
"status": 400
}{
"success": false,
"message": "string",
"status": 404
}Code Example
curl -X DELETE "https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}" \
-H "accept: application/json" -H "X-Auth-HA1B-Token: HA1B_TOKEN"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-HA1B-Token' => 'HA1B_TOKEN'
);
$response = Requests::delete('https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}', $headers);
import requests
headers = {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN',
}
response = requests.delete('https://api.opentact.org/rest/app/group/%7Buuid%7D/users/%7Bsip_user_uuid%7D', headers=headers)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}', {
method: 'DELETE',
headers: {
'accept': 'application/json',
'X-Auth-HA1B-Token': 'HA1B_TOKEN'
}
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("DELETE", "https://api.opentact.org/rest/app/group/{uuid}/users/{sip_user_uuid}", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-HA1B-Token", "HA1B_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)
}
Last updated
Was this helpful?