CallHistory and PhoneDetails management

This section of API document covers GET operations related to callhistory, unlocated phones, Manual config phones, non-tracked phones and tracked phones.

Get CallHistory Details

`v2/callhistorydetails`

http

CopyGET https://{CER-IP}/cerappservices/service/v2/callhistorydetails

Retrieve the Call History details in CER. The request should be made using the GET method. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request URI Param

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
offset	Integer	O	Path variable	0	Positive Integer	The number of calls after which the current response should list Call History.
limit	Integer	O	Path variable	500	Positive Integer to maximum of 2000	Total number of call to be provided on response.

Request Header

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
TrackingID	String	O	Path variable	Empty	Random UUID	Service name should be a 6 letter word from client side if not provided by default it will be CERAPP"+ underscore +A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference.

Request Body

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
FilterType	String	O	Path variable	All	FilterType allow 'All 'or 'Any 'String values.	Filter data with all (and) or any (or) condition.
DateFilter	String	O	Path variable	is	date filter validates with 1) is 2) isNot 3) isAfter 4) isBefore	Based on filter it will give Call History records.
erlname	String	O	Path variable	Null/Empty	ERL Name present in the server	Display results with the erlname 'Contains' filter.
Extension	String	O	Path variable	Null/Empty	Valid Extension Value	Display results with the Extension 'Contains' Filter.
CallDate	String	O	Path variable	Null/Empty	Valid date with below format (YYYY-MM-DD)	Display results with the Extension 'is' , 'isNot ', 'isBefore and 'isAfter' CallDate Filter.
RPELINMap	String	O	Path variable	Null/Empty	Valid Rout Point + ELIN value	Display results with the ELIN 'Contains' RPELINMap Filter.
Location	String	O	Path variable	Null/Empty	Valid Location Value	Display results with the Location 'Contains' Location Filter.
IsCallAcknowledged	String	O	Path variable	Null/Empty	Valid CallAcknowledged value 'Yes' or 'No'	Display results with the CallAknowledged with 'Yes' and 'No' IsCallAcknowledged Filter.
CallAcknowledgeDate	String	O	Path variable	Null/Empty	Valid Aknowledged date with format(YYYY-MM-DD)	Display results with the Extension 'is' , 'isNot ', 'isBefore and 'isAfter' CallAcknowledgeDate Filter.
Comments	String	O	Path variable	Null/Empty	Valid Comments value	Display results with the Comments 'Contains' Comments Filter.
Acknowledgeduser	String	O	Path variable	Null/Empty	Valid Acknowledged By value	Display results with the Acknowledged By User 'Contains' Acknowledgeduser Filter.

Response example

XML response

xml

Copy<CallHistoryResponse>
    <records>
        <record>
            <ERLName></ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>10:43:49 AM IST</CallTime>
            <CallDate>March 28, 2024</CallDate>
            <RPELINMap>10911.--6011543478</RPELINMap>
            <Location></Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl2</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>9:52:33 AM IST</CallTime>
            <CallDate>March 28, 2024</CallDate>
            <RPELINMap>10911.--6011543478</RPELINMap>
            <Location>loc1</Location>
            <IsCallAcknowledged>Yes</IsCallAcknowledged>
            <CallAcknowledgeTime>9:54:42 AM IST</CallAcknowledgeTime>
            <CallAcknowledgeDate>March 28, 2024</CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser>admin</Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl2</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>9:50:31 AM IST</CallTime>
            <CallDate>March 28, 2024</CallDate>
            <RPELINMap>10911.--6011543478</RPELINMap>
            <Location>loc1</Location>
            <IsCallAcknowledged>Yes</IsCallAcknowledged>
            <CallAcknowledgeTime>9:51:17 AM IST</CallAcknowledgeTime>
            <CallAcknowledgeDate>March 28, 2024</CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser>admin</Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:06:20 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:04:57 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:04:29 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:04:20 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:04:15 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:04:09 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
        <record>
            <ERLName>erl3</ERLName>
            <CallerExtension>1006</CallerExtension>
            <CallTime>7:04:04 PM IST</CallTime>
            <CallDate>March 26, 2024</CallDate>
            <RPELINMap>10911.--6011542346</RPELINMap>
            <Location>loc2</Location>
            <IsCallAcknowledged>No</IsCallAcknowledged>
            <CallAcknowledgeTime></CallAcknowledgeTime>
            <CallAcknowledgeDate></CallAcknowledgeDate>
            <Comments></Comments>
            <Acknowledgeduser></Acknowledgeduser>
        </record>
    </records>
    <paging>
        <prev>/cerappservices/service/v2/callhistorydetails?offset=0&amp;limit=10</prev>
        <next>/cerappservices/service/v2/callhistorydetails?offset=20&amp;limit=10</next>
        <offset>10</offset>
        <limit>10</limit>
        <count>89</count>
    </paging>
    <TrackingID>CERAPP_06b7c2f5-242d-4afc-99ba-c9e52304cde0</TrackingID>
