Leases

ListTNLeases

GET https://api.opentact.org/rest/lease/tn

Headers

Name	Type	Description
Authorization	string	JWT_TOKEN

200

Code Example

cURL

GetTNLeaseByUUID

GET https://api.opentact.org/rest/lease/tn/{uuid}

Path Parameters

Name	Type	Description
uuid	string

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	JWT_TOKEN

200

404

Code Example

cURL

ModifyTNLease

PATCH https://api.opentact.org/rest/lease/tn/{uuid}

Update a TN Lease

Path Parameters

Name	Type	Description
uuid	string

Headers

Name	Type	Description
Authorization	string	JWT_TOKEN
Content-Type	string	application/json

Request Body

Name	Type	Description
autorenew	boolean	Default: "true"
voice	string	Default:"true" Voice feature
fax	string	Fax feature
sms	boolean	SMS feature Default: "true"
mms	boolean	MMS feature
emergency	boolean	Emergency feature
tns	string	Array of numbers <double> non-empty Array of numbers to order
messaging_profile_uuid	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Messaging profile uuid
sip_connection	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIP Connection uuid
sip_control_app	string	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ SIP Control app uuid

200

401

404

Code Example

cURL

RemoveTNLeaseByUUID

DELETE https://api.opentact.org/rest/lease/tn/{uuid}

Path Parameters

Name	Type	Description
uuid	string

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	JWT_TOKEN

200

404

Code Example

cURL

GetTNLeaseRouteByTN

GET https://api.opentact.org/rest/lease/tn/{tn}/route

Get lease route info by TN

Path Parameters

Name	Type	Description
tn	integer	<int32>

Headers

Name	Type	Description
Authorization	string	BEARER_TOKEN Provider

200

404

Code Example

cURL

Search

POST https://api.opentact.org/rest/tn/search

Advanced TN Search

Query Parameters

Name	Type	Description
page	integer	<int32> >= 1 Default: 1 Page number
size	integer	<int32> [ 1 .. 100 ] Default: 10 How many items per page

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	JWT_TOKEN

Request Body

Name	Type	Description
pattern	string	non-empty Default: "*" Ten digit telephone number; end and % as wildcards. () implies match everything and % implies match that specific digit position. For Example: 233 will match all tns that have 233 in them such as 2345672334 as well as 2331231234. Another example would be 233%55 would match 2342337556 as well as 7892334559.
rateCenter	string	Rate center abbreviation ( e.g. WSHNGTNZN1)
city	string	Location Full Name filter for telephone number
province	string	Two-letter state or province abbreviation (e.g. IL, CA)
postalCode	string	Zip code filter for telephone numbers
abcSearch	boolean	Default: "false" If true, it will do search based on alphabates as well. If false, it will do numeric & X based search.
profile	string	Default: "US" TN Profile name

200

404

Code Example

cURL