Opentact
  • Opentact Introduction
  • KEY CONCEPTS
    • Basic Concept
      • Voice Capability
        • Managing Inbound Calls
      • SMS Capability
      • Number Capability
    • Phone Number
      • Voice Enablement
      • SMS Enablement
      • TN Profile
        • Blacklist Caller ID
        • Whitelist Caller ID
    • SIP Control APP
      • Specify Remote Call Control URL
      • Specify Dialplan XML
    • SIP Trunking
    • Messaging
      • Quick Start Guide
      • Prepare Phone Numbers for SMS
    • SIP Connection
      • Associate SIP Connection with Phone Number
    • SIP Domain
      • Send Outbound Call with SIP Domain
      • Receive Inbound Call to SIP User
        • Web Call
        • Zoiper SIP Client
    • SIP Users
      • Create a SIPUser
      • Create a SIPUserInvite
    • Telecom Data
  • Opentact API Documentation
    • Opentact API Integration
      • API Environment
      • Opentact API keys
      • Passing Authentication
      • Authentication API
        • Example API Call
        • Authentiction with Gmail
    • TN Profile
      • Add and Remove Blacklist to TN Profile
        • Example API Call
      • Add and Remove Whitelist to TN Profile
        • Example API Call
    • Phone Number
      • Order Phone Number
        • Example API Usage
      • Release a Number
        • Example API Usage
      • Get all Purchased Numbers
      • Number Search
        • Example API Usage
    • SIP Connection
      • Remove Number from SIP Connection
      • Get Number for a SIP Connection
      • Update SIP Connections
      • Create SIP Conenctions
      • Delete SIP Connections
      • List SIP Connections
      • Assign Number to a SIP Connection
    • Messaging
      • Enable SMS on Numbers
      • Disable SMS on Number
      • Send SMS with Pool
      • Send SMS with Number
      • Receiving SMS
      • Retrieve Message Detail Records
      • Receiving Messaging Events
    • Log Retrieval
      • Retrieve Call Log
      • Retrieve SMS Log
    • Calling
      • Bridge two calls
      • Make Single Call
      • Make Bulk Call
        • Example API Call
    • SIP Domain
      • Create SIP Domain
      • Create SIP User
      • Deleting SIP User
      • Modify SIP User
    • Websocket Event Subscription
      • Create Subscription
      • Remove Subscription
      • Get Subscribed Events
        • Example API Call
  • Websocket Events
    • Event Websocket
    • Websocket Authentication
      • How to Authenticate to WSS
      • Authentication Response
      • Explanation of JSON response
    • Event Definition
      • Call Initiated
        • Example Event
      • Call Ringing
        • Example Event
      • Call Live
        • Example Event
      • Callflow
        • Example Event
      • Call Hangup
        • Example Event
      • Call Destroyed
        • Example Event
      • Call Bridged
        • Example Event
      • Call Answered
        • Example Event
      • Account events
        • Example Event
      • SMS events
        • Example Event
      • TN events
        • Example Event
      • Record Events
        • Example Event
      • Transcript
        • Example Event
      • General Event Fields
      • Example Event
  • Opentact XML
    • Overview
    • <Call/>
    • <Callback/>
    • <Geo/>
    • <Scheduler/>
    • <Play/>
    • <Say/>
    • <Hangup/>
    • <Pause/>
    • <Record/>
    • </Dial>
    • </Gather>
    • <Answer/>
    • <Hold/>
    • <Tone/>
    • <Error/>
    • <Default/>
    • <Meta/>
    • <Curl/>
  • How to build your Opentact Application
    • Introduction
    • Inbound Call Control
    • Opentact Events
    • Call Flow Control
      • Specify CallFlow for TN
        • Dynamic Call Flow XML
        • Basic Workflow
      • Handle Inbound Call
    • Send and Receive SMS
      • Life Cycle of SMS Delivery
      • Real-time SMS over Websocket
      • Send SMS via Restful API
    • Send and Receive SIP Calls
      • Create SIP User
      • Make Calls Between SIP User
      • Receive Calls as SIP User
  • Regulatory Compliance
    • 10DLC FAQs
    • Stir Shaken
  • SIP Trunking
    • Use Opentact for SIP Trunking
  • Webhook Event
    • Introduction
    • Test Webhook with Opentact
    • Event Definition
Powered by GitBook
On this page

Was this helpful?

  1. Opentact API Documentation
  2. Phone Number
  3. Number Search

Example API Usage

Effortlessly Explore Numbers Based on Your Criteria

Opentact offers a user-friendly number search functionality that allows you to find the perfect numbers tailored to your requirements. Utilize the search feature to narrow down options by region, specific numbers, prefixes, rate centers, types, or enabled features.

For instance, the example below illustrates a straightforward number search for two phone numbers. This intuitive approach ensures that you have the flexibility to pinpoint and acquire numbers that align precisely with your communication needs. Opentact makes the process of finding and selecting numbers straightforward, providing you with a seamless experience.

Explore the number search process with this API call:


 curl -X 'POST' \
  'https://api.opentact.org/rest/tn/search' \
  -H 'accept: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY\
  -H 'Content-Type: application/json' \
  -d '{
  "country": "US",
  "type": "long_code",
  "state": "NY",
  "rate_center": "SALMON",
  "npa": 208,
  "nxx": 291
}'

Request URL
https://api.opentact.org/rest/tn/search

Upon completing your search, anticipate the following response:

 Response code: 200
 {
  "success": true,
  "payload": {
    "Total": 100,
    "take": 1,
    "skip": 0,
    "data": [
      {
        "tn": 18336221777,
        "type": "long_code",
        "features": [
          "voice",
          "sms"
        ],
        "price": {
          "created_on": "2024-01-16T14:15:49.048Z",
          "modified_on": "2024-01-16T14:15:49.048Z",
          "uuid": "90c2e069-44c1-4f1a-9619-540432378122",
          "description": "Default US long code tier1 price",
          "country": {
            "created_on": "2024-01-16T14:15:49.048Z",
            "modified_on": "2024-01-16T14:15:49.048Z",
            "a2": "US",
            "a3": "USA",
            "name": "UNITED STATES",
            "official_state_name": "The United States of America",
            "country_code": 1,
            "national_code": null,
            "code": "+1"
          },
          "type": "long_code",
          "tier": "tier1",
          "access": "public",
          "nrc": 0,
          "mrc": 0.002,
          "features": {
            "undefined": {
              "created_on": "2024-01-16T14:15:49.048Z",
              "modified_on": "2024-01-16T14:15:49.048Z",
              "uuid": "90c2e069-44c1-4f1a-9619-540432378122",
              "description": "Default US long code tier1 voice feature price",
              "type": "long_code",
              "tier": "tier1",
              "access": "public",
              "feature": "voice",
              "nrc": 0,
              "mrc": 0.008,
              "per_usage_in": 0.002,
              "per_usage_out": 0.05
            }
          }
        },
        "tier": "tier1"
      }
    ]
  }
}
PreviousNumber SearchNextSIP Connection

Last updated 1 year ago

Was this helpful?