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. Websocket Events
  2. Event Definition

Call Destroyed

    1. UUID: Unique identifier for the call state.

    2. Created On: Timestamp indicating when the call state was created.

    3. Type: Indicates that it's a call state.

    4. Message: Describes the call state, mentioning "CallSCA in +18389999168 > 18382049000 - destroyed."

    5. Payload: Contains information about the call state, specifying the state as "destroyed" and the duration of 10 seconds.

    6. Call: Detailed information about the associated call.

      • UUID: Unique identifier for the call.

      • Direction: Indicates the direction of the call (incoming).

      • From: The originating number.

      • To: The destination number.

      • State: Indicates the state of the call (destroyed).

      • Duration: Duration of the call (10 seconds).

      • Type: Specifies the type of call as "CallSCA."

      • Created On: Timestamp indicating when the call was created.

      • Modified On: Timestamp indicating when the call was last modified.

      • Destroy On: Timestamp indicating when the call was destroyed.

      • Q850 Cause: Numeric code indicating the cause of hangup (16 in this case, "NORMAL_CLEARING").

      • Freeswitch Call State: Indicates the call state in FreeSWITCH ("HANGUP").

      • Freeswitch Channel State: Indicates the channel state in FreeSWITCH ("CS_REPORTING").

      • Stir Shaken Attest Level: Currently set as null.

      • TN: Information about the telephone number associated with the call.

      • SIP Control App: Information about the SIP control application associated with the call.

      • Account: Information about the account associated with the call, similar to the account details within the call object.

    7. Ref ID: Refers to the UUID of the associated call.

    8. Account: Information about the account associated with the call, similar to the account details within the call object.

    9. Modified On: Timestamp indicating when the call state was last modified.

      1. Log 1: Callback Attempt

        • Created On: Timestamp of log creation.

        • UUID: Unique identifier for the log entry.

        • Success: Indicates whether the log operation was successful (false in this case).

        • State: Current state of the log (queued).

        • Name: Describes the type of log (Callback).

        • Element: Contains details about the elements involved in the log.

        • Command: Information about the command executed (Callback).

        • Reason: Reason for the log operation (unknown in this case).

        • Tag: Tag associated with the log (null in this case).

      2. Log 2: Dial Attempt

        • Created On: Timestamp of log creation.

        • UUID: Unique identifier for the log entry.

        • Success: Indicates whether the log operation was successful (false in this case).

        • State: Current state of the log (failed).

        • Name: Describes the type of log (Dial).

        • Element: Contains details about the elements involved in the log.

        • Command: Information about the command executed (Dial).

        • Reason: Reason for the log operation ("[originate] ERR NO_USER_RESPONSE. no any destinations accept the call 1/1").

        • Tag: Tag associated with the log (null in this case).

        • Children: Additional details about the log operation, including a 'To' element, 'Error' element with a 'Say' and 'Record,' and specific settings such as timeout and maximum call attempts/duration.

      3. Log 3: Error Log

        • Created On: Timestamp of log creation.

        • UUID: Unique identifier for the log entry.

        • Success: Indicates whether the log operation was successful (false in this case).

        • State: Current state of the log (queued).

        • Name: Describes the type of log (Error).

        • Element: Contains details about the elements involved in the log.

        • Command: Information about the command executed (Error).

        • Reason: Reason for the log operation (unknown in this case).

        • Tag: Tag associated with the log (null in this case).

        • Children: Additional details about the log operation, including a 'Say' and 'Record' element.

          1. Log 4: Say Operation

            • Created On: Timestamp of log creation.

            • UUID: Unique identifier for the log entry.

            • Success: Indicates whether the log operation was successful (true in this case).

            • State: Current state of the log (success).

            • Name: Describes the type of log (Say).

            • Element: Contains details about the elements involved in the log, specifically a 'Say' element with the specified text.

            • Command: Information about the command executed (Say).

            • Reason: Reason for the log operation ("media played 1 times").

            • Tag: Tag associated with the log (null in this case).

          2. Log 5: Record Operation

            • Created On: Timestamp of log creation.

            • UUID: Unique identifier for the log entry.

            • Success: Indicates whether the log operation was successful (false in this case).

            • State: Current state of the log (queued).

            • Name: Describes the type of log (Record).

            • Element: Contains details about the elements involved in the log, including 'Tone' and 'Pause.'

            • Command: Information about the command executed (Record).

            • Reason: Reason for the log operation (unknown in this case).

            • Tag: Tag associated with the log ("voicemail" in this case).

          3. Log 6: Tone Operation

            • Created On: Timestamp of log creation.

            • UUID: Unique identifier for the log entry.

            • Success: Indicates whether the log operation was successful (true in this case).

            • State: Current state of the log (success).

            • Name: Describes the type of log (Tone).

            • Element: Contains details about the elements involved in the log.

            • Command: Information about the command executed (Tone).

            • Reason: Reason for the log operation ("tone '500' played 1 times").

            • Tag: Tag associated with the log (null in this case).

          4. Log 7: Pause Operation

            • Created On: Timestamp of log creation.

            • UUID: Unique identifier for the log entry.

            • Success: Indicates whether the log operation was successful (false in this case).

            • State: Current state of the log (queued).

            • Name: Describes the type of log (Pause).

            • Element: Contains details about the elements involved in the log.

            • Command: Information about the command executed (Pause).

            • Reason: Reason for the log operation (unknown in this case).

            • Tag: Tag associated with the log (null in this case).

          These logs reveal that, after the unsuccessful dial attempt, a Say operation was executed, followed by an attempt to record a voicemail message with a tone and a pause. The call was marked as offline with the reason "NO_USER_RESPONSE," indicating that there was no answer to the call.

PreviousExample EventNextExample Event

Last updated 1 year ago

Was this helpful?