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. Websocket Authentication

Authentication Response

Json Response

When you successfully log in to a WebSocket, the server typically responds with a confirmation or authentication message. The exact format of the response depends on the WebSocket server implementation and the application's requirements. However, I can provide you with a generic example.

{
    "uuid": "81cb534d-8924-46d8-a8c3-ff62fd0c16e8",
    "created_on": "2024-02-19T16:06:00.210Z",
    "type": "auth",
    "message": "WSS connection d7411060-f28c-443d-adef-0da909d43dbe@223.182.88.88 - success auth opentact@freefone.app",
    "payload": {
        "uuid": "d7411060-f28c-443d-adef-0da909d43dbe",
        "ip": "223.182.88.88",
        "user": {
            "created_on": "2022-04-26T05:37:15.707Z",
            "modified_on": "2023-09-22T15:07:46.346Z",
            "uuid": "e0b59b61-df04-4303-8040-e4929930cd71",
            "email": "opentact@freefone.app",
            "phone_number": "4528725",
            "first_name": "freefone",
            "wss_online": true,
            "last_name": "testacc",
            "avatar": null,
            "dob": null,
            "role": "User",
            "gender": null,
            "deleted_on": null
        },
        "account": {
            "created_on": "2022-04-26T05:37:15.707Z",
            "modified_on": "2023-12-04T05:57:32.303Z",
            "uuid": "58699aff-b3dd-46b6-b428-029cde3368a4",
            "email": "info@freefone.app",
            "name": "SOupra",
            "phone": "9038479977",
            "level": "Level2",
            "address1": "BT road",
            "address2": "eeeeeFFF",
            "zip_code": "700004",
            "city": "kolakata",
            "deleted_on": null,
            "disabled_on": null
        }
    },
    "account": {
        "created_on": "2022-04-26T05:37:15.707Z",
        "modified_on": "2023-12-04T05:57:32.303Z",
        "uuid": "58699aff-b3dd-46b6-b428-029cde3368a4",
        "email": "info@freefone.app",
        "name": "SOupra",
        "phone": "9038479977",
        "level": "Level2",
        "address1": "BT road",
        "address2": "eeeeeFFF",
        "zip_code": "700004",
        "city": "kolakata",
        "deleted_on": null,
        "disabled_on": null
    },
    "batch": null,
    "tn_order": null,
    "transaction": null,
    "tn_lease": null,
    "sms_brand": null,
    "tn": null,
    "call_asr": null,
    "tn_order_tn": null,
    "call_flow": null,
    "sms_campaign": null,
    "call": null,
    "sip_user": null,
    "call_record": null,
    "sip_domain": null,
    "ticket": null,
    "sms": null,
    "user": null,
    "modified_on": "2024-02-19T16:06:00.210Z",
    "delivery_report": []
}
PreviousHow to Authenticate to WSSNextExplanation of JSON response

Last updated 1 year ago

Was this helpful?