</CallHistoryResponse>

Fields	Description
ErlName	ERL name of the call History record
CallerExtension	Extension of the phone
CallTime	Time at which the call occurred
CallDate	Date at which the call occurred
RPELINMap	Route Pattern--ELIN No
Location	Location of the Phone
IsCallAcknowledged	Call Acknowledged by the user
CallAcknowledgeTime	Time at which the call is Acknowledged
CallAcknowledgeDate	Date at which the call is Acknowledged
Comments	Comments provided by user
paging.next	URL of the next page of Call History
paging.prev	URL of the previous page of Call History
paging.offset	The starting value of the index for every page for List of Call History
paging.limit	The number of entries for the requested page of the list of Call History
paging.count	Total number of available Call History basis on query
TrackingID	Random UUID value

Get Manual Config Phone Details

`v2/manualconfigphones`

http

CopyGET https://{CER-IP}/cerappservices/service/v2/manualconfigphones

Retrieve the manual config phone details in CER. The request should be made using the GET method. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request URI Param

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
offset	Integer	O	Path variable	0	Positive Integer	The number of manually configured phones after which the current response should list manually configured phones.
limit	Integer	O	Path variable	500	Positive Integer to maximum of 2000	Total number of manually configured phones to be provided on response.
linenum	String	O	Path variable	Null/Empty	Valid Line Number	Search criteria includes the Phones Containing the Line Number.

Request Header

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
TrackingID	String	O	Path variable	Empty	Random UUID	Service name should be a 6 letter word from client side if not provided by default it will be CERAPP"+ underscore +A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference.

Response example

XML response

xml

Copy<ManualConfigPhoneResponse>
    <phones>
        <phone>
            <Extension>1000</Extension>
            <Type></Type>
            <Version></Version>
            <IPV4Address>10.77.34.15</IPV4Address>
            <IPV6Address>0:0:0:0:0:0:0:0</IPV6Address>
            <MACAddress></MACAddress>
            <ERLName>erl1</ERLName>
            <Location></Location>
        </phone>
        <phone>
            <Extension>1001</Extension>
            <Type></Type>
            <Version></Version>
            <IPV4Address>10.77.34.0</IPV4Address>
            <IPV6Address>3001:0:0:0:0:0:0:0</IPV6Address>
            <MACAddress></MACAddress>
            <ERLName>erl2</ERLName>
            <Location></Location>
        </phone>
        <phone>
            <Extension>1021</Extension>
            <Type></Type>
            <Version></Version>
            <IPV4Address></IPV4Address>
            <IPV6Address></IPV6Address>
            <MACAddress></MACAddress>
            <ERLName>erl1</ERLName>
            <Location></Location>
        </phone>
        <phone>
            <Extension>7034</Extension>
            <Type></Type>
            <Version></Version>
            <IPV4Address></IPV4Address>
            <IPV6Address></IPV6Address>
            <MACAddress></MACAddress>
            <ERLName>erl2</ERLName>
            <Location></Location>
        </phone>
        <phone>
            <Extension>7001</Extension>
            <Type></Type>
            <Version></Version>
            <IPV4Address>10.77.34.235</IPV4Address>
            <IPV6Address>3001:0:0:0:0:0:0:0</IPV6Address>
            <MACAddress></MACAddress>
            <ERLName>erl2</ERLName>
            <Location></Location>
        </phone>
    </phones>
    <paging>
        <limit>500</limit>
        <count>5</count>
        <offset>0</offset>
    </paging>
    <TrackingID>CERAPP_989f6853-a3ff-4b04-9875-9f431169e40a</TrackingID>
</ManualConfigPhoneResponse>

Fields	Description
Extension	Extension of the phone
Type	Type of the Phone
Version	Version of the Phone
IPV4Address	IPV4Address of the Phone
IPV6Address	IPV6Address of the Phone
MACAddress	MACAddress of the Phone
ERLName	ERLName
Location	Location
paging.next	URL of the next page of Manual Configured Phones
paging.prev	URL of the previous page of Manual Configured Phones
paging.offset	The starting value of the index for every page for list of Manual Configured Phones
paging.limit	The number of entries for the requested page of the list of Manual Configured Phones
paging.count	Total number of available Manual Configured Phones basis on query
TrackingID	Random UUID value

Get Non Tracked Phone Details

`v2/nontrackedphones`

http

CopyGET https://{CER-IP}/cerappservices/service/v2/nontrackedphones

