{"openapi":"3.0.1","info":{"title":"Compass API","version":"v3"},"servers":[{"url":"/"}],"security":[{"basicAuth":[]}],"tags":[{"name":"musiconhold"},{"name":"company"},{"name":"dpSwitch"},{"name":"identity"},{"name":"extension"},{"name":"prompt"},{"name":"phone"},{"name":"reseller"},{"name":"trunk"},{"name":"task"},{"name":"resource"},{"name":"user"},{"name":"phoneModel"},{"name":"externalNumber"},{"name":"queue"},{"name":"voicemail"},{"name":"entity"},{"name":"right"},{"name":"conference"},{"name":"forward"}],"paths":{"/queue/{id}":{"get":{"tags":["queue"],"summary":"Get the details of a queue","operationId":"get_3","parameters":[{"name":"id","in":"path","description":"The id of the queue","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/QueueDto"}}}}}},"put":{"tags":["queue"],"summary":"Replace an existing queue","operationId":"put","parameters":[{"name":"id","in":"path","description":"The id of the queue","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/QueueDto"}}}}}},"delete":{"tags":["queue"],"summary":"Delete resource","operationId":"delete_5","parameters":[{"name":"id","in":"path","description":"The id of the resource","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","description":"Forcefully remove resource by also removing it where it is still in use","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/Unit"}}}}}},"patch":{"tags":["queue"],"summary":"Update an existing queue","operationId":"patch_3","parameters":[{"name":"id","in":"path","description":"The id of the queue","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/QueueDto"}}}}}}},"/prompt/{id}":{"get":{"tags":["prompt"],"summary":"Get the details of a prompt","operationId":"get_4","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}}}}},"put":{"tags":["prompt"],"summary":"Replace an existing prompt","operationId":"put_1","parameters":[{"name":"id","in":"path","description":"The id of the prompt","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}}}}},"delete":{"tags":["prompt"],"summary":"Delete resource","operationId":"delete_6","parameters":[{"name":"id","in":"path","description":"The id of the resource","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","description":"Forcefully remove resource by also removing it where it is still in use","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/Unit"}}}}}},"patch":{"tags":["prompt"],"summary":"Update an existing prompt","operationId":"patch_4","parameters":[{"name":"id","in":"path","description":"The id of the prompt","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}}}}}},"/prompt/{id}/audio":{"get":{"tags":["prompt"],"summary":"Download prompt as wav file","operationId":"downloadAudio","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"audio/wav":{"schema":{"type":"string","format":"binary"}}}}}},"put":{"tags":["prompt"],"summary":"Upload audio file for the prompt","description":"The filename of the input must be specified using a header named X-Filename.\nThe extension of the filename is used to determine the input format.\nThe maximum filesize of uploaded audio files is 10 MB.\n\nSupported file formats:\n\n
OutOfRange
: The specified\npriority was out of range (should be one of\n1,2 or 3)InvalidSyntax
: The callId is empty, or has an invalid format.IdNotFound
: The callId doesn't exist.InsufficientPrivileges
: The user isn't allowed to pick up the call because the user does not have the required privileges.UniqueValueAlreadyUsed
: The requested username is already in use.InvalidSyntax
: The format of the username, full name or e-mail\naddress is not valid.UniqueValueAlreadyUsed
: The requested shortname is already used.\nextension is already in use.InvalidSyntax
: The format of the reseller name is invalid.OutOfRange
: The specified\npriority was out of range (should be one of\n1,2 or 3)UniqueValueAlreadyUsed
: If the extension is already in use.OutOfRange
: The requested extension is not valid.InvalidSyntax
: The format of the username, full name or e-mail\naddress is not valid.PUT /prompt/id/audioendpoint to upload an audio files.","operationId":"createPrompt","parameters":[{"name":"id","in":"path","description":"The id of the company","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}},"required":true},"responses":{"200":{"description":"sequence of prompt objects","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/PromptDto"}}}}}}},"/company/{id}/createPhone":{"post":{"tags":["company"],"summary":"Create a new phone.","operationId":"createPhone","parameters":[{"name":"x-no-redirect","in":"header","description":"Disallow HTTP redirect","required":false,"schema":{"type":"boolean"}},{"name":"id","in":"path","description":"The id of the company","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCreatePhoneInput"}}},"required":true},"responses":{"200":{"description":"If the header \"x-no-redirect\" is set to true, it returns a 200 with the data of a phone.","content":{"application/vnd.iperity.compass.v3+json":{"schema":{"$ref":"#/components/schemas/Compass_Resources_Phone"}}}},"303":{"description":"Without the header or if the header is set to false, it returns a redirect to a phone"}}}},"/company/{id}/createForward":{"post":{"tags":["company"],"summary":"Create a forward for use in a dialplan.","description":"Create a forward for use in a dialplan.\n\nYou must have write rights on the company to create a forward.\n\nError codes:\n\n
OutOfRange
: The specified ringtime was out of range\n(should be one of 0,5,10,15,...,90).InvalidSyntax
: The destination\nhas an invalid syntax (should be either an internal\nextension or an external number (6 digits or more).InvalidSyntax
: The requested number is not valid.OutOfRange
: The requested extension is out of range.\nIt should start a digit in the range 2-9, should have a length\nbetween 2 and 5 digits inclusive and should not be 911.