Call event schema
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
Property | Description |
---|---|
pyANI | Indicates the caller's device identifier. |
pyCallId | The unique call identifier. |
pyCallType | The call type, such as inbound, internal, and consult. |
pyEventName | The name of the agent state event, such as Login and Unknown. |
pyEventType | The type of the event. For example, if this is an agent event, then the type is AgentState event. |
pyMedia | Indicates the type of medium that sends the event, such as Phone. |
pyOtherDN | Indicates the other device's identifier. |
Previous topic Agent event schema Next topic PartyInfo event schema