Number Search

TN search

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

This allows you to search for long code numbers and toll-free numbers

Query Parameters

Name	Type	Description
Country*	String	This field should provide the country of the number
Npa*	Number	Npa is used for both long code and toll-free numbers to search the list of available numbers in NPA
Rate center*	String	This field is used to search the number using the city.
State*	String	This field contains the state of the country provided on the header for number search.
Type*	String	This field is used to search numbers by using long code and toll-free options.
Pattern*	Number	This field is used to search the number ending with the pattern available in the number search. pattern is used only in toll-free numbers.
Nxx*	Number	Npa is used in long code a number to search the list of available numbers in the nxx

Headers

Name	Type	Description
Authorization*	String	JWT_Token
Content-Type	String	Application/json

200: OK Number search found

{
  
  "success": true,
  "payload": {
    "total": 100,
    "take": 1,
    "skip": 0,
    "data": [
      {
        "tn": 18336221777,
        "type": "long_code",
        "features": [
          "voice",
          "sms"
        ],
        "price": {
          "mrc": 0.05,
          "nrc": 0,
          "features": [
            {
              "feature": "sms",
              "mrc": 0.1,
              "nrc": 0.05,
              "per_usage_in": 0,
              "per_usage_out": 0.05
            },
            {
              "feature": "voice",
              "mrc": 0,
              "nrc": 0,
              "per_usage_in": 0.001,
              "per_usage_out": 0.005
            }
          ]
        }
      }
    ]
  }
}

403: Forbidden Forbidden error

    {
  "success": false,
  "message": "string",
  "status": 500,
  "meta": "string",
  "fields": {
    "params.to": {
      "message": "invalid integer number",
      "value": "qwerty123456789"
    }
  }
}

500: Internal Server Error Internal server error

{
  "success": false,
  "message": "string",
  "status": 500,
  "meta": "string",
  "fields": {
    "params.to": {
      "message": "invalid integer number",
      "value": "qwerty123456789"
    }
  }
}

404: Not Found number Not found

{
 {
  "success": false,
  "message": "string",
  "status": 500,
  "meta": "string",
  "fields": {
    "params.to": {
      "message": "invalid integer number",
      "value": "qwerty123456789"
    }
  }
}
}