apinikko web api help page

Introduction

This is apinikko which is the main api for apps and webs.

Notification

API	Description
POST api/Notification/Register?token={token}&brand={brand}&transport={transport}&isRegistering={isRegistering}	No documentation available.
POST api/Notification/Send?mobile={mobile}&message={message}	No documentation available.
POST api/Notification/SendData?mobile={mobile}&message={message}	No documentation available.
POST api/Notification/SendDist?aor={aor}	No documentation available.
POST api/Notification/TeamsListen?validationToken={validationToken}	No documentation available.
GET api/Notification	No documentation available.
POST api/Notification	No documentation available.

Account

API	Description
POST api/Account/InitiateLogin	No documentation available.
POST api/Account/ConfirmLogin?provider={provider}	No documentation available.
POST api/Account/PasswordLogin	No documentation available.
POST api/Account/TokenLogin	No documentation available.
POST api/Account/Login	No documentation available.
PUT api/Account/update	No documentation available.
GET api/Account	No documentation available.
POST api/Account	No documentation available.

AdminMessage

API	Description
GET api/adminmessages	No documentation available.
DELETE api/adminmessages?ids[0]={ids[0]}&ids[1]={ids[1]}	No documentation available.
GET api/adminmessages/navtree	No documentation available.
GET api/adminmessages/filters	No documentation available.
GET api/AdminMessage	No documentation available.
POST api/AdminMessage	No documentation available.

Contact

API	Description
GET api/contact/all	No documentation available.
DELETE api/contact/{contactid}	No documentation available.
GET api/contact/history	No documentation available.
GET api/contact/favoritelist	No documentation available.
POST api/contact/favoritelist	No documentation available.
PUT api/contact/favoritelist	No documentation available.
DELETE api/contact/favoritelist/{listid}	No documentation available.
GET api/contact/favorite	No documentation available.
POST api/contact/favorite/add/{contacttype}/{contactid}/{listid}	No documentation available.
PUT api/contact/favorite/remove/{favoriteid}/{listid}	No documentation available.
PUT api/Contact	No documentation available.
GET api/Contact	No documentation available.

Prompt

API	Description
GET api/prompt/tenant	No documentation available.
GET api/prompt/audio?filename={filename}	No documentation available.
POST api/prompt/new	No documentation available.
PUT api/prompt/usemain?ivrid={ivrid}&promptid={promptid}	No documentation available.
PUT api/prompt/useoptions?ivrid={ivrid}&promptid={promptid}	No documentation available.
GET api/Prompt	No documentation available.
POST api/Prompt	No documentation available.

Profile

API	Description
GET api/profile	No documentation available.
PUT api/profile	No documentation available.
DELETE api/profile	No documentation available.
PUT api/profile/numbers	No documentation available.
PUT api/profile/enableprofile?enable={enable}	No documentation available.
PUT api/profile/enablechangepresentation?enable={enable}	No documentation available.
PUT api/profile/enableloginlogout?enable={enable}	No documentation available.
POST api/Profile	No documentation available.

AppTheme

API	Description
GET api/apptheme/theme	No documentation available.
POST api/apptheme/themeId	No documentation available.
POST api/apptheme/createfromtemplate?resellerId={resellerId}&tenantId={tenantId}	No documentation available.
GET api/apptheme/image?id={id}	No documentation available.
POST api/apptheme/image	No documentation available.
PUT api/AppTheme	No documentation available.
DELETE api/AppTheme?provider={provider}&serviceProviderId={serviceProviderId}&resellerId={resellerId}&tenantId={tenantId}	No documentation available.
GET api/AppTheme	No documentation available.
POST api/AppTheme	No documentation available.

Claim

API	Description
GET api/claim/all	No documentation available.
GET api/claim/tenantid?tenantid={tenantid}	No documentation available.
GET api/claim/user?netpbxusername={netpbxusername}	No documentation available.
GET api/claim/userid?id={id}	No documentation available.
POST api/claim/user/add?netpbxusername={netpbxusername}	No documentation available.
POST api/claim/userid/add?id={id}	No documentation available.
POST api/claim/user/remove?netpbxusername={netpbxusername}	No documentation available.
POST api/claim/userid/remove?id={id}	No documentation available.
GET api/claim/{type}	No documentation available.
POST api/claim/add	No documentation available.
PUT api/claim/update	No documentation available.
PUT api/claim/remove	No documentation available.
GET api/Claim	No documentation available.
POST api/Claim	No documentation available.

