> For the complete documentation index, see [llms.txt](https://dantonia.gitbook.io/test/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dantonia.gitbook.io/test/account/leases.md). # Leases ## ListTNLeases `GET` `https://api.opentact.org/rest/lease/tn` #### Headers | Name | Type | Description | | ------------- | ------ | ----------- | | Authorization | string | JWT\_TOKEN | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ### Code Example {% tabs %} {% tab title="cURL" %} ```bash ``` {% endtab %} {% endtabs %} ## 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 | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% tab title="404 " %} ``` ``` {% endtab %} {% endtabs %} ### Code Example {% tabs %} {% tab title="cURL" %} ```bash ``` {% endtab %} {% endtabs %} ## 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 \ 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

| {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% tab title="401 " %} ``` ``` {% endtab %} {% tab title="404 " %} ``` ``` {% endtab %} {% endtabs %} ### Code Example {% tabs %} {% tab title="cURL" %} ```bash ``` {% endtab %} {% endtabs %} ## 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 | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% tab title="404 " %} ``` ``` {% endtab %} {% endtabs %} ### Code Example {% tabs %} {% tab title="cURL" %} ```bash ``` {% endtab %} {% endtabs %} ## GetTNLeaseRouteByTN `GET` `https://api.opentact.org/rest/lease/tn/{tn}/route` Get lease route info by TN #### Path Parameters | Name | Type | Description | | ---- | ------- | ----------- | | tn | integer | \ | #### Headers | Name | Type | Description | | ------------- | ------ | --------------------------------------------- | | Authorization | string |

BEARER\_TOKEN
Provider

| {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% tab title="404 " %} ``` ``` {% endtab %} {% endtabs %} ### Code Example {% tabs %} {% tab title="cURL" %} ```bash ``` {% endtab %} {% endtabs %} ## Search `POST` `https://api.opentact.org/rest/tn/search` Advanced TN Search #### Query Parameters | Name | Type | Description | | ---- | ------- | ----------------------------------------------------------------------------------------------------- | | page | integer |

\ >= 1
Default: 1
Page number

| | size | integer |

\ \[ 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

| {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% tab title="404 " %} ``` ``` {% endtab %} {% endtabs %} ### Code Example {% tabs %} {% tab title="cURL" %} ```bash ``` {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://dantonia.gitbook.io/test/account/leases.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.