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
  • Opentact Webhook IPs
  • Event Associating Entity
  • SIP Domain
  • SIP User

Was this helpful?

  1. How to build your Opentact Application

Opentact Events

Opentact Webhook IPs

If you use an ACL or Firewall on your network, make sure you whitelist the following subnet(s):

72.21.26.35

Event Associating Entity

You may choose to receive all events related to the SIP users and DIDs of your own account, or you may choose to receive specific events type for the entities under your accounts.

  • SIP Domain

  • SIP User

  • SIP Auth IP

  • AIP Auth Domain

  • DID

SIP Domain

SIP Domain encompasses all SIP users, SIP Auth IP, and SIP Auto Hostname within the specified domain. Here are the associated event categories for each element:

Entity

Event Category

SIP Users

Inbound SIP Call and Outbound SIP Calls

SIP Auth IP

Inbound SIP Call

SIP Auth Hostname

Inbound SIP Call

SIP User

Instead of subscribing to all events within the entire domain, you can selectively choose specific SIP users to receive Inbound SIP Call and Outbound SIP Calls events.

  • Inbound SIP Call Event: Triggered when any calls are directed to a SIP user.

  • Outbound SIP Call Event: Activated when the SIP user initiates an outbound call, either to another SIP User or to a real phone number in the PSTN network.

SIP Auth IP and SIP Auth Hostname: External SIP switches that are authorized to send calls to the SIP Domain. The SIP domain then forwards these calls using the Termination product defined in the Outbound Voice Profile associated with the SIP Domain.

Two Legs of Each Call:

  1. Inbound Call Leg: The call session from the external SIP server to Opentact.

  2. Outbound Call Leg: The call session from Opentact to Opentact's Downstream PSTN providers.

  • If a call originates from an Auth SIP Switch to the Opentact Domain, it triggers an Inbound call event.

  • If the call successfully reaches Opentact's Downstream provider, an outbound call event is generated.

  • If a call to Opentact Domain encounters failure, such as insufficient account balance, the event indicates a "failed" status along with the reason for the failure.

Phone Number: A DID can be VoIP-activated, SMS-enabled, or both.

  • Inbound Call Event: Triggered when there are inbound calls to a VoIP-activated Phone Number.

  • SMS Events: Activated when a Phone Number is SMS-enabled, capturing both inbound and outbound SMS traffic.

  • Phone Number Order Event: When a Phone Number is successfully ordered within Opentact, an associated event is generated. This event signifies the successful completion of the ordering process for a new Phone Number within the Opentact platform.

PreviousInbound Call ControlNextCall Flow Control

Last updated 1 year ago

Was this helpful?