Change Log

Version 1.16.0

• changed Android part in push

Version 1.15.0

• added GET /api/partner/user/(user-uuid)/calls
• added dialplan v2 profiles in Dialplan API
• added clip_number to (parallel|linear|cyclic) actions in POST /api/dialplan/v2 and POST /api/dialplan/v2/(uuid)
• added time_zone parameter to a rule in POST /api/rule and POST /api/rule/(rule-id)
• updated GET /api/rule/(rule-id) to also return the time_zone of a rule
• added time_zone to time filter in POST /api/dialplan/v2 and POST /api/dialplan/v2/(uuid)
• added GET /api/partner/user/event and DELETE /api/partner/user/event

Version 1.14.0

• added call-notification to Rule API

Version 1.13.0

• added POST /api/announcement/(uuid)/text2speech

Version 1.12.0

• added blf_pickup to service field for CDR’s in partner API
• Rule email & push notifications can contain templates

Version 1.11.0

• added call filter service ivr in POST /api/partner/callfilter/(user-uuid)
• added push-notification for android and iOS to Rule API
• added examples for CDR’s in partner API

Version 1.10.0

• added ignore_ip_whitelisting flag to POST /api/partner/user/(user-uuid) and GET /api/partner/user/(user-uuid)

Version 1.9.0

• added baddocument to /api/idcardcheck & validation field to GET /api/user

Version 1.8.0

• added Authorization: Bearer <sid> header support
• added /api/idcardcheck section in Internal API.
• added POST /api/user/idcard.
• added validation field to GET /api/user

Version 1.7.0

• increased the max. count of sensor data/action items per request in GET /api/sensor/(uuid)/data
• added conference-offline error to POST /api/conference/(uuid)/member

Version 1.6.0

• added paging functionality to GET /api/partner/user
• added paging functionality to GET /api/partner/phone

Version 1.5.0

• added GET /api/partner/user
• added GET /api/partner/phone
• added GET /api/partner/usergroup/credit

Version 1.4.0

• added custom notification feature: POST /api/sip/(sip-user)/notify
• added date_start and date_end fields to POST /api/dialplan/v2

Version 1.3.0

• added parent & root field to GET /api/partner/cdr/(phone)
• change POST /api/dialplan/v2 time field logic

Version 1.2.0

• added P_Asserted_Identity field to POST /api/partner/phone/(user-uuid) and GET /api/partner/user/(user-uuid)
• added BLF (Busy Lamp Field) Feature for SIP-Accounts GET /api/sip/(sip-user)/blf and POST /api/sip/(sip-user)/blf

Version 1.1.1

• JSON structure fix in GET /api/partner/user/(user-uuid)

Version 1.1.0

• added Interactive Voice Response API API
• moved dialplan calls to a new section Dialplan API
• added dialplan v2 calls in Dialplan API
• added GET /api/partner/emergency/(user-uuid)
• added POST /api/partner/emergency/(user-uuid)
• added on_hold_music field to GET /api/phone and POST /api/phone

Version 1.0.39

• added Calling Name Delivery API

Version 1.0.38

• added POST /api/partner/enterprise
• added GET /api/partner/enterprise.
• added POST /api/partner/enterprise/(uuid).
• added DELETE /api/partner/enterprise/(uuid).
• added prefix flag to Usergroups
• added CDR event in partner api
• added GET /api/partner/cdr/event.
• added DELETE /api/partner/cdr/event.

Version 1.0.37

• added timeout property to POST /api/device/session

Version 1.0.36

• several formatting fixes
• adjusted Rules API

Version 1.0.35

• added email field to POST /api/user/delete
• added partner section for sensor /api/partner/sensor
• added new api event partner_sensor_data & partner_sensor_action

Version 1.0.34

• update GET /api/rule/(rule-id) to also return the declaration of a rule
• remove GET /api/rule/(rule-id)/declaration
• remove POST /api/rule/(rule-id)/activate
• remove POST /api/rule/(rule-id)/deactivate

