Skip to main content


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

PartyInfo event schema

Updated on October 6, 2021

The PartyInfo event provides an updated list of all the parties participating in the call.

{
    "definitions": {},
    "$schema": "http://json-schema.org/draft-06/schema#",
    "type": "object",
    "$id": "http://pega.com/OpenCTI/Events/PartyInfoEvent.json",
    "properties": {
        "pyCallId": {
            "description": "The Call Identifier.",
            "title": "The pyCallId Schema.",
            "$id": "/properties/pyCallId",
            "default": "",
            "examples": [
                "4954"
            ],
            "type": "string"
        },
        "pyEventName": {
            "description": "The name of the event.",
            "title": "The pyEventName Schema.",
            "$id": "/properties/pyEventName",
            "default": "",
            "examples": [
                "PartyInfo"
            ],
            "type": "string"
        },
        "pyEventType": {
            "description": "The type of event.",
            "title": "The pyEventType Schema.",
            "$id": "/properties/pyEventType",
            "default": "",
            "examples": [
                "PartyInfoEvent"
            ],
            "type": "string"
        },
        "pyMedia": {
            "description": "The media type.",
            "title": "The pyMedia Schema.",
            "$id": "/properties/pyMedia",
            "default": "",
            "examples": [
                "Phone"
            ],
            "type": "string"
        },
        "pyThisDN": {
            "description": "The device number of the monitored device.",
            "title": "The pyThisDN Schema.",
            "$id": "/properties/pyThisDN",
            "default": "",
            "examples": [
                "8808"
            ],
            "type": "string"
        },
        "pyParties": {
            "$id": "/properties/pyParties",
            "items": {
                "$id": "/properties/pyParties/items",
                "type": "object",
                "properties": {
                    "pyDN": {
                    "description": "The device number of the party.",
                    "title": "The pyDN Schema.",
                    "$id": "/properties/pyParties/items/properties/pyDN",
                    "default": "",
                    "examples": [
                        "16175551212"
                        ],
                    "type": "string"
                    }
                }
            },
            "type": "array"
        }
    }
    }        

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

Properties in the PartyInfo schema

PropertyDescription
pyCallIdThe unique call identifier.
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.
pyThisDNThe device number or extension that is used to receive the event.
pyPartiesHolds the information of the pyDN and pyDNState properties.

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