SIP User Invite

CreateSIPUserInvite

POST https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites

Create new SIP connection invite

Path Parameters

Name

Type

Description

sip_connection_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

Content-Type

string

application/json

Request Body

Name

Type

Description

name

string

[ 3 .. 255 ] characters SIP domain name

expired_on

string

<date-time>

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "expired_on": "2019-08-24T14:15:22Z",
    "token": "string",
    "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": {}
    }
  }
}

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

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

Code Example

curl -X POST "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" \
-d "{\"name\":\"string\",\"expired_on\":\"2020-10-29T15:58:21.802Z\"}"

<?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 = '{"name":"string","expired_on":"2020-10-29T15:58:21.802Z"}';
$response = Requests::post('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites', $headers, $data);

import requests

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

data = '{"name":"string","expired_on":"2020-10-29T15:58:21.802Z"}'

response = requests.post('https://api.opentact.org/rest/sip/connection/%7Bsip_connection_uuid%7D/invites', headers=headers, data=data)

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites', {
    method: 'POST',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"name":"string","expired_on":"2020-10-29T15:58:21.802Z"})
});

package main

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

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"name":"string","expired_on":"2020-10-29T15:58:21.802Z"}`)
	req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites", 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)
}

ListSIPUserInvites

GET https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites

Get SIP connection invites

Path Parameters

Name

Type

Description

sip_connection_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

{
  "success": true,
  "payload": [
    {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "expired_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "sip_connection": {},
      "account": {},
      "created_by": {},
      "modified_by": {}
    }
  ]
}

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

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

Code Example

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

<?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/{sip_connection_uuid}/invites', $headers);

import requests

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

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

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_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/sip/connection/{sip_connection_uuid}/invites", 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)
}

ModifySIPUserInvite

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

Modify SIP connection invite

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}$

sip_connection_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

Content-Type

string

application/json

Request Body

Name

Type

Description

name

string

[ 3 .. 255 ] characters SIP domain name

expired_on

string

<date-time>

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "expired_on": "2019-08-24T14:15:22Z",
    "token": "string",
    "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": {}
    }
  }
}

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

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

Code Example

curl -X PATCH "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" \
-d "{\"name\":\"string\",\"expired_on\":\"2020-10-29T16:11:25.706Z\"}"

<?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 = '{"name":"string","expired_on":"2020-10-29T16:11:25.706Z"}';
$response = Requests::patch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}', $headers, $data);

import requests

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

data = '{"name":"string","expired_on":"2020-10-29T16:11:25.706Z"}'

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

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}', {
    method: 'PATCH',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"name":"string","expired_on":"2020-10-29T16:11:25.706Z"})
});

package main

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

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"name":"string","expired_on":"2020-10-29T16:11:25.706Z"}`)
	req, err := http.NewRequest("PATCH", "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{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)
}

RemoveSIPUserInviteByUUID

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

Remove SIP user invite

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}$

sip_connection_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

{
  "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": {}
      }
    }
  ]
}

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

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

Code Example

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

<?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/{sip_connection_uuid}/invites/{uuid}', $headers);

import requests

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

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

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}', {
    method: 'DELETE',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_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/sip/connection/{sip_connection_uuid}/invites/{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)
}

PreviousSIP Connection NextSIP User

Last updated 4 years ago

Was this helpful?

SIP User Invite

CreateSIPUserInvite

POST https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites

Create new SIP connection invite

Path Parameters

Name

Type

Description

sip_connection_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

Content-Type

string

application/json

Request Body

Name

Type

Description

name

string

[ 3 .. 255 ] characters SIP domain name

expired_on

string

<date-time>

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "expired_on": "2019-08-24T14:15:22Z",
    "token": "string",
    "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": {}
    }
  }
}

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

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

Code Example

curl -X POST "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" \
-d "{\"name\":\"string\",\"expired_on\":\"2020-10-29T15:58:21.802Z\"}"

<?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 = '{"name":"string","expired_on":"2020-10-29T15:58:21.802Z"}';
$response = Requests::post('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites', $headers, $data);

import requests

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

data = '{"name":"string","expired_on":"2020-10-29T15:58:21.802Z"}'

response = requests.post('https://api.opentact.org/rest/sip/connection/%7Bsip_connection_uuid%7D/invites', headers=headers, data=data)

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites', {
    method: 'POST',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"name":"string","expired_on":"2020-10-29T15:58:21.802Z"})
});

package main

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

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"name":"string","expired_on":"2020-10-29T15:58:21.802Z"}`)
	req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites", 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)
}

ListSIPUserInvites

GET https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites

Get SIP connection invites

Path Parameters

Name

Type

Description

sip_connection_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

{
  "success": true,
  "payload": [
    {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "expired_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "sip_connection": {},
      "account": {},
      "created_by": {},
      "modified_by": {}
    }
  ]
}

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

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

Code Example

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

<?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/{sip_connection_uuid}/invites', $headers);

import requests

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

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

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_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/sip/connection/{sip_connection_uuid}/invites", 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)
}

ModifySIPUserInvite

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

Modify SIP connection invite

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}$

sip_connection_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

Content-Type

string

application/json

Request Body

Name

Type

Description

name

string

[ 3 .. 255 ] characters SIP domain name

expired_on

string

<date-time>

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "expired_on": "2019-08-24T14:15:22Z",
    "token": "string",
    "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": {}
    }
  }
}

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

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

Code Example

curl -X PATCH "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" \
-d "{\"name\":\"string\",\"expired_on\":\"2020-10-29T16:11:25.706Z\"}"

<?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 = '{"name":"string","expired_on":"2020-10-29T16:11:25.706Z"}';
$response = Requests::patch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}', $headers, $data);

import requests

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

data = '{"name":"string","expired_on":"2020-10-29T16:11:25.706Z"}'

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

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}', {
    method: 'PATCH',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"name":"string","expired_on":"2020-10-29T16:11:25.706Z"})
});

package main

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

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"name":"string","expired_on":"2020-10-29T16:11:25.706Z"}`)
	req, err := http.NewRequest("PATCH", "https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{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)
}

RemoveSIPUserInviteByUUID

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

Remove SIP user invite

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}$

sip_connection_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

{
  "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": {}
      }
    }
  ]
}

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

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

Code Example

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

<?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/{sip_connection_uuid}/invites/{uuid}', $headers);

import requests

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

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

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

fetch('https://api.opentact.org/rest/sip/connection/{sip_connection_uuid}/invites/{uuid}', {
    method: 'DELETE',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_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/sip/connection/{sip_connection_uuid}/invites/{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)
}

PreviousSIP Connection NextSIP User

Last updated 4 years ago

Was this helpful?