Version 1.0.33

• add CDR (call detail record) support to partner related phones
• add usergroup feature
• add usergroup field to GET /api/user and GET /api/partner/user
• add hot billing support (zone filter)
• add callback feature, POST /api/dialplan/callback
• add cti_via field to GET /api/dialplan and POST /api/dialplan
• add callback as a call filter service operator
• add API for rule engine
  • add POST /api/rule to create a new rule
  • add GET /api/rule to fetch all rules
  • add DELETE /api/rule/(rule-id) to delete a specific rule
  • add GET /api/rule/(rule-id) to fetch a specific rule
  • add POST /api/rule/(rule-id) to update the state or name of a rule
• add user events for rule engine
  • add rule_new event in case a new rule was created
  • add rule_delete event in case a rule was deleted
  • add rule_update event in case a rule has changed

Version 1.0.32

• add sensor capability octets

Version 1.0.31

• add partner proxy authentication (POST /api/session)

Version 1.0.30

• add wait_timeout field to task csp.
• add replaced status to task csp response and to sensor_action event.
• add info field to GET /api/signup/verification/(verification) and POST /api/signup/verification.
• add chat, uuid and time fields to iOS chat_message push notification.

Version 1.0.29

• add model, profile fields to GET /api/tag/(uuid)/object for object of types sensor to enable distinguishing sensor types in the overview
• add profile, recv_after_send fields to GET /api/sensor/(uuid).
• add tamper_detect, fault_detect fields to GET /api/sensor/(uuid). These fields can be cleared using POST /api/sensor/(uuid)
• read access to a sensor is now sufficient to initiate sensor actions (POST /api/sensor/(uuid)/action)
• modify the content format of sensor capabilities energy, voltage, current and power
• renamed sensor capability door to open (see GET /api/sensor/(uuid))
• several new sensor capabilities (see GET /api/sensor/(uuid))

Version 1.0.28

• add streaming download of sensor data and sensor action data in CSV format (GET /api/sensor/(uuid)/data/(xxx).csv and GET /api/sensor/(uuid)/action/(xxx).csv)
• add bulk upload of sensor data via POST /api/sensor/(uuid)/data

Version 1.0.27

• add chat media messages, types image and audio
• add call filter (GET /api/partner/callfilter/(user-uuid), POST /api/partner/callfilter/(user-uuid) and DELETE /api/partner/callfilter/(user-uuid))
• add concurrent call limit
• add country_code to POST /api/signup/user, GET /api/user, POST /api/user, POST /api/partner/user/(user-uuid)
• add call_enable, dialplan_enable and play_announcement_only to POST /api/partner/phone/(user-uuid)

Version 1.0.26

• added battery_ok, battery_status and mains_power fields to GET /api/sensor/(uuid)
• added color_rgb sensor and actor capabilities

Version 1.0.25

• modify Apple push notifications to match “silent notification” style
• add recv_interval field to GET /api/sensor/(uuid)

Version 1.0.24

• rename sensor action capability flip to onoff. Add sensor data capabilities onoff and text. Add both sensor data and actor capability button
• add new internal statistic calls

Version 1.0.23

• add recv_time field to GET /api/sensor/(uuid)

Version 1.0.22

• Support gzip encoding for various API calls (via HTTP Accept-Encoding header)
• remove binary parameter for GET /api/jeye/(host)

Version 1.0.21

• new sensor data capabilities: light, humidity, door

Version 1.0.20

• add order parameter to GET /api/volume/(uuid)/commit
• added clarification section on the use of UUIDs

Version 1.0.19

• add volume commit log feature: GET /api/volume/(uuid)/commit, commit field in file events file_new, file_modify, file_delete and commit field in several POST /api/volume/(uuid)/... and DELETE /api/volume/(uuid)/... calls
• add owner field to all GCM notifications

Version 1.0.18

