Calls

/rest/calls

  • Get active calls
Example result
<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <item0 id="1" disconnected="" phone="123456789" active_call="1" received="0" address_id="" caller_address_id="" caller_no_address="0" staff_id="1" duration=" 00:00:00" address_name="" caller_address_name="" staff_name="Admin" date="2015-11-04 00:00:00" date_from="2015-11-04 10:35:48" date_to="" time_from="1900-01-10 10:35:48" time_to="" .../>
</xml>

POST/PUT

/rest/calls/call

  • Add new
Example request body
active_call=true&phone=123456789&dial=12
Example result
<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <url>.../rest/call/call/6</url>
</xml>

Possible values

If untermStrich finds a call for the same staff member, with the same phone and active_call which has no to date/time, it updates this entry. 1)

If untermStrich adds a new call entry, it sets the to date/time 2) of the last entry for the same staff member, if this last entry has no to date/time. (Fallback, if the last call was not ended correctly. Do not rely on this!)

Field Description Valid Values German Name
active_call Active call required,boolean (true, false) Ausgehender Anruf
dial Staff dial required,string Mitarbeiter Durchwahl
phone Phone number required,string Telefonnummer
staff_location Staff location ID 3) integer Mitarbeiter Standort ID
received Received (Picked up) boolean (true, false) Verbunden (Abgehoben)
Possible date/time from values
Use both fields (date/time) together. You may not set one without the other.
date_from Date from date Von - Datum
time_from Time from time Von - Zeit
disconnected Has disconnected (If true, forces update of last entry of the same staff member, with the same phone and active_call only.) boolean (true, false) Aufgelegt
Possible date/time to values
Priority: set_to, duration, date/time
set_to Set to date/time to now boolean (true, false) Aktuelles Datum/Uhrzeit
duration Set to date/time via a duration in seconds. integer Dauer
Use both fields (date/time) together. You may not set one without the other.
date_to Date to date Bis - Datum
time_to Time to time Bis - Zeit

1)
For 24h
2)
To the current date/time
3)
If not defined, untermStrich filters for 0 = No staff location