Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Call event schema

Updated on October 6, 2021

This schema describes the call status change. Use these properties to handle the call state events, such as Alerting, Ringing, and Established.

{
    "definitions": {},
    "$schema": "http://json-schema.org/draft-06/schema#",
    "type": "object",
    "$id": "http://pega.com/OpenCTI/Events/CallEvent.json",
    "properties": {
        "pyANI": {
            "description": "The ANI.",
            "title": "The pyANI Schema.",
            "$id": "/properties/pyANI",
            "default": "",
            "examples": [
                "16175551212"
            ],
            "type": "string"
        },
        "pyCallId": {
            "description": "The Call Identifier.",
            "title": "The pyCallId Schema.",
            "$id": "/properties/pyCallId",
            "default": "",
            "examples": [
                "4953"
            ],
            "type": "string"
        },
        "pyCallType": {
            "description": "The type of call.",
            "title": "The pyCallType Schema.",
            "$id": "/properties/pyCallType",
            "default": "",
            "examples": [
                "INTERNAL"
            ],
            "enum": ["INTERNAL", "INBOUND",             "OUTBOUND", "CONSULT",
 "UNKNOWN"],
        },
        "pyEventName": {
            "description": "The call state.",
            "title": "The pyEventName Schema.",
            "$id": "/properties/pyEventName",
            "default": "",
            "examples": [
                "Alerting"
            ],
            "enum": ["Abandoned", "Alerting", "Connected",           
 "Disconnected", "Established", "Held",             "Initiated", "Retrieved"], 
        },
        "pyEventType": {
            "description": "The type of event.",
            "title": "The pyEventType Schema.",
            "$id": "/properties/pyEventType",
            "default": "",
            "examples": [
                "CallStateEvent"
            ],
            "type": "string"
        },
        "pyMedia": {
            "description": "The media type.",
            "title": "The pyMedia Schema.",
            "$id": "/properties/pyMedia",
            "default": "",
            "examples": [
                "Phone"
            ],
                "type": "string"
        },
        "pyOtherDN": {
            "description": "The other device number             involved in the
 call.",
            "title": "The pyOtherDN Schema.",
            "$id": "/properties/pyOtherDN",
            "default": "",
            "examples": [
                "1615551212"
            ],
            "type": "string"
        }
    }
    }            

The following table describes the properties that are used in this schema:

Properties in the call event schema

PropertyDescription
pyANIIndicates the caller's device identifier.
pyCallIdThe unique call identifier.
pyCallTypeThe call type, such as inbound, internal, and consult.
pyEventNameThe name of the agent state event, such as Login and Unknown.
pyEventTypeThe type of the event. For example, if this is an agent event, then the type is AgentState event.
pyMediaIndicates the type of medium that sends the event, such as Phone.
pyOtherDNIndicates the other device's identifier.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us