• add user profile pictures (POST /api/user/picture and DELETE /api/user/picture, GET /api/user/(user-id)/picture/(size)/(xxx).jpg, extensions to GET /api/user, GET /api/user/(user-uuid), GET /api/user/link)
• add display_name property to support user-controlled name display (GET /api/user and POST /api/user, GET /api/user/(user-uuid), GET /api/user/link, POST /api/signup/user, GET /api/invitation/(invitation), GET /api/partner/user/(user-uuid))
• add GET /api/language call to inform the clients about languages supported by the system
• add concurrent-access failure status for POST /api/phone
• add user section to GET /api/chat

Version 1.0.17

• add event system filters (POST /api/event/filter and DELETE /api/event/filter)
• add new sensor capabilities energy, voltage, current, power, frequency
• add generic object type xobject (GET /api/xobject/(uuid) and POST /api/xobject)
• add metadata events object_metadata and user_metadata

Version 1.0.16

• add metadata information to objects and users

Version 1.0.15

• add time fields to GET /api/chat/(uuid)/message, event chat_message and push notification
• lower limit for parameter psize is now 80 for various ipquality calls

Version 1.0.14

• add event user_modify
• add dscp, psize, ptime fields to GET /api/ipquality/(uuid) and POST /api/ipquality
• add description field to GET /api/sip and POST /api/sip, POST /api/sip/(sip-user), sip_new, sip_modifiy events
• add fax_ident, fax_header fields to GET /api/user and POST /api/user, POST /api/fax/(uuid)/send
• add object links and corresponding events object_link_new object_link_delete
• add physical location fields to GET /api/user and POST /api/user
• change process of obtaining and unlocking a phone number (GET /api/phone and POST /api/phone), remove phone offer process
• call-through feature, POST /api/dialplan/callthrough
• call-reverse feature, POST /api/dialplan/callreverse, callreverse_enable flag in GET /api/dialplan and POST /api/dialplan. Replace incoming_call event with dialplan_callreverse_start and dialplan_callreverse_stop events. New push event dialplan_callreverse_start, dialplan_callreverse_stop.
• chat API and events
• call API and events, call_enable flag for GET /api/phone and POST /api/phone
• add license section / field to GET /api/box/(uuid) and POST /api/box/(uuid), task license in device API
• sensor API and events
• add “share tags” to allow for sharing with other individual users: fields share_read, share_write and share_propagate in GET /api/user, GET /api/user/link
• enable use of download id (did) authentication for GET /api/fax/(uuid)/(page)/(xxx).png
• possibility to download ipquality results in CSV format: GET /api/ipquality/(uuid)/result/(xxx).csv

Version 1.0.13

• presentation API and events
• added email field to POST /api/password
• add deleted field to GET /api/user/link, GET /api/user/(user-uuid)
• internal API for MWI (message waiting indication) support
• support for Apple Push (APS), Google Cloud Messaging (GCM)
• additional status already-invited for POST /api/user/invitation
• add dial_prefix, clip_number and clir_enable fields to GET /api/dialplan and POST /api/dialplan
• read privileges are now sufficient to create a comment with POST /api/object/(uuid)/comment
• added sip_status_code, fax_error_code fields to GET /api/fax/(uuid) and to fax_report event
• add callreverse_enable field to GET /api/dialplan and POST /api/dialplan
• added l_n, rfac results to GET /api/ipquality/(uuid)/result

Version 1.0.12

• session authentication (POST /api/session) and password recovery (POST /api/password/recovery) is now possible with the username or the e-mail address
• added already-exist failure condition to POST /api/signup/verification, POST /api/signup/user, POST /api/user since e-mail addresses now have to be unique
• added internal invitations (i.e. invitations directed specifically to another known user) to GET /api/user/invitation and POST /api/user/invitation
• added accept section to POST /api/user/link
• added events invitation_new and invitation_delete for internal invitations
• added know section to GET /api/user/link (this enables link suggestions for the current user)
• added play_announcement_only flag to GET /api/phone and POST /api/phone
• added feature section to GET /api/user, GET /api/partner/user/(user-uuid) and POST /api/partner/user/(user-uuid)
• added DELETE /api/signup/verification/(verification)
• added mute_default parameter to GET /api/conference/(uuid) and POST /api/conference/(uuid)
• added GET /api/user/(user-uuid) to get information about other users
• added GET /api/fax/(fax-uuid)/report/(report-uuid)/(xxx).pdf (fax sender report in PDF format)

