{"info":{"title":"IPBX API Documentation","version":"1.111.0","description":"Access to all methods is granted through Bearer token. "},"schemes":["https"],"security":[{"soap":[]}],"openapi":"3.0.0","servers":[{"url":"http://ipbxapi.voipex.io"}],"components":{"securitySchemes":{"soap":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"way":{"type":"string","description":"call direction (Loc - local, In - incoming, Out - outgoing)","enum":["Loc","In","Out"]},"categories":{"type":"array","description":"List of call categories","items":{"type":"string"}},"user":{"type":"object","description":"User assigned to this call via line","nullable":true,"properties":{"login":{"type":"string"}}},"Model1":{"type":"object","properties":{"user_id":{"nullable":true,"anyOf":[{"type":"string"},{"type":"number"}]},"line":{"anyOf":[{"type":"string"},{"type":"number"}]},"calldate":{"type":"string","format":"date"},"clid":{"type":"string"},"src":{"type":"string"},"dst":{"type":"string"},"duration":{"type":"number"},"billsec":{"type":"number"},"disposition":{"type":"string","description":"asterisk hangup cause"},"accountcode":{"type":"string"},"userfield":{"type":"string","description":"custom data"},"filename":{"type":"string","description":"name of call recording"},"way":{"$ref":"#/components/schemas/way"},"trunk":{"type":"string","description":"used SIP trunk"},"hangupcause":{"type":"string"},"uniqueid":{"type":"string"},"linkedid":{"type":"string"},"organization":{"type":"string","description":"calling organization from API8"},"organizationPerson":{"type":"string"},"data":{"type":"string","description":"metadata"},"sipcallid":{"type":"string"},"stamp":{"type":"string","format":"date","description":"creation date"},"cc_cb":{"type":"number","nullable":true},"queue":{"type":"string","description":"outgoing queue","nullable":true},"note":{"type":"string","nullable":true},"categories":{"$ref":"#/components/schemas/categories"},"phoneNumber":{"type":"string","description":"Selection from src or dst field. If way is incoming then phoneNumber is source number. If way is outgoing then phoneNumber is destination number."},"user":{"$ref":"#/components/schemas/user"},"endTime":{"type":"string","format":"date"},"userAnswered":{"type":"boolean","nullable":true}},"required":["user_id","line","calldate","src","dst","duration","billsec","disposition","way","organization","stamp","phoneNumber","endTime","userAnswered"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/Model1"}},"Model2":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"method":{"type":"string"}},"required":["rel","href","method"]},"links":{"type":"array","items":{"$ref":"#/components/schemas/Model2"}},"Model3":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/items"},"links":{"$ref":"#/components/schemas/links"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"totalResults":{"type":"number"}},"required":["currentPage","totalPages","totalResults"]},"exten":{"type":"object","nullable":true,"properties":{"id":{"type":"number"},"number":{"type":"string"}},"required":["id","number"]},"Model4":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"callerId":{"type":"string","nullable":true}},"required":["id","name"]},"queues":{"type":"array","items":{"$ref":"#/components/schemas/Model4"}},"skillsGroup":{"type":"object","nullable":true,"properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"Model5":{"type":"object","properties":{"userId":{"type":"string","description":"User anvil id"},"pbxUserId":{"type":"number","description":"Pbx user id"},"firstName":{"type":"string"},"lastName":{"type":"string"},"login":{"type":"string"},"exten":{"$ref":"#/components/schemas/exten"},"queues":{"$ref":"#/components/schemas/queues"},"skillsGroup":{"$ref":"#/components/schemas/skillsGroup"}},"required":["userId","pbxUserId","firstName","lastName","login"]},"Model6":{"type":"array","items":{"$ref":"#/components/schemas/Model5"}},"ownerType":{"type":"string","enum":["user","application"]},"type":{"type":"string","enum":["ddi","exten","cid"]},"numplan":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}},"Model7":{"type":"object","properties":{"number":{"type":"string"},"ownerId":{"type":"string"},"id":{"type":"string"},"ownerType":{"$ref":"#/components/schemas/ownerType"},"applicationType":{"type":"string"},"type":{"$ref":"#/components/schemas/type"},"priority":{"type":"number"},"numplan":{"$ref":"#/components/schemas/numplan"}},"required":["number","ownerId","id","ownerType","type","numplan"]},"Model8":{"type":"array","items":{"$ref":"#/components/schemas/Model7"}},"Model9":{"type":"object","properties":{"id":{"type":"number","description":"Pause id"},"name":{"type":"string","description":"Pause name (reason)"},"billable":{"type":"boolean","description":"Billable or non-billable pause"},"description":{"type":"string","description":"Pause description"}},"required":["id","name"]},"Model10":{"type":"array","items":{"$ref":"#/components/schemas/Model9"}},"fwd":{"type":"string","enum":["none","mymobile","another"],"nullable":true},"params":{"type":"object","properties":{"hasDevice":{"type":"boolean"},"hasForward":{"type":"boolean"},"alert":{"type":"boolean"},"endpointId":{"type":"integer","nullable":true},"fwd":{"$ref":"#/components/schemas/fwd"},"fwdNum":{"type":"string","nullable":true}}},"Model11":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"active":{"type":"boolean"},"description":{"type":"string"},"params":{"$ref":"#/components/schemas/params"}}},"Model12":{"type":"array","items":{"$ref":"#/components/schemas/Model11"}},"files":{"type":"array","items":{"type":"string"}},"Model13":{"type":"object","properties":{"files":{"$ref":"#/components/schemas/files"},"currentPage":{"type":"number"},"totalPages":{"type":"number"}}},"Model14":{"type":"object","nullable":true,"properties":{"id":{"type":"string"},"login":{"type":"string"}}},"direction":{"type":"string","description":"call direction (Loc - local, In - incoming, Out - outgoing)","enum":["Loc","In","Out"]},"state":{"type":"string","enum":["Down","Rsrvd","OffHook","Dialing","Ring","Ringing","Up","Busy","Offhook","Pre-ring","Unknown"]},"Model15":{"type":"object","properties":{"callId":{"type":"string"},"src":{"type":"string","description":"Source number"},"dst":{"type":"string","description":"Destination number"},"channel":{"type":"string"},"channelId":{"type":"string"},"duration":{"type":"number","description":"Duration in seconds"},"user":{"$ref":"#/components/schemas/Model14"},"direction":{"$ref":"#/components/schemas/direction"},"state":{"$ref":"#/components/schemas/state"},"creationTime":{"type":"string","format":"date-time"}},"required":["callId","src","dst","channelId"]},"Model16":{"type":"array","items":{"$ref":"#/components/schemas/Model15"}},"Model17":{"type":"string","description":"Call handling status","enum":["noChange","inProgress"]},"Model18":{"type":"object","properties":{"callId":{"type":"string","description":"Call id"},"agent":{"type":"string","description":"Agent login","nullable":true},"attempts":{"type":"number","description":"Number of incoming attempts"},"outgoingAttempts":{"type":"number","description":"Number of callback attempts"},"callerId":{"type":"string","description":"CallerId"},"callerIdentity":{"type":"string","description":"Caller contact"},"calldate":{"type":"string","format":"date-time","description":"Date and time of the call (ISO 8601)"},"holdTime":{"type":"number","description":"Hold time"},"ivrValue":{"type":"string","description":"Custom value set from IVR","nullable":true},"lastUpdate":{"type":"string","format":"date-time","description":"Last update in (ISO 8601)"},"queue":{"type":"string","description":"Queue name","nullable":true},"state":{"$ref":"#/components/schemas/Model17"}}},"Model19":{"type":"array","items":{"$ref":"#/components/schemas/Model18"}},"Model20":{"type":"object","properties":{"login":{"type":"string"},"name":{"type":"string"},"surname":{"type":"string"},"id":{"type":"string"},"pbxUserId":{"type":"number"},"exten":{"type":"number","description":"User line number"}},"required":["login","name","surname","id"]},"Model21":{"type":"array","items":{"$ref":"#/components/schemas/Model20"}},"Model22":{"type":"object","properties":{"date":{"type":"string"},"time":{"type":"string"},"ivr":{"type":"string","nullable":true},"queue":{"type":"string","nullable":true},"user":{"type":"string","nullable":true},"direction":{"type":"string"},"answered":{"type":"boolean"},"cb":{"type":"string","nullable":true},"cbId":{"type":"string","nullable":true},"cbWho":{"type":"string","nullable":true},"cbDate":{"type":"string","nullable":true},"cbTime":{"type":"string","nullable":true},"cbDiff":{"type":"number","nullable":true},"checked":{"type":"boolean","nullable":true},"cid":{"type":"string","nullable":true},"callId":{"type":"string"},"org":{"type":"string","nullable":true},"orgPerson":{"type":"string","nullable":true},"duration":{"type":"number"},"wait":{"type":"number","nullable":true},"ringing":{"type":"number"},"holdtime":{"type":"number"},"membersCount":{"type":"number","nullable":true},"waitingCalls":{"type":"number","nullable":true},"lastRinging":{"type":"string","nullable":true},"exit":{"type":"string","nullable":true},"position":{"type":"number","nullable":true},"attempt":{"type":"number","nullable":true},"customerRating":{"type":"number","nullable":true},"customerSuccess":{"type":"number","nullable":true},"resolvedStatus":{"type":"string","nullable":true},"recording":{"type":"string","nullable":true},"linkedid":{"type":"string","nullable":true}},"required":["date","time","direction","answered","checked","callId","duration","ringing","holdtime"]},"Model23":{"type":"array","items":{"$ref":"#/components/schemas/Model22"}},"Model24":{"type":"object","properties":{"name":{"type":"string","description":"Queue name"},"total":{"type":"number"},"answered":{"type":"number"},"noanswer":{"type":"number"},"afterSla":{"type":"number"},"inSla":{"type":"number"},"avgWait":{"type":"number"},"maxWait":{"type":"number"},"avgDur":{"type":"number"},"maxDur":{"type":"number"},"noanswerRecur":{"type":"number"},"noanswerUniq":{"type":"number"}},"required":["name","total","answered","noanswer","afterSla","inSla","avgWait","maxWait","avgDur","maxDur","noanswerRecur","noanswerUniq"]},"Model25":{"type":"array","items":{"$ref":"#/components/schemas/Model24"}},"callCenter":{"type":"object","nullable":true,"properties":{"agentState":{"type":"string"},"isPaused":{"type":"boolean"}}},"status":{"type":"object","nullable":true,"properties":{"callCenter":{"$ref":"#/components/schemas/callCenter"}}},"properties":{"type":"object","nullable":true,"properties":{"id":{"type":"string","nullable":true},"applicationType":{"type":"string"},"freeAgents":{"type":"number"},"status":{"$ref":"#/components/schemas/status"}}},"Model26":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"ownerType":{"$ref":"#/components/schemas/ownerType"},"properties":{"$ref":"#/components/schemas/properties"}},"required":["id","name","extension","ownerType"]},"Model27":{"type":"array","items":{"$ref":"#/components/schemas/Model26"}},"Model28":{"type":"object","properties":{"channel":{"type":"number","description":"Channel number in stereo recording"},"transcript":{"type":"string"},"startTime":{"type":"number","description":"Segment start time in seconds","minimum":0},"endTime":{"type":"number","description":"Segment end time in seconds","minimum":0}},"required":["transcript"]},"recognition":{"type":"array","items":{"$ref":"#/components/schemas/Model28"}},"Model29":{"type":"object","properties":{"filename":{"type":"string","description":"Recording filename"},"src":{"type":"string","description":"Source number"},"dst":{"type":"string","description":"Destination number"},"recognition":{"$ref":"#/components/schemas/recognition"}},"required":["filename","recognition"]},"Model30":{"type":"array","items":{"$ref":"#/components/schemas/Model29"}},"Model31":{"type":"object","properties":{"eventtype":{"type":"string"},"eventtime":{"type":"string","format":"date","description":"Event time in specified timezone"},"src":{"type":"string","nullable":true},"dst":{"type":"string","nullable":true}},"required":["eventtype","eventtime","src","dst"]},"Model32":{"type":"array","items":{"$ref":"#/components/schemas/Model31"}},"Model33":{"type":"object","properties":{"name":{"type":"string"},"src":{"type":"string"},"dst":{"type":"string"}},"required":["name"]},"Model34":{"type":"array","items":{"$ref":"#/components/schemas/Model33"}},"Model35":{"type":"array","items":{"type":"string"}},"data":{"type":"object"},"Model36":{"type":"object","properties":{"time":{"type":"string","format":"date"},"queue":{"type":"string"},"agent":{"type":"string"},"event":{"type":"string"},"data":{"$ref":"#/components/schemas/data"}},"required":["time","queue","event"]},"Model37":{"type":"array","items":{"$ref":"#/components/schemas/Model36"}},"Model38":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/Model35"},"currentPage":{"type":"number"},"totalPages":{"type":"number"},"items":{"$ref":"#/components/schemas/Model37"}},"required":["links","currentPage","totalPages"]},"loggedIn":{"type":"array","items":{"type":"string"}},"pausedIn":{"type":"array","items":{"type":"string"}},"durations":{"type":"object","properties":{"incomingCalls":{"type":"number","description":"Incoming calls in seconds"},"outgoingCalls":{"type":"number","description":"Outgoing calls in seconds"},"pauses":{"type":"number","description":"Pauses time in seconds"},"login":{"type":"number","description":"Login time in seconds"},"idle":{"type":"number","description":"Idle time in seconds"}},"required":["incomingCalls","outgoingCalls","pauses","login","idle"]},"Model39":{"type":"object","properties":{"id":{"type":"number"},"loggedIn":{"$ref":"#/components/schemas/loggedIn"},"pausedIn":{"$ref":"#/components/schemas/pausedIn"},"isDynamic":{"type":"boolean"},"wasOncePaused":{"type":"boolean"},"wasOnceLogged":{"type":"boolean"},"logonStartTime":{"type":"string","format":"date-time"},"pauseStartTime":{"type":"string","format":"date-time"},"pendingCallStartTime":{"type":"boolean"},"durations":{"$ref":"#/components/schemas/durations"}},"required":["id","loggedIn","pausedIn"]},"Model40":{"type":"array","items":{"$ref":"#/components/schemas/Model39"}},"Model41":{"type":"object","properties":{"agent":{"type":"string","description":"Agent login"},"userId":{"type":"string","description":"User Id"},"callsTaken":{"type":"number","description":"Number of incoming calls since login"},"outgoingCallsAnswered":{"type":"number","description":"Number of outgoing answered calls"},"outgoingCallsUnanswered":{"type":"number","description":"number of outgoing answered calls"},"cbCalls":{"type":"number","description":"Number of callbacks"},"talkTime":{"type":"number","description":"Time spent on call [s]"},"logonTime":{"type":"string","format":"date-time","description":"Login time","nullable":true},"ringNoAnswer":{"type":"number","description":"Number of failed rings"},"billPauseTime":{"type":"number","description":"Time spent on billed pauses [s]"},"nonBillPauseTime":{"type":"number","description":"Time spent on unbilled pauses [s]"}}},"Model42":{"type":"array","items":{"$ref":"#/components/schemas/Model41"}},"Model43":{"type":"object","properties":{"channelId":{"type":"string","description":"New channel id. Important to end call monitoring."},"callId":{"type":"string","description":"New monitoring callId"}}},"Model44":{"type":"string","description":"Transfer type","default":"blind","enum":["blind","attended"]},"Model45":{"type":"object","properties":{"to":{"type":"string","description":"Number to transfer to"},"type":{"$ref":"#/components/schemas/Model44"},"userId":{"type":"string","description":"Transfer from this userId. By default, the user is taken from the authentication data. (Optional)","x-format":{"guid":true}},"customData":{"type":"string"}},"required":["to"]},"Model46":{"type":"string","enum":["none","mymobile","another"]},"Model47":{"type":"object","properties":{"active":{"type":"boolean","description":"If profile is active or not"},"fwd":{"$ref":"#/components/schemas/Model46"},"fwdNum":{"type":"string"},"endpointId":{"type":"integer"}}},"Model48":{"type":"object","properties":{"userId":{"type":"string","description":"When is not set authenticated user id is taken."},"profileId":{"type":"integer"}},"required":["profileId"]},"message":{"type":"string","enum":["created","updated"]},"Model49":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"number"}]},"message":{"$ref":"#/components/schemas/message"}}},"fromApplication":{"type":"object","properties":{"extenId":{"type":"number","description":"Local phone number of the application"},"outRouteId":{"type":"number","description":"Outbound routing id"}},"required":["extenId","outRouteId"]},"identityType":{"type":"string","description":"User identity type","enum":["login","line"]},"fromUser":{"type":"object","properties":{"identityType":{"$ref":"#/components/schemas/identityType"},"identityValue":{"type":"string","description":"User identity value"},"outgoingQueue":{"type":"string","description":"Outbound queue name"}},"required":["identityType","identityValue"]},"customVariables":{"type":"object","description":"Custom variables for PBX dialplan (flat JSON object, max 1000 bytes)."},"Model50":{"type":"object","properties":{"to":{"type":"string","description":"The phone number to call."},"callerId":{"type":"string","description":"The phone number to use as the caller id"},"callerIdName":{"type":"string"},"fromApplication":{"$ref":"#/components/schemas/fromApplication"},"fromUser":{"$ref":"#/components/schemas/fromUser"},"customVariables":{"$ref":"#/components/schemas/customVariables"}},"required":["to"]},"Model51":{"type":"object","properties":{"callId":{"type":"string"},"channelId":{"type":"string","description":"New channel id. Important to end call."}},"required":["callId"]},"fileNames":{"type":"array","description":"List of file names.","minItems":1,"maxItems":1000,"items":{"type":"string"}},"callIds":{"type":"array","description":"List of call ids. Call id represents linkedid","minItems":1,"maxItems":1000,"items":{"type":"string"}},"extensions":{"type":"array","description":"Array of user extensions","x-constraint":{"single":true},"items":{"type":"string","pattern":"^[0-9]+$"}},"userFilter":{"type":"object","description":"Filter to find user recordings","properties":{"extensions":{"$ref":"#/components/schemas/extensions"},"startTime":{"type":"string","format":"date-time","description":"ISO 8601 format. Default: start of day"},"endTime":{"type":"string","format":"date-time","description":"ISO 8601 format. Default: now"}}},"Model52":{"type":"object","properties":{"fileNames":{"$ref":"#/components/schemas/fileNames"},"callIds":{"$ref":"#/components/schemas/callIds"},"userFilter":{"$ref":"#/components/schemas/userFilter"}}},"deleted":{"type":"array","description":"Successfully deleted files..","items":{"type":"string"}},"Model53":{"type":"object","properties":{"file":{"type":"string"},"message":{"type":"string"}}},"errors":{"type":"array","description":"Failed to delete files.","items":{"$ref":"#/components/schemas/Model53"}},"Model54":{"type":"object","properties":{"deleted":{"$ref":"#/components/schemas/deleted"},"errors":{"$ref":"#/components/schemas/errors"}}},"Model55":{"type":"object","nullable":true,"properties":{"userId":{"type":"string","description":"Cancel call transfer for this user. By default, the user is taken from the authentication data. (Optional)","x-format":{"guid":true}}}},"Model56":{"type":"object","properties":{"customerRating":{"type":"integer","nullable":true,"minimum":1,"maximum":5},"customerSuccess":{"type":"boolean","nullable":true},"note":{"type":"string","nullable":true,"maxLength":8192}}}}},"tags":[],"paths":{"/calls":{"get":{"summary":"Returns list of calls","operationId":"getCalls","description":"Returns list of calls","parameters":[{"name":"linkedid","in":"query","schema":{"type":"string"}},{"name":"src","in":"query","schema":{"type":"string"}},{"name":"dst","in":"query","schema":{"type":"string"}},{"name":"line","in":"query","schema":{"type":"string"}},{"name":"trunk","in":"query","schema":{"type":"string"}},{"name":"phoneNumber","in":"query","schema":{"type":"string"}},{"name":"categories","in":"query","schema":{"type":"array","description":"Nested array of call category ID to filter. Example: [[1,2] , [3]] => (1 or 2) and 3","items":{"type":"array","items":{"type":"number"}}},"description":"Nested array of call category ID to filter. Example: [[1,2] , [3]] => (1 or 2) and 3","style":"form","explode":true},{"name":"teams","in":"query","schema":{"type":"array","description":"Array of team ID to filter","x-constraint":{"single":true},"items":{"type":"number"}},"description":"Array of team ID to filter","style":"form","explode":true},{"name":"campaigns","in":"query","schema":{"type":"array","description":"Array of campaign ID to filter","x-constraint":{"single":true},"items":{"type":"integer"}},"description":"Array of campaign ID to filter","style":"form","explode":true},{"name":"extensions","in":"query","schema":{"type":"array","description":"Array of extensions to filter","x-constraint":{"single":true},"items":{"type":"string","pattern":"^[0-9]+$"}},"description":"Array of extensions to filter","style":"form","explode":true},{"name":"metadata","in":"query","schema":{"type":"boolean","description":"Add metadata to call (category, note)"},"description":"Add metadata to call (category, note)"},{"name":"disposition","in":"query","schema":{"type":"string","enum":["ANSWERED","RECORDED","CANCELED","BUSY","NO ANSWER","ALL"]}},{"name":"way","in":"query","schema":{"type":"string","description":"Call direction (Loc - local, In - incoming, Out - outgoing)","enum":["Loc","In","Out","All"]},"description":"Call direction (Loc - local, In - incoming, Out - outgoing)"},{"name":"page","in":"query","schema":{"type":"number","default":1}},{"name":"pageSize","in":"query","schema":{"type":"number","description":"Maximum is 5000","default":100,"maximum":5000},"description":"Maximum is 5000"},{"name":"startTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"endTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"srcFilter","in":"query","schema":{"type":"string","default":"equal","enum":["equal","includes","starts","ends"]}},{"name":"dstFilter","in":"query","schema":{"type":"string","default":"equal","enum":["equal","includes","starts","ends"]}},{"name":"lineFilter","in":"query","schema":{"type":"string","default":"equal","enum":["equal","includes","starts","ends"]}},{"name":"trunkFilter","in":"query","schema":{"type":"string","default":"equal","enum":["equal","includes","starts","ends"]}},{"name":"phoneNumberFilter","in":"query","schema":{"type":"string","default":"equal","enum":["equal","includes","starts","ends"]}},{"name":"sortColumn","in":"query","schema":{"type":"string","description":"Enter column name for sorting","enum":["calldate","duration","src","dst","line","disposition","trunk","way","endTime"]},"description":"Enter column name for sorting"},{"name":"sortDirection","in":"query","schema":{"type":"string","description":"Enter sort direction","default":"asc","enum":["asc","desc"]},"description":"Enter sort direction"},{"name":"timezone","in":"query","schema":{"type":"string","description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)","default":"Europe/Prague","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]},"description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)"}],"tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model3"}}}}}},"post":{"summary":"Create new call","operationId":"postCalls","description":"Create new call","parameters":[{"name":"pbxId","in":"query","schema":{"type":"number"}}],"tags":["calls"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model50"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model51"}}}}}},"delete":{"summary":"Hangup call","operationId":"deleteCalls","description":"Hangup call based on a specified identifier. The default identifier is the userId from the authentication data.","parameters":[{"name":"channelId","in":"query","schema":{"type":"string","description":"Channel ID"},"description":"Channel ID"},{"name":"callId","in":"query","schema":{"type":"string","description":"Call Id"},"description":"Call Id"},{"name":"userId","in":"query","schema":{"type":"string","description":"User ID"},"description":"User ID"}],"tags":["calls"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/members":{"get":{"summary":"Get list of members","operationId":"getMembers","description":"Get list of members with information about queues and skills group","parameters":[{"name":"login","in":"query","schema":{"type":"string"}},{"name":"userId","in":"query","schema":{"type":"string"}}],"tags":["members"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model6"}}}}}}},"/numbers":{"get":{"summary":"Get all numbers","operationId":"getNumbers","description":"Get all lines","parameters":[{"name":"pbxId","in":"query","schema":{"type":"number","description":"Pbx id"},"description":"Pbx id"},{"name":"type","in":"query","schema":{"type":"string","enum":["ddi","exten","cid"]}},{"name":"ownerType","in":"query","schema":{"type":"string","enum":["user","application"]}}],"tags":["numbers"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model8"}}}}}}},"/pauses":{"get":{"summary":"Get pauses","operationId":"getPauses","description":"Get pbx pauses.","tags":["pauses"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model10"}}}}}}},"/profiles":{"get":{"summary":"Get profiles","operationId":"getProfiles","description":"Get list of user profiles","parameters":[{"name":"userId","in":"query","schema":{"type":"string","description":"User id."},"description":"User id."}],"tags":["profiles"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model12"}}}}}}},"/recordings":{"get":{"summary":"Get all recording names based on the input filter.","operationId":"getRecordings","parameters":[{"name":"startTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"endTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"page","in":"query","schema":{"type":"number","default":1}},{"name":"pageSize","in":"query","schema":{"type":"number","default":1000,"maximum":1000}},{"name":"pbxId","in":"query","schema":{"type":"string"}}],"tags":["recordings"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model13"}}}}}}},"/calls/current":{"get":{"summary":"Return current calls","operationId":"getCallsCurrent","description":"Return current calls","parameters":[{"name":"pbxId","in":"query","schema":{"type":"number","description":"PBX ID"},"description":"PBX ID"},{"name":"userId","in":"query","schema":{"type":"string","description":"User Id"},"description":"User Id"},{"name":"userLogin","in":"query","schema":{"type":"string","description":"User login"},"description":"User login"},{"name":"callId","in":"query","schema":{"type":"string","description":"Call id"},"description":"Call id"}],"tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model16"}}}}}}},"/calls/missed":{"get":{"summary":"Missed and abandoned calls from the call center queues.","operationId":"getCallsMissed","description":"Returns missed and abandoned calls from the call center queues. This is the same data as in the agent/supervisor panel.","tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model19"}}}}}}},"/numbers/{numberId}":{"get":{"summary":"Get number info","operationId":"getNumbersNumberid","description":"Get info about concrete number.","parameters":[{"name":"numberId","in":"path","schema":{"type":"string","description":"Number id"},"description":"Number id","required":true},{"name":"pbxId","in":"query","schema":{"type":"number","description":"Pbx id"},"description":"Pbx id"}],"tags":["numbers"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model7"}}}}}}},"/pbx/users":{"get":{"summary":"Get user list","operationId":"getPbxUsers","description":"Get info about all users","parameters":[{"name":"pbxId","in":"query","schema":{"type":"number","description":"PBX id","x-constraint":{"greater":0}},"description":"PBX id"},{"name":"exten","in":"query","schema":{"type":"number","description":"User line number"},"description":"User line number"},{"name":"login","in":"query","schema":{"type":"string"}},{"name":"callcenter","in":"query","schema":{"type":"boolean","description":"Return users with allowed callcenter"},"description":"Return users with allowed callcenter"}],"tags":["pbx"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model21"}}}}}}},"/recordings/download":{"get":{"summary":"Download all recordings based on callId as a .zip archive","operationId":"getRecordingsDownload","description":"CallId is represented as linkedid.","parameters":[{"name":"callId","in":"query","schema":{"type":"array","description":"Represents linkedid","maxItems":50,"x-constraint":{"single":true},"items":{"type":"string"}},"description":"Represents linkedid","style":"form","explode":true,"required":true}],"tags":["recordings"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/recordings/{filename}":{"get":{"summary":"Play recording specified by filename","operationId":"getRecordingsFilename","description":"Extension must be provided in filename parameter. Extension .flac for filename is allowed only for PBX with enabled module enhanced recordings.","parameters":[{"name":"filename","in":"path","schema":{"type":"string"},"required":true},{"name":"pbxId","in":"query","schema":{"type":"string"}}],"tags":["recordings"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/reports/calls":{"get":{"summary":"Returns extended calls information","operationId":"getReportsCalls","description":"Return extended calls information.","parameters":[{"name":"startTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"endTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"queues","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true},{"name":"agents","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true},{"name":"campaigns","in":"query","schema":{"type":"array","description":"Array of campaign ID to filter","x-constraint":{"single":true},"items":{"type":"integer"}},"description":"Array of campaign ID to filter","style":"form","explode":true},{"name":"answered","in":"query","schema":{"type":"boolean"}},{"name":"direction","in":"query","schema":{"type":"string","enum":["incoming","outgoing"]}},{"name":"timezone","in":"query","schema":{"type":"string","description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)","default":"Europe/Prague"},"description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)"}],"tags":["reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model23"}}}}}}},"/reports/queues":{"get":{"summary":"Return statistics for queues","operationId":"getReportsQueues","description":"Return call statistics for selected time period for all (or specified) queues.","parameters":[{"name":"startTime","in":"query","schema":{"type":"string","description":"ISO 8601 format","x-format":{"isoDate":true}},"description":"ISO 8601 format"},{"name":"endTime","in":"query","schema":{"type":"string","description":"ISO 8601 format","x-format":{"isoDate":true}},"description":"ISO 8601 format"},{"name":"queues","in":"query","schema":{"type":"array","description":"Queue names to filter","items":{"type":"string"}},"description":"Queue names to filter","style":"form","explode":true},{"name":"sla","in":"query","schema":{"type":"number","description":"SLA limit for hold time","default":20},"description":"SLA limit for hold time"}],"tags":["reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model25"}}}}}}},"/calls/transfer/destinations":{"get":{"summary":"List of destinations for a transferred call.","operationId":"getCallsTransferDestinations","description":"List of destinations for a transferred call.","tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model27"}}}}}}},"/calls/{callId}/transcript":{"get":{"summary":"Returns transcript of all recordings for specified callId","operationId":"getCallsCallidTranscript","description":"Returns transcript of all recordings for specified callId. Limits and restrictions may apply based on configuration and quotas.","parameters":[{"name":"callId","in":"path","schema":{"type":"string","description":"Call ID"},"description":"Call ID","required":true},{"name":"pbxId","in":"query","schema":{"type":"number","description":"PBX ID"},"description":"PBX ID"}],"tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model30"}}}}}}},"/calls/{callId}/detail":{"get":{"summary":"Returns data for specified callId","operationId":"getCallsCallidDetail","description":"Return data for specified callId.","parameters":[{"name":"callId","in":"path","schema":{"type":"string","description":"Represents linkedid"},"description":"Represents linkedid","required":true},{"name":"pbxId","in":"query","schema":{"type":"number","description":"Pbx id"},"description":"Pbx id"},{"name":"timezone","in":"query","schema":{"type":"string","description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)","default":"Europe/Prague"},"description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)"}],"tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model32"}}}}}}},"/calls/{callId}/recordings":{"get":{"summary":"Returns all recordings for specified callId","operationId":"getCallsCallidRecordings","description":"Returns all recordings for specified callId from database.","parameters":[{"name":"callId","in":"path","schema":{"type":"string","description":"Represents linkedid"},"description":"Represents linkedid","required":true},{"name":"pbxId","in":"query","schema":{"type":"number","description":"Pbx id"},"description":"Pbx id"},{"name":"extensions","in":"query","schema":{"type":"array","default":["mp3"],"x-constraint":{"single":true},"items":{"type":"string","enum":["mp3","flac"]}},"style":"form","explode":true}],"tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model34"}}}}}}},"/pbx/users/{userId}":{"get":{"summary":"Get user","operationId":"getPbxUsersUserid","description":"Get user info","parameters":[{"name":"userId","in":"path","schema":{"type":"string","description":"Anvil id"},"description":"Anvil id","required":true},{"name":"pbxId","in":"query","schema":{"type":"number","description":"PBX id","x-constraint":{"greater":0}},"description":"PBX id"}],"tags":["pbx"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model20"}}}}}}},"/reports/agents/activity":{"get":{"summary":"Get agents activity","operationId":"getReportsAgentsActivity","description":"Return information about agents activity.","parameters":[{"name":"startTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"endTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"timezone","in":"query","schema":{"type":"string","description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)","default":"Europe/Prague"},"description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)"},{"name":"queues","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true},{"name":"agents","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true},{"name":"events","in":"query","schema":{"type":"array","description":"Possible values: UNPAUSE, PAUSE, ADDMEMBER, REMOVEMEMBER, ADDMEMBEREXTEN, COMPLETEAGENT, COMPLETECALLER, MEMBERSTATUS, MEMBERPRESENCE","x-constraint":{"single":true},"items":{"type":"string","enum":["UNPAUSE","PAUSE","ADDMEMBER","REMOVEMEMBER","ADDMEMBEREXTEN","COMPLETEAGENT","COMPLETECALLER","MEMBERSTATUS","MEMBERPRESENCE"]}},"description":"Possible values: UNPAUSE, PAUSE, ADDMEMBER, REMOVEMEMBER, ADDMEMBEREXTEN, COMPLETEAGENT, COMPLETECALLER, MEMBERSTATUS, MEMBERPRESENCE","style":"form","explode":true},{"name":"page","in":"query","schema":{"type":"number","default":1,"minimum":1}},{"name":"pageSize","in":"query","schema":{"type":"number","description":"Maximum is 5000","default":1000,"maximum":5000},"description":"Maximum is 5000"}],"tags":["reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model38"}}}}}}},"/reports/agents/activity-durations":{"get":{"summary":"Get agents activity durations","operationId":"getReportsAgentsActivitydurations","description":"Return information about agents activity durations.","parameters":[{"name":"startTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"endTime","in":"query","schema":{"type":"string","format":"date-time","description":"ISO 8601 format"},"description":"ISO 8601 format"},{"name":"agents","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true},{"name":"timezone","in":"query","schema":{"type":"string","description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)","default":"Europe/Prague"},"description":"Enter the timezone in which you want to return the call time (possible options get on https://momentjs.com/timezone/)"}],"tags":["reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model40"}}}}}}},"/reports/agents/daily-stats":{"get":{"summary":"Daily agent statistics","operationId":"getReportsAgentsDailystats","description":"Returns daily agent call statistics.","parameters":[{"name":"agents","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true},{"name":"usersId","in":"query","schema":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"style":"form","explode":true}],"tags":["reports"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model42"}}}}}}},"/recordings/{filename}/ipbx/{pbxId}":{"get":{"operationId":"getRecordingsFilenameIpbxPbxid","parameters":[{"name":"filename","in":"path","schema":{"type":"string"},"required":true},{"name":"pbxId","in":"path","schema":{"type":"string"},"required":true}],"tags":["recordings"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}},"deprecated":true}},"/calls/monitor":{"put":{"summary":"Monitor call","operationId":"putCallsMonitor","description":"Monitor call specified by channel ID. Choose monitor type.","parameters":[{"name":"channelId","in":"query","schema":{"type":"string","description":"Channel ID"},"description":"Channel ID","required":true},{"name":"userId","in":"query","schema":{"type":"string","description":"Monitoring user ID. By default, the user is taken from the authentication data. (Optional)","x-format":{"guid":true}},"description":"Monitoring user ID. By default, the user is taken from the authentication data. (Optional)"},{"name":"type","in":"query","schema":{"type":"string","description":"Spy or whisper","default":"spy","enum":["spy","whisper"]},"description":"Spy or whisper"}],"tags":["calls"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model43"}}}}}}},"/calls/transfer":{"put":{"summary":"Transfer a call","operationId":"putCallsTransfer","description":"The remote caller be transferred to a given destination.","tags":["calls"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model45"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Cancel an attended transfer","operationId":"deleteCallsTransfer","description":" Cancel an attended transfer.","tags":["calls"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model55"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/profiles/{profileId}":{"put":{"summary":"Update profile settings","operationId":"putProfilesProfileid","description":"You can update some settings in profile","parameters":[{"name":"profileId","in":"path","schema":{"type":"integer","description":"Profile id."},"description":"Profile id.","required":true}],"tags":["profiles"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model47"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete profile","operationId":"deleteProfilesProfileid","description":"Force profile delete","parameters":[{"name":"profileId","in":"path","schema":{"type":"integer","description":"Profile id."},"description":"Profile id.","required":true}],"tags":["profiles"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/service/reload":{"put":{"summary":"Apply changes","operationId":"putServiceReload","description":"Force Reload. Use hostname or pbxId","parameters":[{"name":"hostname","in":"query","schema":{"type":"string","description":"(deprecated) PBX hostname"},"description":"(deprecated) PBX hostname"},{"name":"pbxId","in":"query","schema":{"type":"number"}},{"name":"type","in":"query","schema":{"type":"string","description":"PBX reload type","default":"full","enum":["full","modular"]},"description":"PBX reload type"}],"tags":["service"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/users/profile":{"put":{"summary":"Set profile to user","operationId":"putUsersProfile","description":"Set profile to user","tags":["users"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model48"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model49"}}}}}}},"/recordings/batch-delete":{"post":{"summary":"Batch delete recordings","operationId":"postRecordingsBatchdelete","description":"Filenames obtained from the CDR. It is possible to delete mp3 and also flac files. You can use a list of file names or a user filter to delete recordings.","parameters":[{"name":"pbxId","in":"query","schema":{"type":"number","description":"Optional pbxId"},"description":"Optional pbxId"}],"tags":["recordings"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model52"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model54"}}}}}}},"/calls/{callId}":{"patch":{"summary":"Update call properties","operationId":"patchCallsCallid","description":"Update allowed call properties.","parameters":[{"name":"callId","in":"path","schema":{"type":"string","description":"linkedid"},"description":"linkedid","required":true}],"tags":["calls"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model56"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}