Retrieve the non-tracked phones in CER. The request should be made using the GET method. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request URI Param

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
offset	Integer	O	Path variable	0	Positive Integer	The number of calls after which the current response should list NonTrackable phones.
limit	Integer	O	Path variable	500	Positive Integer to maximum of 2000	Total number of NonTrack phones to be provided on response.

Request Header

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
TrackingID	String	O	Path variable	Empty	Random UUID	Service name should be a 6 letter word from client side if not provided by default it will be CERAPP"+ underscore +A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference.

Response example

XML response

xml

Copy<NontrackPhonesResponse>
    <phoneDetails>
        <Phone>
            <IPv4address>None</IPv4address>
            <IPv6address>2001:34:34:34:0:0:0:222</IPv6address>
            <Extension>1009 </Extension>
            <Type>Cisco 9971</Type>
            <Devicename>SEP10BD18009FEB</Devicename>
            <Macaddress>10-bd-18-00-9f-eb</Macaddress>
        </Phone>
        <Phone>
            <IPv4address>10.61.65.101</IPv4address>
            <IPv6address>None</IPv6address>
            <Extension>1011 </Extension>
            <Type>Cisco IP Communicator</Type>
            <Devicename>CIPCNILESH</Devicename>
            <Macaddress>d2-9c-82-5e-d1-59</Macaddress>
        </Phone>
    </phoneDetails>
    <paging>
        <offset>0</offset>
        <limit>500</limit>
        <count>0</count>
    </paging>
    <TrackingID>CERAPP_845e47ea-5874-4e7c-aac6-38257c7f912b</TrackingID>
</NontrackPhonesResponse>

Fields	Description
Extension	Extension of the phone
Type	Type of the Phone
Devicename	Name of the device
IPV4Address	IPV4Address of the Phone
IPV6Address	IPV6Address of the Phone
paging.next	URL of the next page of Non-trackable Phones
paging.prev	URL of the previous page of Non-trackable Phones
paging.offset	The starting value of the index for every page for list of Non-trackable Phones
paging.limit	The number of entries for the requested page of the list of Non-trackable Phones
paging.count	Total number of available Non-trackable Phones basis on query
TrackingID	Random UUID value

Get Tracked Phone Details

`v2/trackedphones`

http

CopyGET https://{CER-IP}/cerappservices/service/v2/trackedphones

Retrieve the tracked phones in CER. The request should be made using the GET method. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code. Note: Tracked phones will not include Manual Config phones, since we have separte api for Manual Config phones.

Request URI Param

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
offset	Integer	O	Path variable	0	Positive Integer	The number of trackable phones after which the current response should list manually configured phones.
limit	Integer	O	Path variable	500	Positive Integer to maximum of 2000	Total number of trackable phones to be provided on response.

Request Header

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
TrackingID	String	O	Path variable	Empty	Random UUID	Service name should be a 6 letter word from client side if not provided by default it will be CERAPP"+ underscore +A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference.

Response example

XML response

xml

Copy<TrackPhonesResponse>
    <PhoneDetails>
        <Phone>
            <IPv4address>None</IPv4address>
            <IPv6address>2001:34:34:34:0:0:0:222</IPv6address>
            <Extension>1009 </Extension>
            <Type>Cisco 9971</Type>
            <Devicename>sep10bd18009feb</Devicename>
            <Macaddress>10-bd-18-00-9f-eb</Macaddress>
        </Phone>
        <Phone>
            <IPv4address>10.61.102.105</IPv4address>
            <IPv6address>None</IPv6address>
            <Extension>1011 </Extension>
            <Type>Cisco IP Communicator</Type>
            <Devicename>cipcnilesh</Devicename>
            <Macaddress>d2-9c-82-5e-d1-59</Macaddress>
        </Phone>
    </PhoneDetails>
    <paging>
        <offset>0</offset>
        <limit>5</limit>
        <count>2</count>
    </paging>
    <TrackingID>CERAPP_eb72c940-b6c1-46c9-963c-d520d1708c3d</TrackingID>
</TrackPhonesResponse>

Fields	Description
Extension	Extension of the phone
Type	Type of the Phone
Devicename	Name of the device
IPV4Address	IPV4Address of the Phone
IPV6Address	IPV6Address of the Phone
paging.next	URL of the next page of trackable Phones
paging.prev	URL of the previous page of trackable Phones
paging.offset	The starting value of the index for every page for list of trackable Phones
paging.limit	The number of entries for the requested page of the list of trackable Phones
paging.count	Total number of available trackable Phones basis on query
TrackingID	Random UUID value

Get Unlocated Phone Details

`v2/unlocatedphones`

http

CopyGET https://{CER-IP}/cerappservices/service/v2/unlocatedphones

Retrieve the unlocated phones in CER. The request should be made using the GET method. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request URI Param

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
offset	Integer	O	Path variable	0	Positive Integer	The number of unlocated phones after which the current response should list manually configured phones.
limit	Integer	O	Path variable	500	Positive Integer to maximum of 2000	Total number of unlocated phones to be provided on response.

