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
  • RESTful Endpoints:
  • Authentication:
  • Accessing More Information:

Was this helpful?

  1. Opentact API Documentation

Opentact API Integration

Overview

Opentact offers HTTP or HTTPS endpoints that adhere to RESTful principles, utilizing JSON for data consumption and return. Integrating with Opentact's API allows seamless communication and interaction with the platform's features and services. Below are key details for leveraging Opentact's API effectively:

RESTful Endpoints:

  • Protocol:

    • Opentact's API endpoints support both HTTP and HTTPS, providing flexibility and security for data transmission.

  • Data Format:

    • JSON is the preferred format for both request payloads and response data. This standardized approach simplifies data interchange between your application and Opentact.

Authentication:

  • API Key Requirement:

    • Most HTTP/HTTPS endpoints necessitate the inclusion of an API Key in the request header. This key serves as a secure and authenticated means of accessing Opentact's API.

  • Authorization Headers:

    • Additional details regarding API Keys and Authorization headers can be found in the Authentication section. It is crucial to understand and implement proper authentication practices for a secure and authorized API interaction.

Accessing More Information:

  • Authentication Section:

    • For in-depth insights into API Keys, Authorization headers, and secure authentication practices, refer to the dedicated Authentication section. This section provides comprehensive guidance on ensuring the security and integrity of your API requests.

By adhering to RESTful principles, utilizing JSON data exchange, and incorporating the required API Key in your requests, you can seamlessly integrate your applications with Opentact's API, unlocking the full potential of its features and services.

For detailed information on API Keys and Authentication headers, please explore the Authentication section.

Glossary

TERM

Description

Numbers

DIDs and toll-free numbers that can be purchased and managed in order to receive calls (inbound/origination)

Messaging

Short Message Service (SMS) text messaging that can be sent using Long Code, Toll Free Number, and Short Code

Connections

Provisions SIP trunks

Call Control Applications

Configure webhooks and voice settings for call control. This resource provisions SIP trunks for call control use cases.

Reports

Access Call and Messaging Detail Records, and generate usage reports

PreviousTelecom DataNextAPI Environment

Last updated 1 year ago

Was this helpful?