User

API	Description
GET api/user/all	No documentation available.
PUT api/user/update	No documentation available.
GET api/user/phone?netpbxusername={netpbxusername}	No documentation available.
GET api/user/number?netpbxusername={netpbxusername}	No documentation available.
GET api/user/diversions/all	No documentation available.
GET api/user/diversions/fixed	No documentation available.
GET api/user/diversions/scheduled	No documentation available.
GET api/user/diversions/occurrences?fromdate={fromdate}&days={days}&includeExceptions={includeExceptions}	No documentation available.
PUT api/user/diversions/fixed	No documentation available.
PUT api/user/diversions/scheduled	No documentation available.
DELETE api/user/diversions/scheduled/{id}	No documentation available.
GET api/User?netpbxusername={netpbxusername}	No documentation available.
GET api/User	No documentation available.
POST api/User	No documentation available.

Management

API	Description
GET api/management/cacheupdate	No documentation available.
GET api/management/onboardingsync	No documentation available.
POST api/management/change?user={user}	No documentation available.
POST api/management/delete?user={user}	No documentation available.
GET api/management/themedtenants?server={server}	No documentation available.
GET api/management/netpbxservers	No documentation available.
GET api/management/serviceproviders?server={server}	No documentation available.
GET api/management/resellersbysp/{spid}?server={server}	No documentation available.
GET api/management/tenantsbysp/{spid}?server={server}	No documentation available.
GET api/management/tenantsbyreseller/{resellerid}?server={server}	No documentation available.
GET api/Management	No documentation available.
POST api/Management	No documentation available.

LoggedinUser

API	Description
GET api/loggedinuser	No documentation available.
GET api/loggedinuser/getsurf	No documentation available.
POST api/LoggedinUser	No documentation available.

Test

API	Description
POST api/test/{number}	No documentation available.
POST api/test/thread/{number}	No documentation available.

Setting

API	Description
PATCH api/settings	No documentation available.
PUT api/settings	No documentation available.
GET api/settings/{system}/{setting}/{topnode}/{subnode1}	No documentation available.
GET api/precondition/teams/presence	No documentation available.
GET api/Setting	No documentation available.
POST api/Setting	No documentation available.

Version

API	Description
GET api/version	No documentation available.

Brand

API	Description
GET api/brand/navtree	No documentation available.
GET api/brand?path={path}	No documentation available.
GET api/brand/number	No documentation available.
GET api/brand/admin?path={path}	No documentation available.
PUT api/brand/admin?path={path}	No documentation available.
GET api/Brand	No documentation available.
POST api/Brand	No documentation available.

Role

API	Description
GET api/role/all	No documentation available.
GET api/role/{type}	No documentation available.
POST api/role/add	No documentation available.
PUT api/role/update	No documentation available.
PUT api/role/remove	No documentation available.
GET api/Role	No documentation available.
POST api/Role	No documentation available.

Group

API	Description
GET api/group/all	No documentation available.
GET api/group/{groupid}	No documentation available.
GET api/group/canOpenClose	No documentation available.
PUT api/group/openclose/{groupid}?open={open}	No documentation available.
PUT api/group/loginlogout	No documentation available.
PUT api/group/memberloginlogout	No documentation available.
PUT api/group/addmember	No documentation available.
PUT api/group/removemember	No documentation available.
GET api/group/diversions/all/{groupid}	No documentation available.
GET api/group/diversions/fixed/{groupid}	No documentation available.
GET api/group/diversions/scheduled/{groupid}	No documentation available.
GET api/group/diversions/occurrences?fromdate={fromdate}&groupid={groupid}&days={days}&includeExceptions={includeExceptions}	No documentation available.
PUT api/group/diversions/fixed	No documentation available.
PUT api/group/diversions/scheduled	No documentation available.
DELETE api/group/diversions/scheduled/{id}	No documentation available.
GET api/Group	No documentation available.
POST api/Group	No documentation available.

Ivr

API	Description
GET api/ivr/tenant	No documentation available.
GET api/ivr/group?groupid={groupid}	No documentation available.
GET api/ivr/group/extended?groupid={groupid}	No documentation available.
GET api/Ivr	No documentation available.
POST api/Ivr	No documentation available.