Search ITSP Templates

Retrieves the ITSP (Internet Telephony Service Provider) templates grouped by country. One call returns both levels: the country list and the ITSP operators under each country.

Request URL

POST {base_url}/uc-cconfig/api/v1/itsp-templates/search

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
country No String The country to filter by. An empty value returns all countries.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<ITSP_Search_Result> The list of countries with their ITSP templates.
ITSP_Search_Result
Parameter Type Description
items Array<Country_ITSP_Group> The list of countries and the ITSP templates under each country.
Country_ITSP_Group
Parameter Type Description
country String The country or region.
itsps Array<ITSP_Template_Option> The ITSP operators in this country, deduplicated by name.
ITSP_Template_Option
Parameter Type Description
id String The ID of the ITSP template. You can use this ID to query the template details with the Get an ITSP Template interface.
name String The name of the ITSP operator, which is used for display only.

Example

Request example

POST /uc-cconfig/api/v1/itsp-templates/search HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyNDQzMiwiaWF0IjoxNzkzNjAyODMyLCJqdGkiOiJjZDVjN2Q4MC03OTFhLTQyNzUtYWU0OC1mMDk2MGJmODQ3MWEiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6IjgyZDEwYjFmLTVmZjctNDA0Yy1hNTJjLWMxMGRhNmYwMjMwZSIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.mS238_tWj41VCildUy10XC_-XN9PdstqCI_ETD0Zbcmi5offX9kPcQmdEcCWesLgXRqv1X1tinKrWTRRXT6HWSvMTb0vA6bWwoCEQFbEsZqfRWoJjBBV5FHI6VX7_PuxvlYsnk__YDoUU37Z9aqvTzusS9O4cTEf7AKZuM39t3kSxCievsDDSM8FjSM3kmCreQ4AfP39tPgOcTJbsIRNLjSvO-W7anCcCiS4eupUT92E5vZzNfZPV_QlyJlbGM-S0RO-cVhC7G1Mq6W9TchNBjgFx4qbSlOxpnZXTTH23iOzD_uF3ju5KpFy7XrggwjIllfhLg4Rm7j5ElE-VKtrYg
x-tenant-code: jint
Content-Type: application/json

Response example

HTTP/1.1 200 OK
{
  "requestId": "ec5884e00b85918ee493857d2abd8b5e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "items": [
      {
        "country": "GB",
        "itsps": [
          {
            "id": "342579787488825344",
            "name": "E2E Full Peer3456"
          }
        ]
      },
      {
        "country": "South Africa",
        "itsps": [
          {
            "id": "342557461560954880",
            "name": "lumjtest2"
          }
        ]
      },
      {
        "country": "United Kingdom",
        "itsps": [
          {
            "id": "347914815244603392",
            "name": "Voiceflex818"
          }
        ]
      },
      {
        "country": "United States",
        "itsps": [
          {
            "id": "355632484538388480",
            "name": "Bandwidth"
          },
          {
            "id": "355632483447869440",
            "name": "SIPTRUNK"
          },
          {
            "id": "350532576978407424",
            "name": "Telnyx  825"
          },
          {
            "id": "350155191376416768",
            "name": "Telnyx824-peer"
          }
        ]
      }
    ]
  }
}