.. _confd_changelog: ***************************** xivo-confd REST API changelog ***************************** 16.16 ===== * The ``conference`` destination type in incalls endpoints has been renamed to ``meetme`` * Added conferences endpoints: * GET ``/1.1/conferences`` * POST ``/1.1/conferences`` * DELETE ``/1.1/conferences/`` * GET ``/1.1/conferences/`` * PUT ``/1.1/conferences/`` * A new API for associating an extension with a conference has been added: * DELETE ``/1.1/conferences//extensions/`` * PUT ``/1.1/conferences//extensions/`` * Added groups endpoints: * GET ``/1.1/groups`` * POST ``/1.1/groups`` * DELETE ``/1.1/groups/`` * GET ``/1.1/groups/`` * PUT ``/1.1/groups/`` * A new API for associating an extension with a group has been added: * DELETE ``/1.1/groups//extensions/`` * PUT ``/1.1/groups//extensions/`` * A new API for editing fallbacks for a group has been added: * GET ``/1.1/groups//fallbacks`` * PUT ``/1.1/groups//fallbacks`` * A new API for associating trunks with an group has been added: * PUT ``/1.1/groups//members/users`` * Added contexts endpoints: * GET ``/1.1/contexts`` * POST ``/1.1/contexts`` * DELETE ``/1.1/contexts/`` * GET ``/1.1/contexts/`` * PUT ``/1.1/contexts/`` * A new API for editing fallbacks for a user has been added: * GET ``/1.1/users//fallbacks`` * PUT ``/1.1/users//fallbacks`` * New readonly parameters have been added to the incall resource: * For destinations of type `ivr`: * ``ivr_name`` * For destinations of type `user`: * ``user_firstname`` * ``user_lastname`` * For destinations of type `voicemail`: * ``voicemail_name`` * New readonly parameters have been added to the voicemail resource: * ``users`` * New readonly parameters have been added to the user resource: * ``voicemail`` * ``incalls`` 16.14 ===== * Added users endpoints in REST API: * GET ``/1.1/users//lines//associated/endpoints/sip`` * New readonly parameters have been added to the line resource: * ``endpoint_sip`` * ``endpoint_sccp`` * ``endpoint_custom`` * ``extensions`` * ``users`` * New readonly parameters have been added to the extension resource: * ``lines`` * New readonly parameters have been added to the user resource: * ``lines`` * A new readonly parameter have been added to the endpoint_sip, endpoint_sccp and endpoint_custom resource: * ``line`` * Added outcalls endpoints: * GET ``/1.1/outcalls`` * POST ``/1.1/outcalls`` * DELETE ``/1.1/outcalls/`` * GET ``/1.1/outcalls/`` * PUT ``/1.1/outcalls/`` * Added IVR endpoints: * GET ``/1.1/ivr`` * POST ``/1.1/ivr`` * DELETE ``/1.1/ivr/`` * GET ``/1.1/ivr/`` * PUT ``/1.1/ivr/`` * A new API for associating trunks with an outcall has been added: * PUT ``/1.1/outcalls//trunks`` * A new API for associating an extension with an outcall has been added: * DELETE ``/1.1/outcalls//extensions/`` * PUT ``/1.1/outcalls//extensions/`` 16.13 ===== * New readonly parameters have been added to the trunks resource: * ``endpoint_sip`` * ``endpoint_custom`` * A new readonly parameter have been added to the endpoint_sip and endpoint_custom resource: * ``trunk`` * A new API for associating an extension with an incall has been added: * DELETE ``/1.1/incalls//extensions/`` * PUT ``/1.1/incalls//extensions/`` * Added incalls endpoints: * GET ``/1.1/incalls`` * POST ``/1.1/incalls`` * DELETE ``/1.1/incalls/`` * GET ``/1.1/incalls/`` * PUT ``/1.1/incalls/`` 16.12 ===== * A new API for associating an endpoint with a trunk has been added: * DELETE ``/1.1/trunks//endpoints/sip/`` * PUT ``/1.1/trunks//endpoints/sip/`` * GET ``/1.1/trunks//endpoints/sip`` * GET ``/1.1/endpoints/sip//trunks`` * DELETE ``/1.1/trunks//endpoints/custom/`` * PUT ``/1.1/trunks//endpoints/custom/`` * GET ``/1.1/trunks//endpoints/custom`` * GET ``/1.1/endpoints/custom//trunks`` * Added trunks endpoints: * GET ``/1.1/trunks`` * POST ``/1.1/trunks`` * DELETE ``/1.1/trunks/`` * GET ``/1.1/trunks/`` * PUT ``/1.1/trunks/`` * Added SIP general endpoints: * GET ``/1.1/asterisk/sip/general`` * PUT ``/1.1/asterisk/sip/general`` 16.11 ===== * A new API for associating a user with an agent has been added: * DELETE ``/1.1/users//agents`` * GET ``/1.1/users//agents`` * PUT ``/1.1/users//agents/`` * A new API to list lines associated to an extension * GET ``/1.1/extensions//lines`` * The following URLs have been deprecated. Please use the new API instead: * GET ``/1.1/extensions//line`` 16.10 ===== * Add possibility to associate many lines to the same user. * Add possibility to associate many extensions to the same line (only if these lines are associated to the same user). * A new API for associating a user with a voicemail has been added: * DELETE ``/1.1/users//voicemails`` * GET ``/1.1/users//voicemails`` * PUT ``/1.1/users//voicemails`` * A new API for associating a line with an extension has been added: * PUT ``/1.1/lines//extensions/`` * A new API for associating a user with a line has been added: * PUT ``/1.1/users//lines/`` * The following URLs have been deprecated. Please use the new API instead: * DELETE ``/1.1/users//voicemail`` * GET ``/1.1/users//voicemail`` * POST ``/1.1/users//voicemail`` * POST ``/1.1/users//lines`` * POST ``/1.1/lines//extensions`` 16.09 ===== * Added entities endpoints: * GET ``/1.1/entities`` * POST ``/1.1/entities`` * GET ``/1.1/entities/`` * DELETE ``/1.1/entities/`` * A new API for updating all user's funckeys * PUT ``/1.1/users//funckeys`` * A new parameter have been added to the users resource: * ``dtmf_hangup_enabled`` 16.06 ===== * A new API for initializing a Wazo (passing the wizard): * GET ``/1.1/wizard`` * POST ``/1.1/wizard`` * GET ``/1.1/wizard/discover`` * A new API for associating a user with an entity has been added: * GET ``/1.1/users//entities`` * PUT ``/1.1/users//entities/`` 16.05 ===== * A new API for associating a user with a call permission has been added: * GET ``/1.1/users//callpermissions`` * PUT ``/1.1/users//callpermissions/`` * DELETE ``/1.1/users//callpermissions/`` * GET ``/1.1/callpermissions//users`` * Two new parameters have been added to the users resource: * ``call_permission_password`` * ``enabled`` * A new API for user's forwards has been added: * PUT ``/1.1/users//forwards`` * SIP endpoint: ``allow`` and ``disallow`` options are not split into multiple options anymore. * SCCP endpoint: ``allow`` and ``disallow`` options are not split into multiple options anymore. 16.04 ===== * The ``summary`` view has been added to ``/users`` (GET ``/users?view=summary``) * A new API for user's services has been added: * GET ``/1.1/users//services`` * GET ``/1.1/users//services/`` * PUT ``/1.1/users//services/`` * A new API for user's forwards has been added: * GET ``/1.1/users//forwards`` * GET ``/1.1/users//forwards/`` * PUT ``/1.1/users//forwards/`` * GET ``/1.1/users/export`` now requires the following header for CSV output:: Accept: text/csv; charset=utf-8 * Added call permissions endpoints: * GET ``/1.1/callpermissions`` * POST ``/1.1/callpermissions`` * GET ``/1.1/callpermissions/`` * PUT ``/1.1/callpermissions/`` * DELETE ``/1.1/callpermissions/`` 16.03 ===== * Added switchboard endpoints: * GET ``/1.1/switchboards`` * GET ``/1.1/switchboards//stats`` * A new API for associating a line with a device has been added: * PUT ``/1.1/lines//devices/`` * DELETE ``/1.1/lines//devices/`` * The following URLs have been deleted. Please use the new API instead: * GET ``/1.1/devices//associate_line/`` * GET ``/1.1/devices//dissociate_line/`` 16.02 ===== * Added users endpoints in REST API: * GET ``/1.1/users//lines/main/associated/endpoints/sip`` 16.01 ===== * The SIP API has been improved. ``options`` now accepts any extra parameter. However, due to certain database limitations, parameters that appear in :ref:`sip-endpoint-parameters` may only appear once in the list. This limitation will be removed in future versions. * A new API for custom endpoints has been added: ``/1.1/endpoints/custom`` * A new API for associating custom endpoints has been added: ``/1.1/lines//endpoints/custom/`` 15.20 ===== * A new API for mass updating users has been added: PUT ``/1.1/users/import`` * A new API for exporting users has been added: GET ``/1.1/users/export`` 15.19 ===== * A new API for mass importing users has been added: POST ``/1.1/users/import`` * The following fields have been added to the ``/users`` API: * supervision_enabled * call_tranfer_enabled * ring_seconds * simultaneous_calls 15.18 ===== * Ports 50050 and 50051 have been removed. Please use 9486 and 9487 instead * Added sccp endpoints in REST API: * GET ``/1.1/endpoints/sccp`` * POST ``/1.1/endpoints/sccp`` * DELETE ``/1.1/endpoints/sccp/`` * GET ``/1.1/endpoints/sccp/`` * PUT ``/1.1/endpoints/sccp/`` * GET ``/1.1/endpoints/sccp//lines`` * GET ``/1.1/lines//endpoints/sccp`` * DELETE ``/1.1/lines//endpoints/sccp/`` * PUT ``/1.1/lines//endpoints/sccp/`` * Added lines endpoints in REST API: * GET ``/1.1/lines//users`` 15.17 ===== * A new API for SIP endpoints has been added. Consult the documentation on http://api.wazo.community for further details. * The ``/lines_sip`` API has been deprecated. Please use ``/lines`` and ``/endpoints/sip`` instead. * Due to certain limitations in the database, only a limited number of optional parameters can be configured. This limitation will be removed in future releases. Supported parameters are listed further down. * Certain fields in the ``/lines`` API have been modified. List of fields are further down Fields modified in the ``/lines`` API ------------------------------------- +------------------------+-------------------+------------+------------+ | Name | Replaced by | Editable ? | Required ? | +========================+===================+============+============+ | id | | no | | +------------------------+-------------------+------------+------------+ | device_id | | no | | +------------------------+-------------------+------------+------------+ | name | | no | | +------------------------+-------------------+------------+------------+ | protocol | | no | | +------------------------+-------------------+------------+------------+ | device_slot | position | no | | +------------------------+-------------------+------------+------------+ | provisioning_extension | provisioning_code | no | | +------------------------+-------------------+------------+------------+ | context | | yes | yes | +------------------------+-------------------+------------+------------+ | provisioning_code | | yes | | +------------------------+-------------------+------------+------------+ | position | | yes | | +------------------------+-------------------+------------+------------+ | caller_id_name | | yes | | +------------------------+-------------------+------------+------------+ | caller_id_num | | yes | | +------------------------+-------------------+------------+------------+ .. _sip-endpoint-parameters: Supported parameters on SIP endpoints ------------------------------------- * md5secret * language * accountcode * amaflags * allowtransfer * fromuser * fromdomain * subscribemwi * buggymwi * call-limit * callerid * fullname * cid-number * maxcallbitrate * insecure * nat * promiscredir * usereqphone * videosupport * trustrpid * sendrpid * allowsubscribe * allowoverlap * dtmfmode * rfc2833compensate * qualify * g726nonstandard * disallow * allow * autoframing * mohinterpret * useclientcode * progressinband * t38pt-udptl * t38pt-usertpsource * rtptimeout * rtpholdtimeout * rtpkeepalive * deny * permit * defaultip * setvar * port * regexten * subscribecontext * vmexten * callingpres * parkinglot * protocol * outboundproxy * transport * remotesecret * directmedia * callcounter * busylevel * ignoresdpversion * session-timers * session-expires * session-minse * session-refresher * callbackextension * timert1 * timerb * qualifyfreq * contactpermit * contactdeny * unsolicited_mailbox * use-q850-reason * encryption * snom-aoc-enabled * maxforwards * disallowed-methods * textsupport 15.16 ===== * The parameter ``skip`` is now deprecated. Use ``offset`` instead for: * ``GET /1.1/devices`` * ``GET /1.1/extensions`` * ``GET /1.1/voicemails`` * ``GET /1.1/users`` * The users resource can be referred to by ``uuid`` * ``GET /1.1/users/`` * ``PUT /1.1/users/`` * ``DELETE /1.1/users/`` 15.15 ===== * The field ``enabled`` has been added to the voicemail model * A line is no longer required when associating a voicemail with a user * Voicemails can now be edited even when they are associated to a user 15.14 ===== * All optional fields on a user are now always null (sometimes they were empty strings) * The caller id is no longer automatically updated when the firstname or lastname is modified. You must update the caller id yourself if you modify the user's name. * Caller id will be generated if and only if it does not exist when creating a user. 14.16 ===== * Association user-voicemail, when associating a voicemail whose id does not exist: * before: error 404 * after: error 400 14.14 ===== * Association line-extension, a same extension can not be associated to multiple lines 14.13 ===== * Resource line, field ``provisioning_extension``: type changed from ``int`` to ``string``