CallerID and Meteor Extensions Schema

From XAP Automation
Jump to: navigation, search

CallerID v1.2.04

These describe a set of classes for sending CallerID information as xAP messages. Meteor specific extensions are included later in the schema definition to deal with additional Meteor hardware functionality.

CID.Incoming

Class = CID.Incoming

CID.Incoming
{
Type=[Voice | Ringback | MessageWaiting]
--- Mandatory call type
DateTime=YYYYMMDDHHMMSS
--- Mandatory
Phone=01234567890
--- Mandatory
RNNumber=[Available | Unavailable | Withheld]
--- Mandatory (Reason No Number)
Formatted_Date=22 January 2003
--- Optional
Formatted_Time=21:27:00
--- Optional
Name=["Calling Line Name" | INTERNATIONAL | PAYPHONE]
--- Optional (not currently supported so will mostly be blank)
RNName=[Available | Unavailable | Withheld]
--- Optional (Reason No Name)
}

CID.Meteor

Class = CID.Meteor

Incoming.CallWithCID
{
Type=[Voice | Ringback | MessageWaiting]
--- Mandatory call type
Phone=01234567890
--- Mandatory
DateTime=YYYYMMDDHHMMSS
--- Mandatory
RNNumber=[Unavailable | Withheld | Available]
--- Mandatory (Reason No Number)
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional
Name=["Calling Line Name" | INTERNATIONAL | PAYPHONE]
--- Optional (not currently supported so will mostly be blank)
RNName=[Available | Unavailable | Withheld]
--- Optional (Reason No Name)
}
Incoming.CallWithNoCID
{
Type=[Voice | Ringback | MessageWaiting]
--- Mandatory call type
DateTime=YYYYMMDDHHMMSS
--- Optional
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional
}
Incoming.Ring
{
Rings="Number of rings"
--- Mandatory
}
Incoming.CallAnswered
{
DateTime=YYYYMMDDHHMMSS
--- Mandatory
Phone=01234567890
--- Mandatory
RNNumber=[Unavailable | Withheld | Available]
--- Mandatory (Reason No Number)
Rings="Number of rings"
--- Mandatory
Duration=HH:MM:SS
--- Mandatory (duration of event. ie time taken to answer the call) 
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional 
Name=["Calling Line Name" | INTERNATIONAL | PAYPHONE]
--- Optional (not currently supported so will mostly be blank)
RNName=[Available | Unavailable | Withheld]
--- Optional (Reason No Name)
}
Incoming.CallComplete
{
DateTime=YYYYMMDDHHMMSS
--- Mandatory
Duration=HH:MM:SS
--- Mandatory (duration of event - ie total call time)
Phone=01234567890
--- Mandatory
RNNumber=[Unavailable | Withheld | Available]
--- Mandatory (Reason No Number)
Rings="Number of rings"
--- Mandatory
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional 
Name=["Calling Line Name" | INTERNATIONAL | PAYPHONE]
--- Optional (not currently supported so will mostly be blank)
RNName=[Available | Unavailable | Withheld]
--- Optional (Reason No Name)
}
Incoming.DigitPressed
{
Digit="Digit Keyed"
--- Mandatory
} 
Incoming.CallNotAnswered
{
DateTime=YYYYMMDDHHMMSS
--- Mandatory 
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional
Phone=01234567890
--- Optional
RNNumber=[Unavailable | Withheld | Available]
--- Optional (Reason No Number)
Rings="Number of rings"
--- Optional
Duration=HH:MM:SS
--- Optional (duration of event eg total ringing time)
Name=["Calling Line Name" | INTERNATIONAL | PAYPHONE]
--- Optional (not currently supported so will mostly be blank)
RNName=[Available | Unavailable | Withheld]
--- Optional (Reason No Name)
}

And for outgoing calls

Outgoing.CallInitiated
{
DateTime=YYYYMMDDHHMMSS
--- Mandatory
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional
}
Outgoing.DigitPressed
{
Digit="Digit Keyed"
--- Mandatory
}
Outgoing.CallComplete
{
DateTime=YYYYMMDDHHMMSS
--- Mandatory
Duration=HH:MM:SS
--- Mandatory (duration of event eg total call time)
Phone=01234567890
--- Mandatory (may be blank if no number was dialled) 
Formatted_Time=11:36:00
--- Optional
Formatted_Date=30 December 2002
--- Optional
}