Version 1.0.11

• modified ipquality duration to only accept values >= 10
• dialplan and sip API and events
• dialplan_enable flag for GET /api/phone and POST /api/phone

Version 1.0.10

• added hw_version and sw_version fields to POST /api/device/session and GET /api/box/(uuid), and to box_online event
• added reload an upgrade tasks to device API

Version 1.0.9

• box and ipquality API
• device API
• new events box_online, box_offline
• new call POST /api/user/delete to permanently delete a user account
• added possibility to permanently delete a user to POST /api/partner/user/(user-uuid)
• internal system statistics via GET /api/jeye/(host)
• add purge parameter to various DELETE calls that delete objects
• add DELETE /api/trash call to purge the objects in trash tag
• add (optional) purge field to object_delete event
• add trash_purge event
• add newsletter field to GET /api/user, POST /api/user, POST /api/signup/user

Version 1.0.8

• added pin parameter to change phone PIN to POST /api/user
• added inline parameter to binary download methods to control HTTP Content-Disposition header

Version 1.0.7

• added download id (did) authentication to session an various API calls.

Version 1.0.6

• added GET /api/volume/(uuid)/folder/(folder-uuid)/(xxx) to retrieve folder contents as a compressed ZIP file

Version 1.0.5

• added POST /api/partner/user/(user-uuid) to allow partner to disable/enable user accounts

Version 1.0.4

• added partner authentication to POST /api/session
• added partner-controlled sign-up process, involves changes in: POST /api/signup/verification GET /api/signup/verification/(verification) POST /api/signup/user GET /api/session (partner field) POST /api/session (partner field) POST /api/password (partner field) GET /api/user (partner field) GET /api/phone (partner field)
• added partner API calls: GET /api/partner/user/(user-uuid) POST /api/partner/recovery/(user-uuid) POST /api/partner/phone/(user-uuid)
• added phone-forbidden status message to GET /api/phone/gateway/(country) GET /api/phone/offer/(country)/(gateway)
• added mode parameter to POST /api/fax/(uuid)/(xxx).pdf

Version 1.0.3

• added object type volume and /api/volume/... API calls
• added forbidden-to response to POST /api/fax/(uuid)/send
• added orientation parameter to POST /api/fax/(uuid)/(xxx).pdf

Version 1.0.2

• added quota-exceeded and no-content responses to POST /api/fax/(uuid)/send
• added status field to GET /api/fax/(uuid), more types in status field in GET /api/recording/(uuid), GET /api/announcement/(uuid)
• allow undelete of objects by removing the tag_trash with POST /api/object/(uuid)/tag

Version 1.0.1

• support for sending e-mail notifications on incoming fax/announcement/recording:

  added notification_email, notification_attachment fields to GET /api/phone

  added notification_email, notification_attachment fields to POST /api/phone

• server-side multi-language / localization support:

  added language parameter to GET /api/session

  added language field to POST /api/signup/user

  added language field to GET /api/user

  added language field to POST /api/user

• allow user to modify email address: added email and code fields to POST /api/user

• possibility to page through object comments: added start, to, from, count and order parameters to GET /api/object/(uuid)/comment

• merged {fax, announcement, recording, contact, conference}_{new,modify, delete, share, unshare} events into generic object_{new, modify, delete, share, unshare} events

• new event object_tag sent if tags attached to an object are changed (object_modify is not sent in this case any more)

• new events comment_{new, modify, delete} to explicitely signal comment actions (object_modify is not sent in this case any more)

• add owner and description fields to conference_{start, stop} events

Version 1.0.0

• added tag, search parameters to GET /api/tag/(uuid)/object