Request Header

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
TrackingID	String	O	Path variable	Empty	Random UUID	Service name should be a 6 letter word from client side if not provided by default it will be CERAPP"+ underscore +A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference.

Request Body

Key	Type	Mandatory/Optional	Input Method	Default Value	Allowed Value	Description
FilterType	String	O	Path variable	All	FilterType allow 'All 'or 'Any 'String values.	Input "all" to indicate that only phones that match every criteria be selected (an AND search); select "any" to indicate that phones that match any search criteria be selected (an OR search).
PhoneIpv4Address	String	O	Request	NA	A full Ipv4 address or part of Ipv4 address	Search criteria includes the Phones 'Containing' the Ipv4 address.
PhoneIpv6Address	String	O	Request	NA	A full Ipv6 address or part of Ipv6 address	Search criteria includes the Phones 'Containing' the Ipv6 address.
erlname	String	O	Request	NA	String	Search criteria includes the Phones 'Containing' the ERLName as effective ERL.
PhoneMACAddress	String	O	Request	NA	String	Search criteria includes the Phones 'Containing' the Mac Address.
PhoneExtension	String	O	Request	NA	String	Search criteria includes the Phones 'Containing' the Extension.

Response example

XML response

xml

Copy<?xml version="1.0" encoding="UTF-8" ?>
    <RetrieveUnlocatedPhonesResponse>
        <PhoneDetails>
            <Phone>
                <CerServerGroup>CERServerGroup</CerServerGroup>
                <PhoneIPv4Address>2.2.14.32</PhoneIPv4Address>
                <PhoneIPv6Address>None</PhoneIPv6Address>
                <PhoneMACAddress></PhoneMACAddress>
                <PhoneExtension>12132</PhoneExtension>
                <AssignedERL></AssignedERL>
                <EffectiveERL>ERLL10</EffectiveERL>
                <ERLUsedInfo>Manually Configured Phone Extension</ERLUsedInfo>
            </Phone>
            <Phone>
                <CerServerGroup>CERServerGroup</CerServerGroup>
                <PhoneIPv4Address>2.2.14.31</PhoneIPv4Address>
                <PhoneIPv6Address>None</PhoneIPv6Address>
                <PhoneMACAddress></PhoneMACAddress>
                <PhoneExtension>12131</PhoneExtension>
                <AssignedERL></AssignedERL>
                <EffectiveERL>ERLL10</EffectiveERL>
                <ERLUsedInfo>Manually Configured Phone Extension</ERLUsedInfo>
            </Phone>
            <Phone>
                <CerServerGroup>CERServerGroup</CerServerGroup>
                <PhoneIPv4Address>2.2.14.30</PhoneIPv4Address>
                <PhoneIPv6Address>None</PhoneIPv6Address>
                <PhoneMACAddress></PhoneMACAddress>
                <PhoneExtension>12130</PhoneExtension>
                <AssignedERL></AssignedERL>
                <EffectiveERL>ERLL10</EffectiveERL>
                <ERLUsedInfo>Manually Configured Phone Extension</ERLUsedInfo>
            </Phone>
        </PhoneDetails>
        <Paging>
            <prev>/cerappservices/service/v2/unlocatedphones?offset=0&limit=2000</prev>
            <next>/cerappservices/service/v2/unlocatedphones?offset=4000&limit=2000</next>
            <offset>0</offset>
            <limit>2000</limit>
            <count>12500</count>
        </Paging>
        <TrackingID>CERAPP_7b09a160-bd6d-4bd3-a473-0a2705f46788</TrackingID>
    </RetrieveUnlocatedPhonesResponse>

Fields	Description
CerServerGroup	Servergroup to which the phone belongs
Extension	Extension of the phone
Type	Type of the Phone
Devicename	Name of the device
PhoneIPv4Address	IPV4Address of the Phone
PhoneIPv6Address	IPV6Address of the Phone
PhoneMACAddress	Mac Address of phone. Incase of Manual config phones the mac address can be null.
AssignedERL	Assigned ERL of the phone assigned via Unlocated phones page.
EffectiveERL	Phone's ERL can be assigned on various pages like switchport, unlocated, manualconfig, Ipsubnet, Access points, Effective ERL suggests among the assigned ERL which is effective according to call order
ERLUsedInfo	Phone belongs to which type
paging.next	URL of the next page of trackable Phones
paging.prev	URL of the previous page of trackable Phones
paging.offset	The starting value of the index for every page for list of trackable Phones
paging.limit	The number of entries for the requested page of the list of trackable Phones
paging.count	Total number of available trackable Phones basis on query
TrackingID	Random UUID value