{ "swagger" : "2.0", "info" : { "description" : "**This documentation of the Alianza Public API is outdated. No further updates will be made to it.**\n\nYou are encouraged to use the [latest API documentation](https://developer.alianza.com/), found at [https://developer.alianza.com/](https://developer.alianza.com/)", "version" : "2", "title" : "Alianza Public API" }, "tags" : [ { "name" : "Address" }, { "name" : "Authorize" }, { "name" : "SSO" }, { "name" : "Language Reference" }, { "name" : "Supported Rate Centers by Alianza and specified carrier" }, { "name" : "Asynchronous JOB Tracker" }, { "name" : "Device Inventory Management" }, { "name" : "Cymbus User Product" }, { "name" : "Device Provisioning" }, { "name" : "Inbound Rate Plan Product" }, { "name" : "Management User" }, { "name" : "Partition" }, { "name" : "Local Calling Areas" }, { "name" : "Report" }, { "name" : "Security Groups" }, { "name" : "Telephone Number" }, { "name" : "Account" }, { "name" : "Account Prevalidate" }, { "name" : "Calling Plan" }, { "name" : "Call Parking Spot" }, { "name" : "CDRs" }, { "name" : "Account Device Line" }, { "name" : "Account Device" }, { "name" : "Dynamic Inventory" }, { "name" : "IVR" }, { "name" : "Media" }, { "name" : "Port" }, { "name" : "Service Activation" }, { "name" : "SIP Trunk" }, { "name" : "Business Line" }, { "name" : "Voicemail Box" }, { "name" : "Business Line Hunt Group" }, { "name" : "Call Group" }, { "name" : "Paging Group" }, { "name" : "Pickup Group" }, { "name" : "Emergency Notification" }, { "name" : "Account User" }, { "name" : "End User" }, { "name" : "Device (Deprecated)" }, { "name" : "Virtual Fax Line" }, { "name" : "Virtual Fax" }, { "name" : "Voicemail Message" }, { "name" : "Calling Plan Product" }, { "name" : "Reference Resources" } ], "paths" : { "/v2/address/validate" : { "get" : { "tags" : [ "Address" ], "summary" : "Validates a address", "description" : "Use to validate a address", "operationId" : "validateAddress", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "address", "in" : "query", "description" : "Address to parse", "required" : true, "type" : "string" }, { "name" : "country", "in" : "query", "description" : "Valid country (current values are USA and CAN", "required" : true, "type" : "string", "enum" : [ "USA", "CAN", "UNK" ] }, { "name" : "postalCode", "in" : "query", "description" : "Postal / Zip code of address", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AddressValidationX", "$ref" : "#/definitions/AddressValidationX" }, "schema" : { "originalRef" : "AddressValidationX", "$ref" : "#/definitions/AddressValidationX" } }, "404" : { "description" : "Address not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AddressValidationX", "$ref" : "#/definitions/AddressValidationX" }, "schema" : { "originalRef" : "AddressValidationX", "$ref" : "#/definitions/AddressValidationX" } }, "404" : { "description" : "Address not found" } } } }, "/v2/address/typeahead" : { "get" : { "tags" : [ "Address" ], "summary" : "Retrieves a list of addresses", "description" : "Use to retrieve a single account", "operationId" : "typeAhead", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "address", "in" : "query", "description" : "Address to parse", "required" : true, "type" : "string" }, { "name" : "country", "in" : "query", "description" : "Valid country (current values are USA and CAN", "required" : true, "type" : "string", "enum" : [ "USA", "CAN", "UNK" ] }, { "name" : "postalCode", "in" : "query", "description" : "Postal / Zip code of address", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string" } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, "404" : { "description" : "Address not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string" } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, "404" : { "description" : "Address not found" } } } }, "/v2/address/state/{state}/city/{city}/zipcode" : { "get" : { "tags" : [ "Address" ], "summary" : "Retrieves a Set of ZipcodeX objects", "description" : "Use to retrieve a zipcodes", "operationId" : "getZipCodeByCityAndState", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "city", "in" : "path", "required" : true, "type" : "string" }, { "name" : "state", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "ZipcodeX", "$ref" : "#/definitions/ZipcodeX" }, "uniqueItems" : true }, "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "ZipcodeX", "$ref" : "#/definitions/ZipcodeX" } } }, "404" : { "description" : "Zipcodes not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "ZipcodeX", "$ref" : "#/definitions/ZipcodeX" }, "uniqueItems" : true }, "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "ZipcodeX", "$ref" : "#/definitions/ZipcodeX" } } }, "404" : { "description" : "Zipcodes not found" } } } }, "/v2/authorize/userinfo" : { "get" : { "tags" : [ "Authorize" ], "summary" : "User Information", "description" : "Return user information for a given token in the header", "operationId" : "getLoginInfo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "401" : { "description" : "ExpiredAuthToken, if invalid token is sent" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "401" : { "description" : "ExpiredAuthToken, if invalid token is sent" } } } }, "/v2/authorize/logout" : { "put" : { "tags" : [ "Authorize" ], "summary" : "Log out a user", "description" : "Log out user for the given token in the header", "operationId" : "logOut", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "401" : { "description" : "ExpiredAuthToken, if invalid token is sent" } }, "responsesObject" : { "401" : { "description" : "ExpiredAuthToken, if invalid token is sent" } } } }, "/v2/authorize/jwt" : { "post" : { "tags" : [ "Authorize" ], "summary" : "Login with token", "description" : "Takes a jwt and returns login token if successfully validates. For validating a jwt, Alianza needs your public key, please contact your account manager.", "operationId" : "loginWithJWT", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "400" : { "description" : " Invalid Login " } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "400" : { "description" : " Invalid Login " } } } }, "/v2/authorize" : { "post" : { "tags" : [ "Authorize" ], "summary" : "Login with login credentials", "description" : "Takes login credentials and returns token if successfully validates ", "operationId" : "logUserIn", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Login credentials", "required" : true, "schema" : { "originalRef" : "Login", "$ref" : "#/definitions/Login" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "400" : { "description" : " Invalid Login " } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "400" : { "description" : " Invalid Login " } } }, "put" : { "tags" : [ "Authorize" ], "summary" : "Update password", "description" : "Used to update an existing password", "operationId" : "changePassword", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Login credentials with new password", "required" : true, "schema" : { "originalRef" : "Login", "$ref" : "#/definitions/Login" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "400" : { "description" : "FailedToUpdate, When new password doesnt satisfies password requirements" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } }, "400" : { "description" : "FailedToUpdate, When new password doesnt satisfies password requirements" } } } }, "/v2/authorize/sso" : { "get" : { "tags" : [ "SSO" ], "summary" : "Get SSO data", "description" : "Returns data needed for the UI to initiate Single Sign On", "operationId" : "getClientId", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SsoDataX", "$ref" : "#/definitions/SsoDataX" }, "schema" : { "originalRef" : "SsoDataX", "$ref" : "#/definitions/SsoDataX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SsoDataX", "$ref" : "#/definitions/SsoDataX" }, "schema" : { "originalRef" : "SsoDataX", "$ref" : "#/definitions/SsoDataX" } } } }, "post" : { "tags" : [ "SSO" ], "summary" : "Authorization Code Exchange", "description" : "Pass the SSO response authorization code here to exchange it for a api authorization token", "operationId" : "getLoginInfo_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "code", "in" : "query", "required" : false, "type" : "string" }, { "name" : "redirect_uri", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" }, "schema" : { "originalRef" : "LoginTokenX", "$ref" : "#/definitions/LoginTokenX" } } } } }, "/v2/language" : { "get" : { "tags" : [ "Language Reference" ], "operationId" : "getLanguageFromHeader", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "LanguageX", "$ref" : "#/definitions/LanguageX" }, "schema" : { "originalRef" : "LanguageX", "$ref" : "#/definitions/LanguageX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "LanguageX", "$ref" : "#/definitions/LanguageX" }, "schema" : { "originalRef" : "LanguageX", "$ref" : "#/definitions/LanguageX" } } } } }, "/v2/supported-rate-centers" : { "get" : { "tags" : [ "Supported Rate Centers by Alianza and specified carrier" ], "summary" : "Get carrier-supported rate centers by proximity", "description" : "", "operationId" : "getClosestAvailableRateCenters", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "type", "in" : "query", "required" : false, "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] }, { "name" : "latitude", "in" : "query", "required" : false, "type" : "number", "format" : "double" }, { "name" : "longitude", "in" : "query", "required" : false, "type" : "number", "format" : "double" }, { "name" : "state", "in" : "query", "required" : false, "type" : "string" }, { "name" : "maxResults", "in" : "query", "required" : false, "type" : "integer", "default" : 5, "format" : "int32" }, { "name" : "distanceUnit", "in" : "query", "required" : false, "type" : "string", "default" : "MILES", "enum" : [ "MILES", "KILOMETERS", "RADIANS" ] }, { "name" : "busOrgId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RateCenterSearchViewX", "$ref" : "#/definitions/RateCenterSearchViewX" }, "schema" : { "originalRef" : "RateCenterSearchViewX", "$ref" : "#/definitions/RateCenterSearchViewX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RateCenterSearchViewX", "$ref" : "#/definitions/RateCenterSearchViewX" }, "schema" : { "originalRef" : "RateCenterSearchViewX", "$ref" : "#/definitions/RateCenterSearchViewX" } } } } }, "/v2/job/{jobId}" : { "get" : { "tags" : [ "Asynchronous JOB Tracker" ], "summary" : "Job", "description" : "Return the specified job", "operationId" : "get", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "jobId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id" } } } }, "/v2/job/input" : { "post" : { "tags" : [ "Asynchronous JOB Tracker" ], "summary" : "Get input url", "description" : "Get a presigned url to upload data to. Also gets a key needed to create the job after the data is uploaded.", "operationId" : "input", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "JobUpload", "$ref" : "#/definitions/JobUpload" }, "schema" : { "originalRef" : "JobUpload", "$ref" : "#/definitions/JobUpload" } }, "401" : { "description" : "Invalid User" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "JobUpload", "$ref" : "#/definitions/JobUpload" }, "schema" : { "originalRef" : "JobUpload", "$ref" : "#/definitions/JobUpload" } }, "401" : { "description" : "Invalid User" } } } }, "/v2/job/{jobId}/input" : { "get" : { "tags" : [ "Asynchronous JOB Tracker" ], "summary" : "Job Input", "description" : "Download the job input", "operationId" : "getInput", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "jobId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" }, "schema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id or if the job has no input" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" }, "schema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id or if the job has no input" } } } }, "/v2/job/{jobId}/output" : { "get" : { "tags" : [ "Asynchronous JOB Tracker" ], "summary" : "Job Output", "description" : "Download the job results output", "operationId" : "getOutput", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "jobId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" }, "schema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id or if the job has no output" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" }, "schema" : { "originalRef" : "InputStream", "$ref" : "#/definitions/InputStream" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id or if the job has no output" } } } }, "/v2/job/{jobId}/output-url" : { "get" : { "tags" : [ "Asynchronous JOB Tracker" ], "summary" : "Job Output url", "description" : "Return the job download url", "operationId" : "getOutputUrl", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "jobId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "JobOutputUrl", "$ref" : "#/definitions/JobOutputUrl" }, "schema" : { "originalRef" : "JobOutputUrl", "$ref" : "#/definitions/JobOutputUrl" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id or if the job has no output" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "JobOutputUrl", "$ref" : "#/definitions/JobOutputUrl" }, "schema" : { "originalRef" : "JobOutputUrl", "$ref" : "#/definitions/JobOutputUrl" } }, "401" : { "description" : "Invalid User" }, "404" : { "description" : "EntityNotFound when there is no job with the given Id or if the job has no output" } } } }, "/v2/partition/{partitionId}/deviceinventory/import" : { "post" : { "tags" : [ "Device Inventory Management" ], "summary" : "Upload bulk device inventory", "description" : "Use to upload a bulk file containing the partition's device inventory", "operationId" : "importDeviceInventory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Use Jobs API to upload file", "required" : false, "schema" : { "originalRef" : "JobUploadKey", "$ref" : "#/definitions/JobUploadKey" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/partition/{partitionId}/deviceinventory" : { "get" : { "tags" : [ "Device Inventory Management" ], "summary" : "Retrieve bulk device inventory", "description" : "Use to retrieve a bulk file containing the partition's device inventory", "operationId" : "allTelephoneNumberCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } }, "deprecated" : true }, "post" : { "tags" : [ "Device Inventory Management" ], "summary" : "Upload bulk device inventory", "description" : "Use to upload a bulk file containing the partition's device inventory", "operationId" : "importDeviceInventory_1", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Service activation event list", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } }, "400" : { "description" : "Invalid service activation event list supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } }, "400" : { "description" : "Invalid service activation event list supplied" }, "404" : { "description" : "Error" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/deviceinventory/export" : { "post" : { "tags" : [ "Device Inventory Management" ], "summary" : "Retrieve bulk device inventory", "description" : "Use to retrieve a bulk file containing the partition's device inventory", "operationId" : "getDeviceInventory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/partition/{partitionId}/deviceinventory/delete" : { "post" : { "tags" : [ "Device Inventory Management" ], "summary" : "Delete bulk device inventory", "description" : "Use to delete a bulk file containing the partition's device inventory", "operationId" : "deleteDeviceInventory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Use Jobs API to upload file", "required" : false, "schema" : { "originalRef" : "JobUploadKey", "$ref" : "#/definitions/JobUploadKey" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/cymbus/partition-group/{partitionId}" : { "get" : { "tags" : [ "Cymbus User Product" ], "summary" : "Retrieve Cymbus group", "description" : "Use to retrieve the Cymbus group associated to a partition", "operationId" : "retrieveCymbusPartitionGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" }, "schema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" }, "schema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" } } } } }, "/v2/cymbus/partition-group" : { "put" : { "tags" : [ "Cymbus User Product" ], "summary" : "Update Cymbus group", "description" : "Use to update specific Cymbus group (only support email and name", "operationId" : "updateCymbusPartitionGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "cymbus partition group object", "required" : true, "schema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" }, "schema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" }, "schema" : { "originalRef" : "CymbusPartitionGroup", "$ref" : "#/definitions/CymbusPartitionGroup" } } } } }, "/v2/partition/{partitionId}/deviceprovisioning/{macAddress}" : { "get" : { "tags" : [ "Device Provisioning" ], "summary" : "Retrieve provisioning information for a specified device", "description" : "Provisioning Information", "operationId" : "getProvisioningByMacAddress", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" }, "schema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" } }, "400" : { "description" : "User not found, partition not found or lack of permissions" }, "404" : { "description" : "Device Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" }, "schema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" } }, "400" : { "description" : "User not found, partition not found or lack of permissions" }, "404" : { "description" : "Device Not found" } } } }, "/v2/partition/{partitionId}/deviceprovisioning/account/{accountid}/device/{deviceid}" : { "get" : { "tags" : [ "Device Provisioning" ], "summary" : "Retrieve provisioning information for a specified deviceid", "description" : "Provisioning Information", "operationId" : "getProvisioningByMacAddress_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountid", "in" : "path", "required" : true, "type" : "string" }, { "name" : "deviceid", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" }, "schema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" } }, "400" : { "description" : "Device not found, partition not found or lack of permissions" }, "404" : { "description" : "Device Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" }, "schema" : { "originalRef" : "RequestedDeviceX", "$ref" : "#/definitions/RequestedDeviceX" } }, "400" : { "description" : "Device not found, partition not found or lack of permissions" }, "404" : { "description" : "Device Not found" } } } }, "/v2/partition/{partitionId}/inboundrateplanproduct/{ratePlanId}" : { "get" : { "tags" : [ "Inbound Rate Plan Product" ], "summary" : "Retrieve an inbound rate plan", "description" : "Use to retrieve an inbound rate plan", "operationId" : "retrieveInboundRatePlan", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "ratePlanId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" }, "schema" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" }, "schema" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" } } } } }, "/v2/partition/{partitionId}/inboundrateplanproduct" : { "get" : { "tags" : [ "Inbound Rate Plan Product" ], "summary" : "Retrieve inbound rate plan list", "description" : "Retrieve a list of inbound rate plans available to a partition", "operationId" : "retrieveInboundRatePlanList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "InboundRatePlanProductX", "$ref" : "#/definitions/InboundRatePlanProductX" } } } } } }, "/v2/partition/{partitionId}/managementuser/{id}" : { "get" : { "tags" : [ "Management User" ], "summary" : "Retrieve a management user", "description" : "Use to retrieve a management user", "operationId" : "retrieve", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Management user ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } } }, "put" : { "tags" : [ "Management User" ], "summary" : "Update a management user", "description" : "Use to update a management user", "operationId" : "update", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Management user ID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Management user object", "required" : true, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } } }, "delete" : { "tags" : [ "Management User" ], "summary" : "Delete management user", "description" : "Use to delete a management user", "operationId" : "delete", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Management user ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } } }, "patch" : { "tags" : [ "Management User" ], "summary" : "Update a management user", "description" : "Use to update a management user", "operationId" : "patch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Management user ID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Management user object", "required" : true, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } } } }, "/v2/partition/{partitionId}/managementuser" : { "get" : { "tags" : [ "Management User" ], "operationId" : "retrieve_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } } } } }, "post" : { "tags" : [ "Management User" ], "summary" : "Create a management user", "description" : "Use to create a management user", "operationId" : "create", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Management user object", "required" : true, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user object" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user object" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/managementuser/search" : { "get" : { "tags" : [ "Management User" ], "summary" : "Search for management users", "description" : "Use to search for management users", "operationId" : "search", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "sortColumn", "in" : "query", "description" : "Sort column", "required" : true, "type" : "string", "enum" : [ "firstName", "lastName", "username" ] }, { "name" : "searchString", "in" : "query", "description" : "Search string", "required" : true, "type" : "string" }, { "name" : "descending", "in" : "query", "description" : "Ordering", "required" : false, "type" : "boolean", "default" : false }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result to return", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Maximum number of results", "required" : false, "type" : "integer", "default" : 50, "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserSearchResponseX", "$ref" : "#/definitions/ManagementUserSearchResponseX" }, "schema" : { "originalRef" : "ManagementUserSearchResponseX", "$ref" : "#/definitions/ManagementUserSearchResponseX" } }, "400" : { "description" : "Invalid information supplied" }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserSearchResponseX", "$ref" : "#/definitions/ManagementUserSearchResponseX" }, "schema" : { "originalRef" : "ManagementUserSearchResponseX", "$ref" : "#/definitions/ManagementUserSearchResponseX" } }, "400" : { "description" : "Invalid information supplied" }, "404" : { "description" : "Management user not found" } } } }, "/v2/partition/{partitionId}/managementuser/usergroups" : { "get" : { "tags" : [ "Management User" ], "summary" : "Retrieve list of management user groups", "description" : "Use to retrieve a list of management user groups", "operationId" : "getUserGroupCSV", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID" }, "404" : { "description" : "Error" } } }, "post" : { "tags" : [ "Management User" ], "summary" : "Create or Update management user groups", "description" : "Use to create or update management user groups", "operationId" : "bulkUpdateUserGroups", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "List of management user groups", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string" } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, "400" : { "description" : "Invalid management user list" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string" } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, "400" : { "description" : "Invalid management user list" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/managementuser/validateproperties" : { "get" : { "tags" : [ "Management User" ], "summary" : "Pre-validate property on the ManagementUser object", "description" : "", "operationId" : "validateProperties", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "email", "in" : "query", "description" : "Email to validate", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/managementuser/{id}/resetpassword" : { "put" : { "tags" : [ "Management User" ], "summary" : "Reset management user password", "description" : "Use to reset the password of a management user", "operationId" : "resetPassword", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Management user ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" }, "schema" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } }, "400" : { "description" : "Invalid management user ID" }, "404" : { "description" : "Management user not found" } } } }, "/v2/partition/{partitionId}/managementuser/{id}/sso" : { "get" : { "tags" : [ "Management User" ], "summary" : "Get a management user's sso status", "description" : "Use to retrieve a management user's sso status", "operationId" : "sso", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Management user ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SsoUserX", "$ref" : "#/definitions/SsoUserX" }, "schema" : { "originalRef" : "SsoUserX", "$ref" : "#/definitions/SsoUserX" } }, "404" : { "description" : "Management user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SsoUserX", "$ref" : "#/definitions/SsoUserX" }, "schema" : { "originalRef" : "SsoUserX", "$ref" : "#/definitions/SsoUserX" } }, "404" : { "description" : "Management user not found" } } } }, "/v2/partition/{partitionId}" : { "get" : { "tags" : [ "Partition" ], "operationId" : "retrieve_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PartitionX", "$ref" : "#/definitions/PartitionX" }, "schema" : { "originalRef" : "PartitionX", "$ref" : "#/definitions/PartitionX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PartitionX", "$ref" : "#/definitions/PartitionX" }, "schema" : { "originalRef" : "PartitionX", "$ref" : "#/definitions/PartitionX" } } } } }, "/v2/partition/{partitionId}/is-di-supported" : { "get" : { "tags" : [ "Partition" ], "summary" : "Checks if dynamic inventory enabled for the specified partition", "description" : "", "operationId" : "isDISupported", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/setting" : { "get" : { "tags" : [ "Partition" ], "summary" : "Get all settings for this partition", "description" : "Use to retrieve a map containing partition specific settings", "operationId" : "getAllSettings", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "originalRef" : "PartitionSettingX", "$ref" : "#/definitions/PartitionSettingX" } }, "schema" : { "type" : "object", "additionalProperties" : { "originalRef" : "PartitionSettingX", "$ref" : "#/definitions/PartitionSettingX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "originalRef" : "PartitionSettingX", "$ref" : "#/definitions/PartitionSettingX" } }, "schema" : { "type" : "object", "additionalProperties" : { "originalRef" : "PartitionSettingX", "$ref" : "#/definitions/PartitionSettingX" } } } } } }, "/v2/partition/{partitionId}/inboundcarriers" : { "get" : { "tags" : [ "Partition" ], "summary" : "Telephone Carriers", "description" : "the inbound carrier list available to this partition", "operationId" : "getInboundCarriers", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "InboundCarrierX", "$ref" : "#/definitions/InboundCarrierX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "InboundCarrierX", "$ref" : "#/definitions/InboundCarrierX" } } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "InboundCarrierX", "$ref" : "#/definitions/InboundCarrierX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "InboundCarrierX", "$ref" : "#/definitions/InboundCarrierX" } } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/deviceinventory_2" : { "get" : { "tags" : [ "Partition" ], "summary" : "Retrieve bulk device inventory", "description" : "Use to retrieve a bulk file containing the partition's device inventory", "operationId" : "allTelephoneNumberCSVReport_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "deprecated" : true }, "post" : { "tags" : [ "Partition" ], "summary" : "Upload bulk device inventory", "description" : "Use to upload a bulk file containing the partition's device inventory", "operationId" : "importDeviceInventory_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Use Jobs API to upload file", "required" : false, "schema" : { "originalRef" : "JobUploadKey", "$ref" : "#/definitions/JobUploadKey" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/data-history" : { "get" : { "tags" : [ "Partition" ], "operationId" : "partitionDataHistorySearch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "startDate", "in" : "query", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "required" : false, "type" : "string" }, { "name" : "tag", "in" : "query", "required" : false, "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi" }, { "name" : "firstResultIndex", "in" : "query", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "required" : false, "type" : "integer", "default" : 20, "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PartitionDataHistorySearchResponseX", "$ref" : "#/definitions/PartitionDataHistorySearchResponseX" }, "schema" : { "originalRef" : "PartitionDataHistorySearchResponseX", "$ref" : "#/definitions/PartitionDataHistorySearchResponseX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PartitionDataHistorySearchResponseX", "$ref" : "#/definitions/PartitionDataHistorySearchResponseX" }, "schema" : { "originalRef" : "PartitionDataHistorySearchResponseX", "$ref" : "#/definitions/PartitionDataHistorySearchResponseX" } } } } }, "/v2/partition/{partitionId}/localprefixes/export/csv" : { "get" : { "tags" : [ "Local Calling Areas" ], "operationId" : "allTelephoneNumberCSVReport_1", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" }, "schema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" }, "schema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" } } } } }, "/v2/partition/{partitionId}/localprefixes/import" : { "post" : { "tags" : [ "Local Calling Areas" ], "operationId" : "importLocalAreas", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "List of prefix allowables - EX: 801,801|485|901", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } } } } }, "/v2/partition/{partitionId}/report/portout/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve telephone number port out in CSV format", "description" : "Use to retrieve a CSV formatted telephone number port out report", "operationId" : "telephoneNumberPortOutCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/portout/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve telephone number port out in CSV format", "description" : "Use to retrieve a CSV formatted telephone number port out report", "operationId" : "telephoneNumberPortOutCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/emergencynotificationcompliance/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Business Lines report in CSV format", "description" : "Use to retrieve a CSV formatted Business Lines report", "operationId" : "emergencyNotificationComplianceReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/user" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve user summary report", "description" : "Use to retrieve a list", "operationId" : "userSummaryReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/device" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve user summary report", "description" : "Use to retrieve a list", "operationId" : "deviceSummaryReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/device/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve device report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "deviceCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/device/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve device report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "deviceCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/device/csv_3" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve device report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "deviceCSVReport3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/tn" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve telephone number summary report", "description" : "Use to retrieve the telephone number summary report", "operationId" : "telephoneNumberSummaryReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/tn/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve telephone number summary report in CSV format", "description" : "Use to retrieve a CSV formatted telephone number summary report", "operationId" : "telephoneNumberCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/tn/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve telephone number summary report in CSV format", "description" : "Use to retrieve a CSV formatted telephone number summary report", "operationId" : "telephoneNumberCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/sip" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve SIP summary report", "description" : "Use to retrieve the SIP summary report", "operationId" : "sipSummaryReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/account/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve account report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "accountCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/account/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve account report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "accountCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/account/csv_3" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve account report in CSV format. Uses new Data API to retrieve data.", "description" : "Use to retrieve a CSV formatted list", "operationId" : "accountCSVReport3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/accounthistory/enduserchanges" : { "get" : { "tags" : [ "Report" ], "operationId" : "endUserAccountHistory", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : true, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" }, "schema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" }, "schema" : { "originalRef" : "StreamingOutput", "$ref" : "#/definitions/StreamingOutput" } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/accounthistory/enduserchanges_2" : { "get" : { "tags" : [ "Report" ], "operationId" : "endUserAccountHistory2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : true, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/vfax" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Virtual Fax summary report", "description" : "Use to retrieve the Virtual Fax summary report", "operationId" : "vFaxSummaryReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/line" : { "get" : { "tags" : [ "Report" ], "operationId" : "mockLineSummary", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" }, "schema" : { "originalRef" : "ReportSummaryX", "$ref" : "#/definitions/ReportSummaryX" } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/businesslines/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Business Lines report in CSV format", "description" : "Use to retrieve a CSV formatted Business Lines report", "operationId" : "businessLinesCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/deviceregistration/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve on demand Device Registration report in CSV format", "description" : "Use to retrieve a CSV formatted current devices registered", "operationId" : "deviceRegistrationReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/user-products/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Users and the Product selected report in CSV format", "description" : "Use to retrieve a CSV formatted User Products report", "operationId" : "userProductsReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/specialtylines/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Specialty Lines report in CSV format", "description" : "Use to retrieve a CSV formatted Specialty Lines report", "operationId" : "specialtyLinesReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/contact_center_usage/csv_1" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Contact Center Usage report in CSV format", "description" : "Use to retrieve a CSV formatted Contact Center Usage report", "operationId" : "contactCenterUsageReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/contact_center_retail/csv_1" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Contact Center Retail report in CSV format", "description" : "Use to retrieve a CSV formatted Contact Center Retail report", "operationId" : "contactCenterRetailReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/sip/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve SIP summary report in CSV format", "description" : "Use to retrieve a CSV formatted SIP summary report", "operationId" : "sipCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/user/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve user summary report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "userCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/sip/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve SIP summary report in CSV format", "description" : "Use to retrieve a CSV formatted SIP summary report", "operationId" : "sipCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/user/csv_3" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve user summary report in CSV format. Uses new Data API to retrieve data.", "description" : "Use to retrieve a CSV formatted list", "operationId" : "userCSVReport3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/user/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve user summary report in CSV format", "description" : "Use to retrieve a CSV formatted list", "operationId" : "userCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "description" : "Year", "required" : true, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "description" : "Month", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/vfax/csv" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Virtual Fax report in CSV format", "description" : "Use to retrieve a CSV formatted Virtual Fax report", "operationId" : "vFaxCSVReport", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/report/vfax/csv_2" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve Virtual Fax report in CSV format", "description" : "Use to retrieve a CSV formatted Virtual Fax report", "operationId" : "vFaxCSVReport2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/report/msteams/csv_1" : { "get" : { "tags" : [ "Report" ], "summary" : "Retrieve MS Teams report in CSV format", "description" : "Use to retrieve a CSV formatted MS Teams report", "operationId" : "msTeamsReport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "year", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "month", "in" : "query", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/security/{securityId}" : { "get" : { "tags" : [ "Security Groups" ], "summary" : "Retrieve Security Role", "description" : "Use to get a specific security roles", "operationId" : "retrieve_4", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "securityId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Partition or Security Role" }, "404" : { "description" : "Security Role is not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Partition or Security Role" }, "404" : { "description" : "Security Role is not found" } } }, "put" : { "tags" : [ "Security Groups" ], "summary" : "Update Security Role", "description" : "Use to update a specific security roles", "operationId" : "update_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "securityId", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Security Role" }, "404" : { "description" : "Security Role is not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Security Role" }, "404" : { "description" : "Security Role is not found" } } }, "delete" : { "tags" : [ "Security Groups" ], "summary" : "Delete Security Role", "description" : "Use to delete a security roles", "operationId" : "delete_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "securityId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Invalid Security Role" }, "404" : { "description" : "Security Role is not found" } }, "responsesObject" : { "400" : { "description" : "Invalid Security Role" }, "404" : { "description" : "Security Role is not found" } } }, "patch" : { "tags" : [ "Security Groups" ], "summary" : "Update Security Role", "description" : "Use to update a specific security roles", "operationId" : "patch_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "securityId", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Security Role" }, "404" : { "description" : "Security Role is not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Security Role" }, "404" : { "description" : "Security Role is not found" } } } }, "/v2/partition/{partitionId}/security" : { "get" : { "tags" : [ "Security Groups" ], "summary" : "Retrieve Security Roles", "description" : "Use to get a list of security roles", "operationId" : "retrieve_3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } } }, "400" : { "description" : "Invalid Partition" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } } }, "400" : { "description" : "Invalid Partition" } } }, "post" : { "tags" : [ "Security Groups" ], "summary" : "Create Security Role", "description" : "Use to create a security roles", "operationId" : "create_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Security Role" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" }, "schema" : { "originalRef" : "SecurityRoleX", "$ref" : "#/definitions/SecurityRoleX" } }, "400" : { "description" : "Invalid Security Role" } } } }, "/v2/partition/{partitionId}/telephonenumber" : { "get" : { "tags" : [ "Telephone Number" ], "operationId" : "retrieve_5", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } } } } }, "post" : { "tags" : [ "Telephone Number" ], "summary" : "Create telephone number", "description" : "Use to create a telephone number", "operationId" : "createTelephoneNumber", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number object", "required" : true, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" }, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" }, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/{tn}" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Retrieve telephone number", "description" : "Use to retrieve information about a telephone number", "operationId" : "retrieveTelephoneNumber", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" }, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "400" : { "description" : "Invalid telephone number supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" }, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "400" : { "description" : "Invalid telephone number supplied" }, "404" : { "description" : "Telephone number not found" } } }, "delete" : { "tags" : [ "Telephone Number" ], "summary" : "Delete telephone number", "description" : "Use to delete a telephone number", "operationId" : "delete_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid telephone number supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid telephone number supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/search" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Telephone number search", "description" : "Use to search for a telephone number", "operationId" : "search_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "q", "in" : "query", "description" : "Query Field: q=18015551212, q=84062, q=ALBANY, q=ALBANY.NY, LAT_LONG does not use this field", "required" : false, "type" : "string" }, { "name" : "functiontype", "in" : "query", "description" : "Function Type, default ELS", "required" : false, "type" : "string", "default" : "ELS", "enum" : [ "ELS", "TollFree", "TemporaryNumber", "SPTN" ] }, { "name" : "type", "in" : "query", "description" : "Search Type, default POSTALCODE_OR_TN", "required" : false, "type" : "string", "default" : "POSTALCODE_OR_TN", "enum" : [ "POSTALCODE_OR_TN", "TN", "POSTALCODE", "LAT_LONG", "RATECENTER", "RATECENTER_CARRIER" ] }, { "name" : "lat", "in" : "query", "description" : "Latitude, requires type=LAT_LONG", "required" : false, "type" : "number", "format" : "double" }, { "name" : "long", "in" : "query", "description" : "Latitude, requires type=LAT_LONG", "required" : false, "type" : "number", "format" : "double" }, { "name" : "maxResults", "in" : "query", "description" : "Number of results to return", "required" : false, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } } }, "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } } }, "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/{tn}/availability" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Retrieve telephone number availability", "description" : "Use to retrieve information about a telephone number availability", "operationId" : "retrieveTelephoneNumberAvailability", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAvailabilityX", "$ref" : "#/definitions/TelephoneNumberAvailabilityX" }, "schema" : { "originalRef" : "TelephoneNumberAvailabilityX", "$ref" : "#/definitions/TelephoneNumberAvailabilityX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAvailabilityX", "$ref" : "#/definitions/TelephoneNumberAvailabilityX" }, "schema" : { "originalRef" : "TelephoneNumberAvailabilityX", "$ref" : "#/definitions/TelephoneNumberAvailabilityX" } } } } }, "/v2/partition/{partitionId}/telephonenumber/bulkimport" : { "post" : { "tags" : [ "Telephone Number" ], "summary" : "Bulk telephone number import", "description" : "Use to import telephone numbers in bulk", "operationId" : "bulkInsert", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number list", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string" } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, "400" : { "description" : "Invalid telephone number list supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string" } }, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, "400" : { "description" : "Invalid telephone number list supplied" }, "404" : { "description" : "Error" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/telephonenumber/bulkimport_2" : { "post" : { "tags" : [ "Telephone Number" ], "summary" : "Bulk telephone number import", "description" : "Use to import telephone numbers in bulk", "operationId" : "bulkInsert2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Use Jobs API to upload file", "required" : false, "schema" : { "originalRef" : "JobUploadKey", "$ref" : "#/definitions/JobUploadKey" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/partition/{partitionId}/telephonenumber/exportstatussearch" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Export as CSV telephone number status search", "description" : "Use to export the searched status of a telephone number as a CSV file", "operationId" : "exportStatusSearch", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "dateType", "in" : "query", "description" : "Type of data", "required" : false, "type" : "string", "enum" : [ "FOCDate", "UpdatedDate", "CreatedDate" ] }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : false, "type" : "string" }, { "name" : "statusType", "in" : "query", "description" : "Status type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "PENDING", "IN_PROGRESS", "REJECTED", "FOC_RECEIVED", "FOC_REMOVED", "CANCELLED", "CANCEL_PENDING", "CARRIER_CANCELLED", "DELETE_PENDING", "DELETE_SCHEDULED", "COMPLETED", "CORRECTED_COMPLETED", "COOLDOWN", "HOT_CUT_PORT", "ON_HOLD", "RESELLER_PENDING" ] }, "collectionFormat" : "multi" }, { "name" : "eventType", "in" : "query", "description" : "Service activation event type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "PORT_REQUEST", "CSR_CHANGE_REQUEST", "ACTIVATION", "NINE_ONE_ONE_ADDRESS", "DISCONNECT", "DYNAMIC_RESERVATION", "BYOTN_REQUEST", "SERVICE_PROVIDER_TN" ] }, "collectionFormat" : "multi" }, { "name" : "accountId", "in" : "query", "description" : "Account ID", "required" : false, "type" : "string" }, { "name" : "telephoneNumber", "in" : "query", "description" : "Telephone number", "required" : false, "type" : "string" }, { "name" : "includeSubTns", "in" : "query", "description" : "Include Sub Tns", "required" : false, "type" : "boolean", "default" : true } ], "responses" : { "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/exportstatussearch_2" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Export as CSV telephone number status search", "description" : "Use to export the searched status of a telephone number as a CSV file", "operationId" : "exportStatusSearch2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "dateType", "in" : "query", "description" : "Type of data", "required" : false, "type" : "string", "enum" : [ "FOCDate", "UpdatedDate", "CreatedDate" ] }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : false, "type" : "string" }, { "name" : "statusType", "in" : "query", "description" : "Status type", "required" : false, "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi" }, { "name" : "eventType", "in" : "query", "description" : "Service activation event type", "required" : false, "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi" }, { "name" : "accountId", "in" : "query", "description" : "Account ID", "required" : false, "type" : "string" }, { "name" : "telephoneNumber", "in" : "query", "description" : "Telephone number", "required" : false, "type" : "string" }, { "name" : "includeSubTns", "in" : "query", "description" : "Include Sub Tns", "required" : false, "type" : "boolean", "default" : true } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" }, "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/{tn}/cooldown/recover" : { "put" : { "tags" : [ "Telephone Number" ], "summary" : "Delete telephone number cooldown", "description" : "Use to delete a cooldown for a telephone number", "operationId" : "cooldownRecover", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" }, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" }, "schema" : { "originalRef" : "TelephoneNumberViewX", "$ref" : "#/definitions/TelephoneNumberViewX" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/{tn}/reserve" : { "put" : { "tags" : [ "Telephone Number" ], "summary" : "Reserve a telephone number", "description" : "Use to reserve a telephone number so another use cannot get it", "operationId" : "reserve", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberReservedX", "$ref" : "#/definitions/TelephoneNumberReservedX" }, "schema" : { "originalRef" : "TelephoneNumberReservedX", "$ref" : "#/definitions/TelephoneNumberReservedX" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberReservedX", "$ref" : "#/definitions/TelephoneNumberReservedX" }, "schema" : { "originalRef" : "TelephoneNumberReservedX", "$ref" : "#/definitions/TelephoneNumberReservedX" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } } }, "delete" : { "tags" : [ "Telephone Number" ], "summary" : "Delete a reserve on telephone number", "description" : "Use to delete a reservation on a telephone number making it available for use by another", "operationId" : "releaseReservation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/statussearch" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Telephone number status search", "description" : "Use to search for the status of a telephone number", "operationId" : "statusSearch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "dateType", "in" : "query", "description" : "Type of data", "required" : false, "type" : "string", "enum" : [ "FOCDate", "UpdatedDate", "CreatedDate" ] }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : false, "type" : "string" }, { "name" : "statusType", "in" : "query", "description" : "Status type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "PENDING", "IN_PROGRESS", "REJECTED", "FOC_RECEIVED", "FOC_REMOVED", "CANCELLED", "CANCEL_PENDING", "CARRIER_CANCELLED", "DELETE_PENDING", "DELETE_SCHEDULED", "COMPLETED", "CORRECTED_COMPLETED", "COOLDOWN", "HOT_CUT_PORT", "ON_HOLD", "RESELLER_PENDING" ] }, "collectionFormat" : "multi" }, { "name" : "eventType", "in" : "query", "description" : "Service activation event type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "PORT_REQUEST", "CSR_CHANGE_REQUEST", "ACTIVATION", "NINE_ONE_ONE_ADDRESS", "DISCONNECT", "DYNAMIC_RESERVATION", "BYOTN_REQUEST", "SERVICE_PROVIDER_TN" ] }, "collectionFormat" : "multi" }, { "name" : "accountId", "in" : "query", "description" : "Account ID", "required" : false, "type" : "string" }, { "name" : "telephoneNumber", "in" : "query", "description" : "Telephone number", "required" : false, "type" : "string" }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result index", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Max results", "required" : false, "type" : "integer", "default" : 50, "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ServiceActivationEventResponseX", "$ref" : "#/definitions/ServiceActivationEventResponseX" }, "schema" : { "originalRef" : "ServiceActivationEventResponseX", "$ref" : "#/definitions/ServiceActivationEventResponseX" } }, "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ServiceActivationEventResponseX", "$ref" : "#/definitions/ServiceActivationEventResponseX" }, "schema" : { "originalRef" : "ServiceActivationEventResponseX", "$ref" : "#/definitions/ServiceActivationEventResponseX" } }, "400" : { "description" : "Invalid search term supplied" }, "404" : { "description" : "Error" } } } }, "/v2/partition/{partitionId}/telephonenumber/{tn}/fmfmcheck" : { "get" : { "tags" : [ "Telephone Number" ], "operationId" : "isTnOffNet", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/telephonenumber/export" : { "get" : { "tags" : [ "Telephone Number" ], "operationId" : "getInventoryPlan", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } } } }, "/v2/partition/{partitionId}/telephonenumber/export_2" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Export telephone numbers as csv", "description" : "", "operationId" : "getInventoryPlan2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/partition/{partitionId}/account/activation/multiple" : { "post" : { "tags" : [ "Account" ], "summary" : "Multi Line Account Activation", "description" : "Use to activate account with multiple users/devices/telephone numbers", "operationId" : "multipleActivation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Multiple activation object", "required" : true, "schema" : { "originalRef" : "MultipleActivationX", "$ref" : "#/definitions/MultipleActivationX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "MultipleActivationX", "$ref" : "#/definitions/MultipleActivationX" }, "schema" : { "originalRef" : "MultipleActivationX", "$ref" : "#/definitions/MultipleActivationX" } }, "400" : { "description" : "Invalid account activation object supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "MultipleActivationX", "$ref" : "#/definitions/MultipleActivationX" }, "schema" : { "originalRef" : "MultipleActivationX", "$ref" : "#/definitions/MultipleActivationX" } }, "400" : { "description" : "Invalid account activation object supplied" }, "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/activation" : { "post" : { "tags" : [ "Account" ], "summary" : "Account activation", "description" : "(DEPRECATED) Use to activate an account", "operationId" : "activation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account activation object", "required" : true, "schema" : { "originalRef" : "AccountActivationV2X", "$ref" : "#/definitions/AccountActivationV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountActivationV2X", "$ref" : "#/definitions/AccountActivationV2X" }, "schema" : { "originalRef" : "AccountActivationV2X", "$ref" : "#/definitions/AccountActivationV2X" } }, "400" : { "description" : "Invalid account activation object supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountActivationV2X", "$ref" : "#/definitions/AccountActivationV2X" }, "schema" : { "originalRef" : "AccountActivationV2X", "$ref" : "#/definitions/AccountActivationV2X" } }, "400" : { "description" : "Invalid account activation object supplied" }, "404" : { "description" : "Account not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account" : { "get" : { "tags" : [ "Account" ], "operationId" : "retrieve_6", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } } } } }, "post" : { "tags" : [ "Account" ], "summary" : "Create account", "description" : "Use to create an account", "operationId" : "createAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account object", "required" : true, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid account object supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid account object supplied" }, "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/search" : { "get" : { "tags" : [ "Account" ], "summary" : "Account search", "description" : "Use to search for an account", "operationId" : "search_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "q", "in" : "query", "description" : "Search term for account search", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } } }, "400" : { "description" : "Invalid partition ID or search term supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } } }, "400" : { "description" : "Invalid partition ID or search term supplied" }, "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/accounthistorysearch" : { "get" : { "tags" : [ "Account" ], "summary" : "Account history record search", "description" : "Use to search for account history records", "operationId" : "accountHistoryByAccountNumberSearch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountNumber", "in" : "query", "description" : "Account Number, required", "required" : false, "type" : "string" }, { "name" : "accountHistoryType", "in" : "query", "description" : "Account history type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "PHONE_NUMBER", "PROVISIONING", "CALL_FORWARDING", "CALL_SCREENING", "ADDRESS", "ADDRESS_CSR", "ADDRESS_E911", "ADDRESS_DIRECTORY_LISTING", "ACCOUNT_STATUS", "VOICEMAIL", "CALLING_PLAN", "INBOUND_CALLING_PLAN", "IVR", "SIP_TRUNK", "SIP_TRUNK_FORWARD", "SIP_TRUNK_GROUP", "DEVICE", "DEVICE_METADATA", "USER", "USER_API_AUTH", "LINE_HUNTGROUP", "ACCOUNT", "LINE_APPEARANCE", "LINE_HARDWARE", "VFAX", "PAGING_GROUP", "PICKUP_GROUP", "GROUP_OF_REFERENCES", "CALL_PARKING_SPOT", "ACCOUNT_USER", "SIP_CREDENTIALS", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "USER_DEVICE_LINE", "EMERGENCY_NOTIFICATION", "DYNAMIC_RESERVATION", "SPECIALTY_LINE", "AUTHORITY", "AUTO_ATTENDANT", "CONTACT", "CONTACT_CENTER", "CALL_RECORDING", "ACCOUNT_CODE", "SHORT_CODE", "MEDIA_MANAGEMENT", "SOUNDS", "USER_GROUP" ] }, "collectionFormat" : "multi" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : false, "type" : "string" }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result to display, defaults to 0", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Maximum number to return, defaults to 20", "required" : false, "type" : "integer", "default" : 20, "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" }, "schema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" }, "schema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/bulkstatuschange" : { "post" : { "tags" : [ "Account" ], "summary" : "Change account status in bulk", "description" : "Use to change multiple account statuses", "operationId" : "bulkStatusChange", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "List of numbers", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } }, "400" : { "description" : "Invalid information supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } }, "400" : { "description" : "Invalid information supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/bulkstatuschange_2" : { "post" : { "tags" : [ "Account" ], "summary" : "Change account status in bulk", "description" : "Use to change multiple account statuses", "operationId" : "bulkStatusChange_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Use Jobs API to upload file", "required" : false, "schema" : { "originalRef" : "JobUploadKey", "$ref" : "#/definitions/JobUploadKey" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/partition/{partitionId}/account/frequentlyaccessed" : { "get" : { "tags" : [ "Account" ], "summary" : "Frequently accessed account search", "description" : "Use to list all frequently accessed accounts", "operationId" : "frequentlyAccessed", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } } }, "400" : { "description" : "Invalid partition ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } } }, "400" : { "description" : "Invalid partition ID" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/recentlyaccessed" : { "get" : { "tags" : [ "Account" ], "summary" : "Recently accessed account search", "description" : "Use to list all recently accessed accounts", "operationId" : "recentlyAccessed", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } } }, "400" : { "description" : "Invalid partition ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountViewX", "$ref" : "#/definitions/AccountViewX" } } }, "400" : { "description" : "Invalid partition ID" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/validateproperties" : { "get" : { "tags" : [ "Account" ], "summary" : "Pre-validate property on the Account object", "description" : "", "operationId" : "validateProperties_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountnumber", "in" : "query", "description" : "Account Number", "required" : false, "type" : "string" }, { "name" : "username", "in" : "query", "description" : "Username to validate", "required" : false, "type" : "string" }, { "name" : "macaddress", "in" : "query", "description" : "Mac address", "required" : false, "type" : "string" }, { "name" : "sipusername", "in" : "query", "description" : "Sip Username", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/account/prevalidate" : { "post" : { "tags" : [ "Account Prevalidate" ], "summary" : "Prevalidate a phone number", "description" : "Use to prevalidate a telephone number", "operationId" : "preValidateAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number activation object", "required" : true, "schema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAvailabilityResponseV2X", "$ref" : "#/definitions/PortAvailabilityResponseV2X" }, "schema" : { "originalRef" : "PortAvailabilityResponseV2X", "$ref" : "#/definitions/PortAvailabilityResponseV2X" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAvailabilityResponseV2X", "$ref" : "#/definitions/PortAvailabilityResponseV2X" }, "schema" : { "originalRef" : "PortAvailabilityResponseV2X", "$ref" : "#/definitions/PortAvailabilityResponseV2X" } }, "400" : { "description" : "Invalid telephone number object supplied" }, "404" : { "description" : "Telephone number not found" } } } }, "/v2/partition/{partitionId}/account/e911/prevalidate" : { "put" : { "tags" : [ "Account Prevalidate" ], "summary" : "Prevalidate an address for 911", "description" : "Use to prevalidate an address for 911", "operationId" : "preValidateAccountTn", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number activation object", "required" : true, "schema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "E911PrevalidateResponseX", "$ref" : "#/definitions/E911PrevalidateResponseX" }, "schema" : { "originalRef" : "E911PrevalidateResponseX", "$ref" : "#/definitions/E911PrevalidateResponseX" } }, "400" : { "description" : "Invalid telephone number" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "E911PrevalidateResponseX", "$ref" : "#/definitions/E911PrevalidateResponseX" }, "schema" : { "originalRef" : "E911PrevalidateResponseX", "$ref" : "#/definitions/E911PrevalidateResponseX" } }, "400" : { "description" : "Invalid telephone number" } } } }, "/v2/partition/{partitionId}/account/{accountId}/callingplan" : { "get" : { "tags" : [ "Calling Plan" ], "summary" : "Get Calling Plans for a given reference", "description" : "will get a callingplan", "operationId" : "getPlans", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "referenceType", "in" : "query", "required" : false, "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "IVR", "ACCOUNT", "SPECIALTY_LINE", "CONTACT_CENTER" ] }, { "name" : "referenceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Reference or Calling Plan Product not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Reference or Calling Plan Product not found" } } }, "put" : { "tags" : [ "Calling Plan" ], "summary" : "Add Calling Plan for a given reference", "description" : "will add a callingplan", "operationId" : "addPlan", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "ModifyCallingPlanX", "$ref" : "#/definitions/ModifyCallingPlanX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" }, "schema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Reference or Calling Plan Product not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" }, "schema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Reference or Calling Plan Product not found" } } }, "delete" : { "tags" : [ "Calling Plan" ], "summary" : "Remove Calling Plan for a given reference", "description" : "will remove a callingplan", "operationId" : "removePlan", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "ModifyCallingPlanX", "$ref" : "#/definitions/ModifyCallingPlanX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" }, "schema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Reference or Calling Plan Product not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" }, "schema" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Reference or Calling Plan Product not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}" : { "get" : { "tags" : [ "Account" ], "summary" : "Retrieve account by ID", "description" : "Use to retrieve a single account", "operationId" : "retrieveAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "accountIdType", "in" : "query", "description" : "Defines if the ID is the account id or the account number. Default is Id. Possible Values are Id, AccountNumber", "required" : false, "type" : "string", "default" : "Id", "enum" : [ "Id", "AccountNumber", "PhoneNumber", "MacAddress" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } } }, "put" : { "tags" : [ "Account" ], "summary" : "Update account", "description" : "Use to update an account", "operationId" : "updateAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account object", "required" : true, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } } }, "delete" : { "tags" : [ "Account" ], "summary" : "Delete account", "description" : "Use to delete an account", "operationId" : "deleteAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } } }, "patch" : { "tags" : [ "Account" ], "summary" : "Update account", "description" : "Use to update an account", "operationId" : "patch_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account object", "required" : true, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "schema" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/macaddress/{macAddress}/inventory" : { "get" : { "tags" : [ "Account" ], "summary" : "Determine which lines are available on a device/mac", "description" : "Uses to determine which lines are available on a device/mac, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline?filterType=MAC_ADDRESS_INVENTORY&filter={mac} endpoint instead", "operationId" : "findAllAvailableDevicesByMacAddress", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Not in inventory, not available, in use" }, "404" : { "description" : "Device type not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Not in inventory, not available, in use" }, "404" : { "description" : "Device type not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/accounthistorysearch" : { "get" : { "tags" : [ "Account" ], "summary" : "Account history record search", "description" : "Use to search for account history records", "operationId" : "accountHistoryByAccountIdSearch", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "accountHistoryType", "in" : "query", "description" : "Account history type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "PHONE_NUMBER", "PROVISIONING", "CALL_FORWARDING", "CALL_SCREENING", "ADDRESS", "ADDRESS_CSR", "ADDRESS_E911", "ADDRESS_DIRECTORY_LISTING", "ACCOUNT_STATUS", "VOICEMAIL", "CALLING_PLAN", "INBOUND_CALLING_PLAN", "IVR", "SIP_TRUNK", "SIP_TRUNK_FORWARD", "SIP_TRUNK_GROUP", "DEVICE", "DEVICE_METADATA", "USER", "USER_API_AUTH", "LINE_HUNTGROUP", "ACCOUNT", "LINE_APPEARANCE", "LINE_HARDWARE", "VFAX", "PAGING_GROUP", "PICKUP_GROUP", "GROUP_OF_REFERENCES", "CALL_PARKING_SPOT", "ACCOUNT_USER", "SIP_CREDENTIALS", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "USER_DEVICE_LINE", "EMERGENCY_NOTIFICATION", "DYNAMIC_RESERVATION", "SPECIALTY_LINE", "AUTHORITY", "AUTO_ATTENDANT", "CONTACT", "CONTACT_CENTER", "CALL_RECORDING", "ACCOUNT_CODE", "SHORT_CODE", "MEDIA_MANAGEMENT", "SOUNDS", "USER_GROUP" ] }, "collectionFormat" : "multi" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : false, "type" : "string" }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result to display, defaults to 0", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Maximum number to return, defaults to 20", "required" : false, "type" : "integer", "default" : 20, "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" }, "schema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" }, "schema" : { "originalRef" : "AccountHistorySearchResponseX", "$ref" : "#/definitions/AccountHistorySearchResponseX" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/send-welcome-email" : { "post" : { "tags" : [ "Account" ], "summary" : "Send welcome email to all users that was not sent it before", "description" : "Used to send an welcome email to all users in the account", "operationId" : "sendWelcomeEmailToAll", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "404" : { "description" : "Account not found" } }, "responsesObject" : { "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/callingplanproduct/{callingPlanProductId}" : { "put" : { "tags" : [ "Account" ], "summary" : "Change Calling Plan", "description" : "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan. If a pending calling plan already exists it will remove it and set the new calling plan", "operationId" : "changeCallingPlan", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "callingPlanProductId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account or Calling Plan Product not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account or Calling Plan Product not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/callingplanswap" : { "post" : { "tags" : [ "Account" ], "summary" : "Change Calling Plan Immediately", "description" : "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan", "operationId" : "swapCallingPlan", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "CallingPlanSwapX", "$ref" : "#/definitions/CallingPlanSwapX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account or Calling Plan Product not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account or Calling Plan Product not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/cancelpendingcallingplan" : { "delete" : { "tags" : [ "Account" ], "summary" : " Cancel Pending Callingplan", "description" : "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan", "operationId" : "cancelPendingCallingPlan", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/macaddress/{macAddress}" : { "get" : { "tags" : [ "Account" ], "operationId" : "getDeviceDataForAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "AccountDeviceDataX", "$ref" : "#/definitions/AccountDeviceDataX" }, "schema" : { "originalRef" : "AccountDeviceDataX", "$ref" : "#/definitions/AccountDeviceDataX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "AccountDeviceDataX", "$ref" : "#/definitions/AccountDeviceDataX" }, "schema" : { "originalRef" : "AccountDeviceDataX", "$ref" : "#/definitions/AccountDeviceDataX" } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user-product-plans" : { "get" : { "tags" : [ "Account" ], "summary" : "Account Available User Product Plans", "description" : "Use to retrieve product plans available to an account", "operationId" : "getAvailableUserProductPlans", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "UserProductPlanX", "$ref" : "#/definitions/UserProductPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "UserProductPlanX", "$ref" : "#/definitions/UserProductPlanX" } } }, "400" : { "description" : "Invalid account id" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "UserProductPlanX", "$ref" : "#/definitions/UserProductPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "UserProductPlanX", "$ref" : "#/definitions/UserProductPlanX" } } }, "400" : { "description" : "Invalid account id" } } } }, "/v2/partition/{partitionId}/account/{accountId}/status" : { "get" : { "tags" : [ "Account" ], "summary" : "Account status", "description" : "Use to retrieve the status of a account", "operationId" : "getStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/devices" : { "get" : { "tags" : [ "Account" ], "summary" : "Devices on an Account", "description" : "Used to list all devices on an account, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead", "operationId" : "listDevicesDeprecated", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Invalid account id" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Invalid account id" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/callpark" : { "get" : { "tags" : [ "Call Parking Spot" ], "summary" : "Get call parking spot list", "description" : "Use to retrieve a list of call parking spots.", "operationId" : "getAllCallParkingSpots", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Call Parking Spot" ], "summary" : "Create call parking spot", "description" : "Use to create a call parking spot", "operationId" : "createCallParkingSpot", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Call Parking Spot object", "required" : true, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid call parking spot object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid call parking spot object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/callpark/{spotId}" : { "get" : { "tags" : [ "Call Parking Spot" ], "summary" : "Retrieve call parking spot", "description" : "Use to retrieve a call parking spot", "operationId" : "getCallParkingSpot", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "spotId", "in" : "path", "description" : "ID of call parking spot", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid account ID or call parking spot ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid account ID or call parking spot ID" }, "404" : { "description" : "Not found" } } }, "put" : { "tags" : [ "Call Parking Spot" ], "summary" : "Update call parking spot", "description" : "Use to update a call parking spot", "operationId" : "updateCallParkingSpot", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "spotId", "in" : "path", "description" : "ID of call parking spot", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Call parking spot object", "required" : true, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid call parking spot ID or call parking spot object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid call parking spot ID or call parking spot object" }, "404" : { "description" : "Not found" } } }, "delete" : { "tags" : [ "Call Parking Spot" ], "summary" : "Delete call parking spot", "description" : "Use to delete a call parking spot", "operationId" : "deleteCallParkingSpot", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "spotId", "in" : "path", "description" : "ID of call parking spot", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid call parking spot ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid call parking spot ID" }, "404" : { "description" : "Not found" } } }, "patch" : { "tags" : [ "Call Parking Spot" ], "summary" : "Update call parking spot", "description" : "Use to update a call parking spot", "operationId" : "patchCallParkingSpot", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "spotId", "in" : "path", "description" : "ID of call parking spot", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Call parking spot object", "required" : true, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid call parking spot ID or call parking spot object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" }, "schema" : { "originalRef" : "CallParkingSpotX", "$ref" : "#/definitions/CallParkingSpotX" } }, "400" : { "description" : "Invalid call parking spot ID or call parking spot object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/cdrsearch/csv" : { "get" : { "tags" : [ "CDRs" ], "summary" : "CDR record search", "description" : "Use to search for CDR records", "operationId" : "cdrSearchCSV", "consumes" : [ "*/*" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : true, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : true, "type" : "string" }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result to display, defaults to 0", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Maximum number to return, defaults to 20", "required" : false, "type" : "integer", "default" : 20, "format" : "int32" }, { "name" : "sort", "in" : "query", "description" : "Sort field", "required" : false, "type" : "string", "enum" : [ "COST", "CALL_LENGTH", "DATE" ] }, { "name" : "sortOrder", "in" : "query", "description" : "Sort order", "required" : false, "type" : "string", "enum" : [ "ASC", "DESC" ] }, { "name" : "minCost", "in" : "query", "description" : "Specifies the minimum cost of the CDR", "required" : false, "type" : "number", "format" : "double" }, { "name" : "callType", "in" : "query", "description" : "Filter based on call type [INBOUND|OUTBOUND]", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "INBOUND", "OUTBOUND" ] }, "collectionFormat" : "multi" }, { "name" : "callFlagType", "in" : "query", "description" : "Filter based on call flag type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "MISSED", "VOICEMAIL", "FORWARDED", "BUSY", "ANSWERED", "OTHER", "PICKUP", "PICKED_UP" ] }, "collectionFormat" : "multi" }, { "name" : "callCategory", "in" : "query", "description" : "Filter based on call category", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "OffNet", "OnNet", "DirectoryAssistance", "Emergency", "Operator", "PhoneSupport", "TeleRelayService", "NonEmergencyServices", "Other", "PublicServices", "NotResolved", "EmergencyServicesVerification", "DomesticViolenceHotline" ] }, "collectionFormat" : "multi" }, { "name" : "origNumber", "in" : "query", "description" : "Filter based on origination number", "required" : false, "type" : "string" }, { "name" : "dialedNumber", "in" : "query", "description" : "Filter based on dialed number", "required" : false, "type" : "string" }, { "name" : "termNumber", "in" : "query", "description" : "Filter based on termination number", "required" : false, "type" : "string" }, { "name" : "startTime", "in" : "query", "description" : "Filter based on start time", "required" : false, "type" : "string" }, { "name" : "endTime", "in" : "query", "description" : "Filter based on end time", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/cdrsearch/csv_2" : { "get" : { "tags" : [ "CDRs" ], "summary" : "CDR record search", "description" : "Use to search for CDR records", "operationId" : "cdrSearchCSV_2", "consumes" : [ "*/*" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : true, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : true, "type" : "string" }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result to display, defaults to 0", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Maximum number to return, defaults to 20", "required" : false, "type" : "integer", "default" : 20, "format" : "int32" }, { "name" : "sort", "in" : "query", "description" : "Sort field", "required" : false, "type" : "string", "enum" : [ "COST", "CALL_LENGTH", "DATE" ] }, { "name" : "sortOrder", "in" : "query", "description" : "Sort order", "required" : false, "type" : "string", "enum" : [ "ASC", "DESC" ] }, { "name" : "minCost", "in" : "query", "description" : "Specifies the minimum cost of the CDR", "required" : false, "type" : "number", "format" : "double" }, { "name" : "callType", "in" : "query", "description" : "Filter based on call type [INBOUND|OUTBOUND]", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "INBOUND", "OUTBOUND" ] }, "collectionFormat" : "multi" }, { "name" : "callFlagType", "in" : "query", "description" : "Filter based on call flag type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "MISSED", "VOICEMAIL", "FORWARDED", "BUSY", "ANSWERED", "OTHER", "PICKUP", "PICKED_UP" ] }, "collectionFormat" : "multi" }, { "name" : "callCategory", "in" : "query", "description" : "Filter based on call category", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "OffNet", "OnNet", "DirectoryAssistance", "Emergency", "Operator", "PhoneSupport", "TeleRelayService", "NonEmergencyServices", "Other", "PublicServices", "NotResolved", "EmergencyServicesVerification", "DomesticViolenceHotline" ] }, "collectionFormat" : "multi" }, { "name" : "origNumber", "in" : "query", "description" : "Filter based on origination number", "required" : false, "type" : "string" }, { "name" : "dialedNumber", "in" : "query", "description" : "Filter based on dialed number", "required" : false, "type" : "string" }, { "name" : "termNumber", "in" : "query", "description" : "Filter based on termination number", "required" : false, "type" : "string" }, { "name" : "startTime", "in" : "query", "description" : "Filter based on start time", "required" : false, "type" : "string" }, { "name" : "endTime", "in" : "query", "description" : "Filter based on end time", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } }, "202" : { "description" : "Use Jobs API to check status" } } } }, "/v2/partition/{partitionId}/account/{accountId}/cdrsearch" : { "get" : { "tags" : [ "CDRs" ], "summary" : "CDR record search", "description" : "Use to search for CDR records", "operationId" : "cdrSearch", "consumes" : [ "*/*" ], "produces" : [ "application/json", "application/xml", "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "startDate", "in" : "query", "description" : "Start date", "required" : true, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "End date", "required" : true, "type" : "string" }, { "name" : "firstResultIndex", "in" : "query", "description" : "First result to display, defaults to 0", "required" : false, "type" : "integer", "default" : 0, "format" : "int32" }, { "name" : "maxResult", "in" : "query", "description" : "Maximum number to return, defaults to 20", "required" : false, "type" : "integer", "default" : 20, "format" : "int32" }, { "name" : "sort", "in" : "query", "description" : "Sort field", "required" : false, "type" : "string", "enum" : [ "COST", "CALL_LENGTH", "DATE" ] }, { "name" : "sortOrder", "in" : "query", "description" : "Sort order", "required" : false, "type" : "string", "enum" : [ "ASC", "DESC" ] }, { "name" : "minCost", "in" : "query", "description" : "Specifies the minimum cost of the CDR", "required" : false, "type" : "number", "format" : "double" }, { "name" : "callType", "in" : "query", "description" : "Filter based on call type [INBOUND|OUTBOUND]", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "INBOUND", "OUTBOUND" ] }, "collectionFormat" : "multi" }, { "name" : "callFlagType", "in" : "query", "description" : "Filter based on call flag type", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "MISSED", "VOICEMAIL", "FORWARDED", "BUSY", "ANSWERED", "OTHER", "PICKUP", "PICKED_UP" ] }, "collectionFormat" : "multi" }, { "name" : "callCategory", "in" : "query", "description" : "Filter based on call category", "required" : false, "type" : "array", "items" : { "type" : "string", "enum" : [ "OffNet", "OnNet", "DirectoryAssistance", "Emergency", "Operator", "PhoneSupport", "TeleRelayService", "NonEmergencyServices", "Other", "PublicServices", "NotResolved", "EmergencyServicesVerification", "DomesticViolenceHotline" ] }, "collectionFormat" : "multi" }, { "name" : "origNumber", "in" : "query", "description" : "Filter based on origination number", "required" : false, "type" : "string" }, { "name" : "dialedNumber", "in" : "query", "description" : "Filter based on dialed number", "required" : false, "type" : "string" }, { "name" : "termNumber", "in" : "query", "description" : "Filter based on termination number", "required" : false, "type" : "string" }, { "name" : "startTime", "in" : "query", "description" : "Filter based on start time", "required" : false, "type" : "string" }, { "name" : "endTime", "in" : "query", "description" : "Filter based on end time", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallDetailRecordSearchResponse", "$ref" : "#/definitions/CallDetailRecordSearchResponse" }, "schema" : { "originalRef" : "CallDetailRecordSearchResponse", "$ref" : "#/definitions/CallDetailRecordSearchResponse" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallDetailRecordSearchResponse", "$ref" : "#/definitions/CallDetailRecordSearchResponse" }, "schema" : { "originalRef" : "CallDetailRecordSearchResponse", "$ref" : "#/definitions/CallDetailRecordSearchResponse" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "Not found" } } } }, "/v2/cymbus/account-group" : { "put" : { "tags" : [ "Cymbus User Product" ], "summary" : "Update Cymbus account group", "description" : "Use to update Cymbus account group", "operationId" : "updateCymbusAccountGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Stretto Device Line object", "required" : true, "schema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" }, "schema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" }, "schema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" } } } } }, "/v2/cymbus/account-group/{accountid}" : { "get" : { "tags" : [ "Cymbus User Product" ], "summary" : "Retrieve Cymbus account group", "description" : "Use to retrieve the Cymbus group associated to an account", "operationId" : "retrieveStrettoDeviceLinesGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "accountid", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" }, "schema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" }, "schema" : { "originalRef" : "CymbusAccountGroup", "$ref" : "#/definitions/CymbusAccountGroup" } } } } }, "/v2/cymbus/account-group/prevalidate" : { "post" : { "tags" : [ "Cymbus User Product" ], "summary" : "Prevalidate Cymbus account name", "description" : "Use to verify that the chosen name is available", "operationId" : "prevalidateCymbusGroupName", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "groupName", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/cymbus/{userid}/sipcredentials" : { "get" : { "tags" : [ "Cymbus User Product" ], "summary" : "Retrieve sip credentials for Cymbus user", "description" : "Use to retrieve sip creds for both lines associated to an account", "operationId" : "retrieveSipCredentialsForCymbusUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "userid", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" }, "schema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" }, "schema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" } } } } }, "/v2/cymbus/{userid}/sipcredentials/change" : { "put" : { "tags" : [ "Cymbus User Product" ], "summary" : "Change sip password for Cymbus user", "description" : "Use to change sip password for both Cymbus user lines", "operationId" : "changeSipCredentialsForCymbusUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "userid", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" }, "schema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" }, "schema" : { "originalRef" : "SipCredentialData", "$ref" : "#/definitions/SipCredentialData" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline/{deviceId}/provisioningstatus" : { "get" : { "tags" : [ "Account Device Line" ], "summary" : "Retrieve device provisioning status", "description" : "Use to retrieve a device's provisioning status", "operationId" : "provisioningStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" }, "schema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" }, "schema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline/{deviceId}/provisioning" : { "get" : { "tags" : [ "Account Device Line" ], "summary" : "Provisioning info for this device line", "description" : "It is preferable if you use the device/{macAddress}/provisioning to get this information", "operationId" : "provisioningInfo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" }, "schema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" }, "schema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline/{deviceId}/registrationstatus" : { "get" : { "tags" : [ "Account Device Line" ], "summary" : "Retrieve device registration status", "description" : "Use to retrieve a device's registration status", "operationId" : "registrationStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" }, "schema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" }, "schema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline/{deviceId}/swap/prevalidate" : { "get" : { "tags" : [ "Account Device Line" ], "summary" : "Pre-validate Device Line MacAddress.", "description" : "", "operationId" : "swapPrevalidate", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "macaddress", "in" : "query", "description" : "Mac address", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline/{deviceId}" : { "get" : { "tags" : [ "Account Device Line" ], "summary" : "Retrieve device", "description" : "Use to retrieve a device", "operationId" : "getDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "deviceId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } } }, "put" : { "tags" : [ "Account Device Line" ], "summary" : "Update device", "description" : "Use to update a device", "operationId" : "putDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device object", "required" : true, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } } }, "delete" : { "tags" : [ "Account Device Line" ], "summary" : "Delete device", "description" : "Use to delete a device", "operationId" : "removeDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "404" : { "description" : "Device not found" } } }, "patch" : { "tags" : [ "Account Device Line" ], "summary" : "Update device", "description" : "Use to update a device", "operationId" : "updateDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device object", "required" : true, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline" : { "get" : { "tags" : [ "Account Device Line" ], "summary" : "Retrieve device list", "description" : "Use to retrieve a list of devices associated to an account. NOTE: if the user making the request in an EndUser and they only have myUser access then you MUST pass filter=userid and filterType=OWNING_USERID or filterType=REFERENCED_USERID or else you will get a NotPermitted error.", "operationId" : "listDevices", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "filter", "in" : "query", "description" : "Filter used in conjunction with filtertype to only return specific devices on the account", "required" : false, "type" : "string" }, { "name" : "filterType", "in" : "query", "description" : "Used in conjunction with filter to return only specific devices on the account", "required" : false, "type" : "string", "enum" : [ "MAC_ADDRESS", "MAC_ADDRESS_INVENTORY", "OWNING_USERID", "REFERENCED_USERID", "ACCOUNT" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } } }, "post" : { "tags" : [ "Account Device Line" ], "summary" : "Create a new device", "description" : "Use to create a new device on a user", "operationId" : "createDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device object", "required" : true, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } ], "responses" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid device object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid device object supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/deviceline/{deviceId}/swap" : { "post" : { "tags" : [ "Account Device Line" ], "summary" : "Swap device", "description" : "Use to replace an existing device with a new device", "operationId" : "swapDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "deviceId", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "DeviceSwap object containing the new macAddress and deviceTypeId", "required" : true, "schema" : { "originalRef" : "DeviceSwapX", "$ref" : "#/definitions/DeviceSwapX" } } ], "responses" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid MAC or device type supplied" } }, "responsesObject" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid MAC or device type supplied" } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}" : { "get" : { "tags" : [ "Account Device" ], "summary" : "List DeviceLines by MacAddress", "description" : "List DeviceLines by macAddress", "operationId" : "listDevices_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } } } }, "post" : { "tags" : [ "Account Device" ], "summary" : "Bulk Import Device Lines", "description" : "Use to bulk import lines for a given device. Note: To use this you must already have a device line defined for this MacAddress", "operationId" : "bulkImportDevice", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "CSV list of device lines (LINE_NUMBER, LINE_TYPE, REFERENCED_USER_EXTENSION, SPEED_DIAL, SPEED_DIAL_DISPLAY_NAME)", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "201" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } } }, "responsesObject" : { "201" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } } } }, "delete" : { "tags" : [ "Account Device" ], "summary" : "Delete all devicelines (by mac)", "description" : "Use to delete a device and all its lines using the macaddress", "operationId" : "deleteDeviceByMac", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "404" : { "description" : "Device not found" } }, "responsesObject" : { "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/csv" : { "get" : { "tags" : [ "Account Device" ], "summary" : "CSV export of device lines", "description" : "CSV Export of device lines", "operationId" : "listDevicesCSV", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/metadata" : { "get" : { "tags" : [ "Account Device" ], "summary" : "Device (by mac) Metadata", "description" : "Use to retrieve device (mac) metadata", "operationId" : "getDeviceMetadata", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } } }, "put" : { "tags" : [ "Account Device" ], "summary" : "Device (by mac) Metadata", "description" : "Use to update device (mac) metadata", "operationId" : "updateDeviceMetadata", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device Metadata", "required" : true, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } } }, "patch" : { "tags" : [ "Account Device" ], "summary" : "Device (by mac) Metadata", "description" : "Use to update device (mac) metadata", "operationId" : "patchDeviceMetadata", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device Metadata", "required" : true, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/provisioning" : { "get" : { "tags" : [ "Account Device" ], "summary" : "Provisioning info for this device", "description" : "Provisioning info for this device", "operationId" : "getProvisoningRequest", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" }, "schema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" }, "schema" : { "originalRef" : "ProvisioningRequestX", "$ref" : "#/definitions/ProvisioningRequestX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/metadata/generateadminpassword" : { "post" : { "tags" : [ "Account Device" ], "summary" : "Device (by mac) Metadata", "description" : "Use to update device (mac) metadata", "operationId" : "generateAdminPassword", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" }, "schema" : { "originalRef" : "DeviceMetadataX", "$ref" : "#/definitions/DeviceMetadataX" } }, "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/metadata/resetencryptionkey" : { "post" : { "tags" : [ "Account Device" ], "summary" : "Device (by mac) Metadata", "description" : "Use to reset the current encryption key as though the device has been factory reset and needs to start over", "operationId" : "resetEncryptionKey", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "404" : { "description" : "Device not found" } }, "responsesObject" : { "404" : { "description" : "Device not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/device/{macAddress}/validateproperties" : { "get" : { "tags" : [ "Account Device" ], "summary" : "Pre-validate property on the Device object", "description" : "", "operationId" : "validateProperties_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "macAddress", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "lineno", "in" : "query", "description" : "Line Number", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/dynamic-inventory/tn-search" : { "get" : { "tags" : [ "Dynamic Inventory" ], "summary" : "Retrieve telephone number list matching query parameters from carrier's dynamic inventory ", "description" : "", "operationId" : "retrieveTnsFromCarriersDynamicInventory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "npa", "in" : "query", "description" : "The three-digit number that identifies the telephone service region", "required" : false, "type" : "string" }, { "name" : "npa-nxx", "in" : "query", "description" : "A six-digit code that is used to identify telephone numbers", "required" : false, "type" : "string" }, { "name" : "qty", "in" : "query", "description" : "Desired quantity of telephone numbers", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "sequential", "in" : "query", "description" : "When true to returns sequential numbers", "required" : false, "type" : "boolean", "default" : true } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DynamicInventoryX", "$ref" : "#/definitions/DynamicInventoryX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DynamicInventoryX", "$ref" : "#/definitions/DynamicInventoryX" } } }, "400" : { "description" : "Invalid account ID supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DynamicInventoryX", "$ref" : "#/definitions/DynamicInventoryX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DynamicInventoryX", "$ref" : "#/definitions/DynamicInventoryX" } } }, "400" : { "description" : "Invalid account ID supplied" } } } }, "/v2/partition/{partitionId}/account/{accountId}/dynamic-inventory/orders" : { "post" : { "tags" : [ "Dynamic Inventory" ], "summary" : "Creates Dynamic inventory orders, those orders eventually will activate telephone numbers received on a request", "description" : "", "operationId" : "createDynamicInventoryOrders", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Dynamic inventory order request object", "required" : true, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicInventoryOrderX", "$ref" : "#/definitions/DynamicInventoryOrderX" }, "schema" : { "originalRef" : "DynamicInventoryOrderX", "$ref" : "#/definitions/DynamicInventoryOrderX" } }, "400" : { "description" : "Invalid carrierId" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicInventoryOrderX", "$ref" : "#/definitions/DynamicInventoryOrderX" }, "schema" : { "originalRef" : "DynamicInventoryOrderX", "$ref" : "#/definitions/DynamicInventoryOrderX" } }, "400" : { "description" : "Invalid carrierId" } } } }, "/v2/partition/{partitionId}/account/{accountId}/ivr/{ivrId}" : { "get" : { "tags" : [ "IVR" ], "summary" : "Retrieve IVR", "description" : "Use to retrieve an IVR", "operationId" : "retrieveIvr", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "ivrId", "in" : "path", "description" : "ID of IVR", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" }, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "400" : { "description" : "Invalid account ID or IVR ID supplied" }, "404" : { "description" : "IVR not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" }, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "400" : { "description" : "Invalid account ID or IVR ID supplied" }, "404" : { "description" : "IVR not found" } } }, "put" : { "tags" : [ "IVR" ], "summary" : "Update IVR", "description" : "Use to update an IVR", "operationId" : "updateIvr", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "ivrId", "in" : "path", "description" : "ID of IVR", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "IVR object", "required" : true, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" }, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "400" : { "description" : "Invalid IVR ID or invalid IVR object supplied" }, "404" : { "description" : "IVR not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" }, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "400" : { "description" : "Invalid IVR ID or invalid IVR object supplied" }, "404" : { "description" : "IVR not found" } } }, "delete" : { "tags" : [ "IVR" ], "summary" : "Delete IVR", "description" : "Use to delete an IVR", "operationId" : "deleteIvr", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "ivrId", "in" : "path", "description" : "ID of IVR", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid IVR ID" }, "404" : { "description" : "IVR not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid IVR ID" }, "404" : { "description" : "IVR not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/ivr" : { "get" : { "tags" : [ "IVR" ], "summary" : "Retrieve all IVRs for account", "description" : "Use to retrieve a list of all IVRs for a account", "operationId" : "retrieveIvrList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } } }, "400" : { "description" : "Invalid partition ID or account ID supplied" }, "404" : { "description" : "IVRs not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } } }, "400" : { "description" : "Invalid partition ID or account ID supplied" }, "404" : { "description" : "IVRs not found" } } }, "post" : { "tags" : [ "IVR" ], "summary" : "Create IVR", "description" : "Use to create an IVR", "operationId" : "createIvr", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "IVR object", "required" : true, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" }, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "400" : { "description" : "Invalid IVR object supplied" }, "404" : { "description" : "IVR not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" }, "schema" : { "originalRef" : "IVRX", "$ref" : "#/definitions/IVRX" } }, "400" : { "description" : "Invalid IVR object supplied" }, "404" : { "description" : "IVR not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/media_2/{id}" : { "get" : { "tags" : [ "Media" ], "summary" : "Retrieve Media. Will return a 302 redirect to the actual file location", "description" : "Use to retrieve Media of a given type", "operationId" : "get_1", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "ID of prompt", "required" : true, "type" : "string" }, { "name" : "mediaType", "in" : "query", "description" : "Type of Media", "required" : true, "type" : "string", "enum" : [ "HoldMusic", "IvrPrompt" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid Media Type supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid Media Type supplied" } } }, "put" : { "tags" : [ "Media" ], "operationId" : "update_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } }, "deprecated" : true }, "delete" : { "tags" : [ "Media" ], "operationId" : "deleteHoldMusic", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "ID of Hold Music Media", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/media_2" : { "post" : { "tags" : [ "Media" ], "summary" : "Upload IVR Prompt or Account Hold Music", "description" : "Use to add an IVR Prompt (use file upload to submit a wav file).\nUse to add Hold Music (use the job service, then submit the jobUploadKey for the wav, mp3, ogg already uploaded)", "operationId" : "uploadAccountMedia", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "jobUploadKey", "in" : "query", "description" : "Provide an upload key (Use for Hold Music)", "required" : false, "type" : "string" }, { "name" : "file", "in" : "formData", "description" : "Wave File to upload. (Use for IVR prompt)", "required" : false, "type" : "file" } ], "responses" : { "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" }, "200" : { "description" : "Processed the IVR Prompt file upload", "responseSchema" : { "originalRef" : "MediaX", "$ref" : "#/definitions/MediaX" }, "schema" : { "originalRef" : "MediaX", "$ref" : "#/definitions/MediaX" } }, "202" : { "description" : "When providing a file upload key. The key has been accepted and the asynchronous process has started", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } } }, "responsesObject" : { "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account not found" }, "200" : { "description" : "Processed the IVR Prompt file upload", "responseSchema" : { "originalRef" : "MediaX", "$ref" : "#/definitions/MediaX" }, "schema" : { "originalRef" : "MediaX", "$ref" : "#/definitions/MediaX" } }, "202" : { "description" : "When providing a file upload key. The key has been accepted and the asynchronous process has started", "responseSchema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" }, "schema" : { "originalRef" : "Job", "$ref" : "#/definitions/Job" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic" : { "get" : { "tags" : [ "Media" ], "summary" : "Retrieve Hold Music Media ID.", "description" : "Use to retrieve Hold Music Media ID", "operationId" : "getAccountHoldMusic", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "custom", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" }, "schema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" }, "schema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" } } } }, "delete" : { "tags" : [ "Media" ], "summary" : "Remove the hold music media selection for this account", "description" : "Used to remove an existing media storage id that is used to play hold music for this account.", "operationId" : "deleteAccountMusicOnHold", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/media_2/type/holdmusic/{id}" : { "put" : { "tags" : [ "Media" ], "summary" : "Set the hold music on this account to this media storage id.", "description" : "Used to set the hold music to a different storage id", "operationId" : "updateAccountMusicOnHold", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "Hold Music storage id", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" }, "schema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" }, "schema" : { "originalRef" : "HoldMusicX", "$ref" : "#/definitions/HoldMusicX" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/media/{mediaId}" : { "get" : { "tags" : [ "Media" ], "summary" : "Retrieve Media of type", "description" : "Use to retrieve Media of a given type", "operationId" : "get_2", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "mediaId", "in" : "path", "description" : "ID of prompt", "required" : true, "type" : "string" }, { "name" : "fileName", "in" : "query", "description" : "Name of media", "required" : false, "type" : "string" }, { "name" : "mediaType", "in" : "query", "description" : "Type of Media", "required" : true, "type" : "string", "enum" : [ "HoldMusic", "IvrPrompt" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid Media ID supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid Media ID supplied" }, "404" : { "description" : "Account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/media" : { "post" : { "tags" : [ "Media" ], "summary" : "Add IVR prompt", "description" : "Use to add an IVR prompt", "operationId" : "add", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Media file", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account or IVR not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Account or IVR not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/port/{portId}/loa" : { "get" : { "tags" : [ "Port" ], "operationId" : "findLoa", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } }, "post" : { "tags" : [ "Port" ], "operationId" : "uploadLOA", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/port/{portId}/loa/metadata" : { "get" : { "tags" : [ "Port" ], "operationId" : "getLoaMetadata", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "LOAX", "$ref" : "#/definitions/LOAX" }, "schema" : { "originalRef" : "LOAX", "$ref" : "#/definitions/LOAX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "LOAX", "$ref" : "#/definitions/LOAX" }, "schema" : { "originalRef" : "LOAX", "$ref" : "#/definitions/LOAX" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/port/{portId}/triggerport" : { "put" : { "tags" : [ "Port" ], "summary" : "Updates a service activation event on an account and triggers the port with the carrier", "description" : "Use to update a specific service activation event on an account as a port request for the purpose of triggering a port with the carrier", "operationId" : "triggerPort", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Invalid partition or account" } }, "responsesObject" : { "400" : { "description" : "Invalid partition or account" } } } }, "/v2/partition/{partitionId}/account/{accountId}/port/{portId}" : { "get" : { "tags" : [ "Port" ], "operationId" : "retrievePort", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } } }, "put" : { "tags" : [ "Port" ], "operationId" : "updatePort", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } } }, "patch" : { "tags" : [ "Port" ], "operationId" : "patchPort", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "schema" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/port/{portId}/cancelport" : { "delete" : { "tags" : [ "Port" ], "operationId" : "cancelPort", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "portId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/product/prevalidate" : { "post" : { "tags" : [ "Account Prevalidate" ], "summary" : "Prevalidate an account product", "description" : "Use to prevalidate an account product", "operationId" : "prevalidate", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Invalid telephone number object supplied" } }, "responsesObject" : { "400" : { "description" : "Invalid telephone number object supplied" } } } }, "/v2/partition/{partitionId}/account/{accountId}/reference/{referenceId}/type/{serviceType}" : { "get" : { "tags" : [ "Service Activation" ], "summary" : "Retrieve a service activation event on an account", "description" : "Use to retrieve a specific service activation event on an account", "operationId" : "retrieve_7", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "referenceId", "in" : "path", "required" : true, "type" : "string" }, { "name" : "serviceType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "PORT_REQUEST", "CSR_CHANGE_REQUEST", "ACTIVATION", "NINE_ONE_ONE_ADDRESS", "DISCONNECT", "DYNAMIC_RESERVATION", "BYOTN_REQUEST", "SERVICE_PROVIDER_TN" ] }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ServiceActivationEventX", "$ref" : "#/definitions/ServiceActivationEventX" }, "schema" : { "originalRef" : "ServiceActivationEventX", "$ref" : "#/definitions/ServiceActivationEventX" } }, "400" : { "description" : "Invalid partition or account" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ServiceActivationEventX", "$ref" : "#/definitions/ServiceActivationEventX" }, "schema" : { "originalRef" : "ServiceActivationEventX", "$ref" : "#/definitions/ServiceActivationEventX" } }, "400" : { "description" : "Invalid partition or account" } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2/{sipTrunkId}" : { "get" : { "tags" : [ "SIP Trunk" ], "summary" : "Retrieve SIP trunk", "description" : "Use to retrieve a SIP trunk", "operationId" : "retrieveSipTrunk", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } } }, "put" : { "tags" : [ "SIP Trunk" ], "summary" : "Update SIP trunk", "description" : "Use to update a SIP trunk", "operationId" : "updateSipTrunk", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "SIP trunk object", "required" : true, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID or SIP trunk object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID or SIP trunk object supplied" }, "404" : { "description" : "Not found" } } }, "delete" : { "tags" : [ "SIP Trunk" ], "summary" : "Delete SIP trunk", "description" : "Use to delete a SIP trunk", "operationId" : "deleteSipTrunk", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } } }, "patch" : { "tags" : [ "SIP Trunk" ], "summary" : "Update SIP trunk", "description" : "Use to update a SIP trunk", "operationId" : "patchSipTrunk", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "SIP trunk object", "required" : true, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID or SIP trunk object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID or SIP trunk object supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2/validate" : { "get" : { "tags" : [ "SIP Trunk" ], "summary" : "Validate IP and port", "description" : "Use to verify that combination of IP and port is unique", "operationId" : "validate", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "trunkId", "in" : "query", "description" : "When the SIP Trunk is already created we need the ID to make sure we skip the trunk itself to validate IP is unique", "required" : false, "type" : "string" }, { "name" : "ip", "in" : "query", "description" : "The IP address to be verified", "required" : true, "type" : "string" }, { "name" : "port", "in" : "query", "description" : "The port number to be verified", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2" : { "get" : { "tags" : [ "SIP Trunk" ], "summary" : "Retrieve list of SIP trunks", "description" : "Use to retrieve a list of all SIP trunks on an account", "operationId" : "retrieveSipTrunkList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } }, "400" : { "description" : "Invalid partition or account ID supplied" }, "404" : { "description" : "List not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } }, "400" : { "description" : "Invalid partition or account ID supplied" }, "404" : { "description" : "List not found" } } }, "post" : { "tags" : [ "SIP Trunk" ], "summary" : "Create a SIP trunk", "description" : "Use to create a SIP trunk", "operationId" : "createSipTrunk", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk object supplied" }, "404" : { "description" : "Partition or account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk object supplied" }, "404" : { "description" : "Partition or account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2/{sipTrunkId}/forward" : { "get" : { "tags" : [ "SIP Trunk" ], "summary" : "Get Forward behavior for a SipTrunk", "description" : "Get Forward behavior for a SipTrunk", "operationId" : "retrieveSipTrunkForwardBehavior", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunkForwardRules", "$ref" : "#/definitions/SipTrunkForwardRules" }, "schema" : { "originalRef" : "SipTrunkForwardRules", "$ref" : "#/definitions/SipTrunkForwardRules" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunkForwardRules", "$ref" : "#/definitions/SipTrunkForwardRules" }, "schema" : { "originalRef" : "SipTrunkForwardRules", "$ref" : "#/definitions/SipTrunkForwardRules" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" } } }, "put" : { "tags" : [ "SIP Trunk" ], "summary" : "Update Forward behavior for a SipTrunk", "description" : "Update Forward behavior for a SipTrunk", "operationId" : "updateSipTrunkForwardBehavior", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "SipTrunkForwardRules", "$ref" : "#/definitions/SipTrunkForwardRules" } } ], "responses" : { "400" : { "description" : "Invalid SIP trunk ID supplied" } }, "responsesObject" : { "400" : { "description" : "Invalid SIP trunk ID supplied" } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2/{sipTrunkId}/unlock" : { "put" : { "tags" : [ "SIP Trunk" ], "summary" : "Unlock SIP trunk", "description" : "Use to unlock a SIP trunk", "operationId" : "unlockSipTrunk", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" }, "schema" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2/shared-plan-lookup" : { "get" : { "tags" : [ "SIP Trunk" ], "summary" : "Retrieve list of shareable calling plans", "description" : "Use to retrieve calling plans that can be shared between sip trunks", "operationId" : "getShareableCallingPlans", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SipTrunk", "$ref" : "#/definitions/SipTrunk" } } } } } }, "/v2/partition/{partitionId}/account/{accountId}/siptrunk_2/{sipTrunkId}/registrationstatus" : { "get" : { "tags" : [ "SIP Trunk" ], "summary" : "Retrieve SIP trunk registration status", "description" : "Use to retrieve SIP trunk registration status", "operationId" : "getRegistrationStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "sipTrunkId", "in" : "path", "description" : "SIP trunk ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" }, "schema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" }, "schema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" } }, "400" : { "description" : "Invalid SIP trunk ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Retrieve a telephone number on an account", "description" : "Use to retrieve a specific telephone number on an account", "operationId" : "retrieveTelephoneNumberOnAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "400" : { "description" : "Invalid account ID or telephone number supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "400" : { "description" : "Invalid account ID or telephone number supplied" }, "404" : { "description" : "Telephone number not found" } } }, "put" : { "tags" : [ "Telephone Number" ], "summary" : "Update telephone number on an account", "description" : "Use to update a telephone number on an account", "operationId" : "updateTelephoneNumberOnAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number account object", "required" : true, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "400" : { "description" : "Invalid telephone number or telephone number account object supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "400" : { "description" : "Invalid telephone number or telephone number account object supplied" }, "404" : { "description" : "Telephone number not found" } } }, "delete" : { "tags" : [ "Telephone Number" ], "summary" : "Delete telephone number on an account", "description" : "Use to delete a telephone number on an account", "operationId" : "deleteTelephoneNumberOnAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Invalid account ID or telephone number supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "400" : { "description" : "Invalid account ID or telephone number supplied" }, "404" : { "description" : "Telephone number not found" } } }, "patch" : { "tags" : [ "Telephone Number" ], "summary" : "Update telephone number on an account", "description" : "Use to update a telephone number on an account", "operationId" : "patchTelephoneNumberOnAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number account object", "required" : true, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "400" : { "description" : "Invalid telephone number or telephone number account object supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "400" : { "description" : "Invalid telephone number or telephone number account object supplied" }, "404" : { "description" : "Telephone number not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Retrieve all telephone numbers on an account", "description" : "Use to retrieve all telephone numbers on an account. limitedData is provided to enable large result sets retreived without long retrieval times", "operationId" : "retrieveAccountTelephoneNumbers", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "limitedData", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } }, "400" : { "description" : "Invalid account ID supplied" }, "404" : { "description" : "Telephone numbers not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } }, "400" : { "description" : "Invalid account ID supplied" }, "404" : { "description" : "Telephone numbers not found" } } }, "post" : { "tags" : [ "Telephone Number" ], "summary" : "Create a telephone number or add telephone number to an account", "description" : "Use to create a new telephone number or add an existing number to an account. Unit field in the CSR Address should be no greater than 10 character, anything more than 10 characters is ignored. ", "operationId" : "createOrAddTelephoneNumberToAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Telephone number activation object", "required" : true, "schema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" }, "schema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" } }, "400" : { "description" : "Invalid account ID or telephone number information supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" }, "schema" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" } }, "400" : { "description" : "Invalid account ID or telephone number information supplied" }, "404" : { "description" : "Telephone number not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/groupid/{groupId}" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Retrieve all telephone number for end users", "description" : "Use to retrieve all telephone numbers on an account for user groups. If group is provided only the numbers for the users on this group will be returned", "operationId" : "retrieveTelephoneNumbersByUserGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "groupId", "in" : "path", "description" : "Group ID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } }, "400" : { "description" : "Invalid account ID supplied" }, "404" : { "description" : "Telephone numbers not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } }, "400" : { "description" : "Invalid account ID supplied" }, "404" : { "description" : "Telephone numbers not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}/911-address/original/accept" : { "put" : { "tags" : [ "Telephone Number" ], "summary" : "Accept original E911 address", "description" : "", "operationId" : "acceptOriginalE911", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" }, { "name" : "latitude", "in" : "query", "description" : "E911 address latitude", "required" : false, "type" : "string" }, { "name" : "longitude", "in" : "query", "description" : "E911 address latitude", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/tn-requests" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Get all unfinished or archived activations with dynamic inventory", "description" : "", "operationId" : "retrieveDynamicInventoryActivations", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "getAll", "in" : "query", "required" : false, "type" : "boolean" }, { "name" : "archived", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } } }, "400" : { "description" : "Invalid account ID supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } } }, "400" : { "description" : "Invalid account ID supplied" } } }, "post" : { "tags" : [ "Telephone Number" ], "summary" : "Activate a tn that will be requested dynamically from carrier. TN is not known at the moment of initiating of activation", "description" : "", "operationId" : "createOrAddTelephoneNumberToAccountWithDynamicInventory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid carrierId" }, "404" : { "description" : "Closest RateCenter could not be found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid carrierId" }, "404" : { "description" : "Closest RateCenter could not be found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/tn-requests/{orderId}" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Get activation with dynamic inventory regardless of status", "description" : "", "operationId" : "getDynamicInventoryActivation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "orderId", "in" : "path", "description" : "Dynamic reservation order id", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid account ID supplied" }, "404" : { "description" : "Reservation could not be found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid account ID supplied" }, "404" : { "description" : "Reservation could not be found" } } }, "put" : { "tags" : [ "Telephone Number" ], "summary" : "Updates dynamic reservation object", "description" : "", "operationId" : "updateTelephoneNumberToAccountWithDynamicInventory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "orderId", "in" : "path", "description" : "Dynamic reservation order id", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Dynamic tn reservation object", "required" : true, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid dynamic reservation object supplied" }, "404" : { "description" : "Reservation could not be found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid dynamic reservation object supplied" }, "404" : { "description" : "Reservation could not be found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/tn-requests/actions/cancel" : { "post" : { "tags" : [ "Telephone Number" ], "summary" : "Cancel and remove reservation object", "description" : "", "operationId" : "cancelAndRemoveDynamicInventoryReservation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Cancel action object", "required" : true, "schema" : { "originalRef" : "CancelActionX", "$ref" : "#/definitions/CancelActionX" } } ], "responses" : { "400" : { "description" : "Invalid dynamic reservation object activation status" } }, "responsesObject" : { "400" : { "description" : "Invalid dynamic reservation object activation status" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/tn-requests/actions/resubmit" : { "post" : { "tags" : [ "Telephone Number" ], "summary" : "Revise and resubmit dynamic reservation object", "description" : "", "operationId" : "reviseAndResubmitDynamicInventoryReservation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Dynamic reservation object", "required" : true, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid carrierId or dynamic reservation object activation status" }, "404" : { "description" : "Closest RateCenter could not be found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "schema" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" } }, "400" : { "description" : "Invalid carrierId or dynamic reservation object activation status" }, "404" : { "description" : "Closest RateCenter could not be found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/tn-requests/{orderId}/refresh" : { "post" : { "tags" : [ "Telephone Number" ], "summary" : "Refresh dynamic activation status", "description" : "", "operationId" : "refreshDynamicInventoryActivation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "orderId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "404" : { "description" : "Activation is not found by orderId" } }, "responsesObject" : { "404" : { "description" : "Activation is not found by orderId" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}/911-address/usages" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Retrieve a telephone number usages on an account", "description" : "Use to retrieve usages of a specific telephone number on an account", "operationId" : "retrieveTelephoneNumberUsages", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number usages", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberUsagesX", "$ref" : "#/definitions/TelephoneNumberUsagesX" }, "schema" : { "originalRef" : "TelephoneNumberUsagesX", "$ref" : "#/definitions/TelephoneNumberUsagesX" } }, "400" : { "description" : "Invalid account ID or telephone number supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberUsagesX", "$ref" : "#/definitions/TelephoneNumberUsagesX" }, "schema" : { "originalRef" : "TelephoneNumberUsagesX", "$ref" : "#/definitions/TelephoneNumberUsagesX" } }, "400" : { "description" : "Invalid account ID or telephone number supplied" }, "404" : { "description" : "Telephone number not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}/911-address/correction" : { "get" : { "tags" : [ "Telephone Number" ], "summary" : "Get adjusted E911 address", "description" : "", "operationId" : "getE911Correction", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "schema" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "schema" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}/911-address/correction/accept" : { "put" : { "tags" : [ "Telephone Number" ], "summary" : "Accept adjusted E911 address", "description" : "", "operationId" : "acceptE911Correction", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "description" : "Telephone number", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "schema" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/external" : { "post" : { "tags" : [ "Telephone Number" ], "summary" : "Create or updates already activated telephone number to an account", "description" : "Use to create a new telephone number or update an existing number to an account. Unit field in the CSR Address should be no greater than 10 character, anything more than 10 characters is ignored. ", "operationId" : "createOrUpdateExternalTelephoneNumberToAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Narrow telephone number object", "required" : true, "schema" : { "originalRef" : "ExternalTnX", "$ref" : "#/definitions/ExternalTnX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ExternalTnX", "$ref" : "#/definitions/ExternalTnX" }, "schema" : { "originalRef" : "ExternalTnX", "$ref" : "#/definitions/ExternalTnX" } }, "400" : { "description" : "Invalid account ID or telephone number information supplied" }, "404" : { "description" : "Telephone number not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ExternalTnX", "$ref" : "#/definitions/ExternalTnX" }, "schema" : { "originalRef" : "ExternalTnX", "$ref" : "#/definitions/ExternalTnX" } }, "400" : { "description" : "Invalid account ID or telephone number information supplied" }, "404" : { "description" : "Telephone number not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}/destination" : { "put" : { "tags" : [ "Telephone Number" ], "operationId" : "destination", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "tn", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "TelephoneNumberDestinationX", "$ref" : "#/definitions/TelephoneNumberDestinationX" } } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "TelephoneNumberDestinationX", "$ref" : "#/definitions/TelephoneNumberDestinationX" }, "schema" : { "originalRef" : "TelephoneNumberDestinationX", "$ref" : "#/definitions/TelephoneNumberDestinationX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "TelephoneNumberDestinationX", "$ref" : "#/definitions/TelephoneNumberDestinationX" }, "schema" : { "originalRef" : "TelephoneNumberDestinationX", "$ref" : "#/definitions/TelephoneNumberDestinationX" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line list", "description" : "Use to retrieve a list of business lines associated to an account", "operationId" : "retrieveBusinessLines", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } } } }, "post" : { "tags" : [ "Business Line" ], "summary" : "Create a new business line", "description" : "Use to create a new business line on an account. This includes the physical device specifications, call handling rules, and SIP credentials.", "operationId" : "createBusinessLine", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line object", "required" : true, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" }, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" }, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/views/expanded" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line list with lines in expanded view format", "description" : "Use to retrieve a list of business lines in expanded view format which is associated to an account", "operationId" : "retrieveBusinessLinesExpanded", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" } } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/call-handling" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line call handling", "description" : "Use to get the call handling specifications for a business line", "operationId" : "getBusinessLineCallHandling", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" }, "schema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" }, "schema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" } } } }, "put" : { "tags" : [ "Business Line" ], "summary" : "Update business line call handling", "description" : "Use to update the call handling specifications for a business line", "operationId" : "putBusinessLineCallHandling", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line call handling object", "required" : true, "schema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" }, "schema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" }, "schema" : { "originalRef" : "CallHandling", "$ref" : "#/definitions/CallHandling" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line", "description" : "Use to retrieve a business line", "operationId" : "retrieveBusinessLine", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" }, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" }, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } } }, "put" : { "tags" : [ "Business Line" ], "summary" : "Update business line", "description" : "Use to update a business line", "operationId" : "updateBusinessLine", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line object", "required" : true, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" }, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" }, "schema" : { "originalRef" : "BusinessLine", "$ref" : "#/definitions/BusinessLine" } } } }, "delete" : { "tags" : [ "Business Line" ], "summary" : "Delete business line", "description" : "Use to delete a business line", "operationId" : "deleteBusinessLine", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/views/expanded" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line in expanded view format", "description" : "Use to retrieve a business line in expanded view format", "operationId" : "retrieveBusinessLineExpanded", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" }, "schema" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" }, "schema" : { "originalRef" : "BusinessLineExpandedView", "$ref" : "#/definitions/BusinessLineExpandedView" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/registration" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve registration status for business line", "description" : "Use to retrieve registration status of business line", "operationId" : "businessLineRegistrationStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" }, "schema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" }, "schema" : { "originalRef" : "RegistrationStatus", "$ref" : "#/definitions/RegistrationStatus" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/port-assignment/rpc/swap" : { "post" : { "tags" : [ "Business Line" ], "summary" : "Swap business line port assignment(s)", "description" : "Use to swap out the port assignments related to an existing port assignment mac address or id", "operationId" : "swapBusinessLinePortAssignment", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "DeviceSwap", "$ref" : "#/definitions/DeviceSwap" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/port-assignment" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line port assignment", "description" : "Use to get the physical port assignment specifications for a business line", "operationId" : "getBusinessLinePortAssignment", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } } }, "post" : { "tags" : [ "Business Line" ], "summary" : "Create business line port assignment", "description" : "Use to create the physical port assignment specifications for a business line", "operationId" : "createBusinessLinePortAssignment", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line port assignment object", "required" : true, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } } }, "put" : { "tags" : [ "Business Line" ], "summary" : "Update business line port assignment", "description" : "Use to update the physical port assignment specifications for a business line", "operationId" : "updateBusinessLinePortAssignment", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line port assignment object", "required" : true, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } } }, "delete" : { "tags" : [ "Business Line" ], "summary" : "Delete business line port assignment", "description" : "Use to delete the physical port assignment specifications for a business line", "operationId" : "deleteBusinessLinePortAssignment", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/port-assignment/push-provisioning-logs" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve provisioning logs from third party notifications", "description" : "Used for port assignments utilizing a mac address. Pull logs from push provisioning", "operationId" : "getPushProvisioningLogs", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" }, "schema" : { "originalRef" : "PortAssignment", "$ref" : "#/definitions/PortAssignment" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/sip-credentials" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve SIP credentials", "description" : "Use to retrieve SIP credentials for a business line", "operationId" : "getBusinessLineSipCredentials", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" }, "schema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" }, "schema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" } } } }, "put" : { "tags" : [ "Business Line" ], "summary" : "Update SIP credentials", "description" : "Use to update SIP credentials for a business line", "operationId" : "putBusinessLineSipCredentials", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "SIP Credentials object", "required" : true, "schema" : { "originalRef" : "SipCredentials", "$ref" : "#/definitions/SipCredentials" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" }, "schema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" }, "schema" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/sip-credentials/username-availability-check/{username}" : { "get" : { "tags" : [ "Business Line" ], "summary" : "SIP Username Availability Check", "description" : "Use to determine if a SIP username is available to use", "operationId" : "isUsernameAvailable", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "businessLineId", "in" : "path", "description" : "ID of Business Line", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "username", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve all business line voicemail boxes on this account", "description" : "Use to retrieve a business line voicemail boxes on the specified account", "operationId" : "retrieveBusinessLineVoicemailBoxes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "object" } }, "schema" : { "type" : "array", "items" : { "type" : "object" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "object" } }, "schema" : { "type" : "array", "items" : { "type" : "object" } } } } }, "post" : { "tags" : [ "Business Line" ], "summary" : "Create business line voicemail box on account", "description" : "Use to create a business line voicemail box on the specified account", "operationId" : "createBusinessLineVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Voicemail Box object", "required" : true, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" }, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" }, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/views/expanded" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve all business line voicemail boxes on this account including references", "description" : "Use to retrieve a business line voicemail boxes on the specified account including references", "operationId" : "retrieveBusinessLineVoicemailBoxesExpandedView", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "object" } }, "schema" : { "type" : "array", "items" : { "type" : "object" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "object" } }, "schema" : { "type" : "array", "items" : { "type" : "object" } } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line voicemail box", "description" : "Use to retrieve a business line voicemail box", "operationId" : "retrieveBusinessLineVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" }, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" }, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } } }, "put" : { "tags" : [ "Business Line" ], "summary" : "Update business line voicemail box", "description" : "Use to update a business line voicemail box", "operationId" : "updateBusinessLineVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line Voicemail Box object", "required" : true, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" }, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" }, "schema" : { "originalRef" : "VoicemailBox", "$ref" : "#/definitions/VoicemailBox" } } } }, "delete" : { "tags" : [ "Business Line" ], "summary" : "Delete business line voicemail box", "description" : "Use to delete a business line voicemail box", "operationId" : "deleteBusinessLineVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/views/expanded" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line voicemail box including references", "description" : "Use to retrieve a business line voicemail box including references", "operationId" : "retrieveBusinessLineVoicemailBoxExpandedView", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxExpandedView", "$ref" : "#/definitions/VoicemailBoxExpandedView" }, "schema" : { "originalRef" : "VoicemailBoxExpandedView", "$ref" : "#/definitions/VoicemailBoxExpandedView" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxExpandedView", "$ref" : "#/definitions/VoicemailBoxExpandedView" }, "schema" : { "originalRef" : "VoicemailBoxExpandedView", "$ref" : "#/definitions/VoicemailBoxExpandedView" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/rpc/check-pin-status" : { "post" : { "tags" : [ "Business Line" ], "summary" : "Check business line voicemail box PIN status", "description" : "Use to check a business line voicemail box PIN status", "operationId" : "checkBusinessLineVoicemailBoxPinStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PinStatusResponse", "$ref" : "#/definitions/PinStatusResponse" }, "schema" : { "originalRef" : "PinStatusResponse", "$ref" : "#/definitions/PinStatusResponse" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PinStatusResponse", "$ref" : "#/definitions/PinStatusResponse" }, "schema" : { "originalRef" : "PinStatusResponse", "$ref" : "#/definitions/PinStatusResponse" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/rpc/reset-pin" : { "post" : { "tags" : [ "Business Line" ], "summary" : "Reset the PIN for a business line voicemail box", "description" : "Use to reset a PIN for a business line voicemail box", "operationId" : "resetBusinessLineVoicemailBoxPinStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/message/{messageId}" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve a business line voicemail message", "description" : "Use to retrieve a message in a business line voicemail box", "operationId" : "retrieveBusinessLineVoicemailMessage", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailMessage", "$ref" : "#/definitions/VoicemailMessage" }, "schema" : { "originalRef" : "VoicemailMessage", "$ref" : "#/definitions/VoicemailMessage" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailMessage", "$ref" : "#/definitions/VoicemailMessage" }, "schema" : { "originalRef" : "VoicemailMessage", "$ref" : "#/definitions/VoicemailMessage" } } } }, "delete" : { "tags" : [ "Business Line" ], "summary" : "Delete a business line voicemail message", "description" : "Use to delete a message in a business line voicemail box", "operationId" : "deleteBusinessLineVoicemailMessage", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/message" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve business line voicemail messages", "description" : "Use to retrieve all messages in a business line voicemail box", "operationId" : "retrieveBusinessLineVoicemailMessages", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "object" } }, "schema" : { "type" : "array", "items" : { "type" : "object" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "object" } }, "schema" : { "type" : "array", "items" : { "type" : "object" } } } } }, "delete" : { "tags" : [ "Business Line" ], "summary" : "Delete business line voicemail messages", "description" : "Use to delete all messages in a business line voicemail box", "operationId" : "deleteBusinessLineVoicemailMessages", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/message/bulk-update" : { "put" : { "tags" : [ "Business Line" ], "summary" : "Bulk update of voicemail messages", "description" : "Use to mark multiple voicemail messages at the same time to a READ, UNREAD, or DELETE status", "operationId" : "bulkVoicemailMessageUpdate", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Bulk Voicemail Action object", "required" : true, "schema" : { "originalRef" : "BulkVoicemailAction", "$ref" : "#/definitions/BulkVoicemailAction" } } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/message/{messageId}/media" : { "get" : { "tags" : [ "Business Line" ], "summary" : "Retrieve a business line voicemail message media", "description" : "Use to retrieve the audio message for a business line voicemail message", "operationId" : "retrieveBusinessLineVoicemailMessageMedia", "consumes" : [ "application/json" ], "produces" : [ "audio/mpeg", "audio/wave" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/message/{messageId}/set-read-status" : { "post" : { "tags" : [ "Business Line" ], "summary" : "Update business line voicemail message read flag", "description" : "Use to update if a voicemail message should be marked as read", "operationId" : "updateBusinessLineVoicemailMessageRead", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Voicemail Message Read object", "required" : true, "schema" : { "originalRef" : "ReadMessage", "$ref" : "#/definitions/ReadMessage" } } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box/{voicemailBoxId}/greetings/{greetingType}/media" : { "get" : { "tags" : [ "Voicemail Box" ], "summary" : "Retrieve Greeting media file", "description" : "Use to retrieve media file for a business-line voicemail box", "operationId" : "retrieveBusinessLineGreeting", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "greetingType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "Personal", "PersonalNoAnswer", "PersonalBusy", "PersonalName", "PrimaryGreeting" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } } }, "put" : { "tags" : [ "Voicemail Box" ], "summary" : "Upload Business-Line Greeting media file", "description" : "Use to upload media file for a business-line voicemail box (wav, mp3, ogg)", "operationId" : "uploadBusinessLineGreeting", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "greetingType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "Personal", "PersonalNoAnswer", "PersonalBusy", "PersonalName", "PrimaryGreeting" ] }, { "name" : "file", "in" : "formData", "description" : "Media file", "required" : true, "type" : "file" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } }, "delete" : { "tags" : [ "Voicemail Box" ], "summary" : "Delete Greeting media file", "description" : "Use to delete media file for a business-line voicemail box", "operationId" : "deleteBusinessLineGreeting", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "greetingType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "Personal", "PersonalNoAnswer", "PersonalBusy", "PersonalName", "PrimaryGreeting" ] } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group" : { "get" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Retrieve business line hunt group list", "description" : "Use to retrieve a list of business lines hunt groups associated to an account", "operationId" : "retrieveBusinessLineHuntGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } } } }, "post" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Create a new business line hunt group", "description" : "Use to create a new business line hunt group on an account.", "operationId" : "createBusinessLineHuntGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line hunt group object", "required" : true, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" }, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" }, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/failover-action/{reason}" : { "get" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Retrieve business line hunt group failover action for the specified reason", "description" : "Use to retrieve a failover action for a business lines hunt group", "operationId" : "getBusinessLineHuntGroupFailoverAction", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "reason", "in" : "path", "required" : true, "type" : "string", "enum" : [ "NO_ANSWER", "BUSY", "UNREGISTERED" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, "schema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, "schema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" } } } }, "put" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Update business line hunt group failover action for the specified reason", "description" : "Use to update the failvover action for a business line hunt group", "operationId" : "updateBusinessLineHuntGroupFailoverAction", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "reason", "in" : "path", "required" : true, "type" : "string", "enum" : [ "NO_ANSWER", "BUSY", "UNREGISTERED" ] }, { "in" : "body", "name" : "body", "description" : "Business line hunt group failover action object", "required" : true, "schema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, "schema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, "schema" : { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id}/constraints/star-code" : { "get" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Retrieve a list of available star codes to forward the hunt group", "description" : "Use to retrieve a list of available star codes to assign to business line hunt group including the current star code assigned to this hunt group's forwarding configuration. Use '*' to search without a forward configuration id", "operationId" : "getAvailableStarCodes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PartitionStarCodes", "$ref" : "#/definitions/PartitionStarCodes" }, "schema" : { "originalRef" : "PartitionStarCodes", "$ref" : "#/definitions/PartitionStarCodes" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PartitionStarCodes", "$ref" : "#/definitions/PartitionStarCodes" }, "schema" : { "originalRef" : "PartitionStarCodes", "$ref" : "#/definitions/PartitionStarCodes" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration" : { "get" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Retrieve business line hunt group forwarding configuration list", "description" : "Use to retrieve a list of forwarding configurations on a business lines hunt group", "operationId" : "getBusinessLineHuntGroupForwardingConfigurations", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } } } }, "post" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Create a new business line hunt group forwarding configuration", "description" : "Use to create a new forwarding configuration on a business line hunt group.", "operationId" : "createBusinessLineHuntGroupForwardingConfiguration", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line hunt group forwarding configuration object", "required" : true, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" }, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" }, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id}" : { "get" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Retrieve business line hunt group forwarding configuration", "description" : "Use to get the forwarding configuration for a business line hunt group", "operationId" : "getBusinessLineHuntGroupForwardingConfiguration", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" }, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" }, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } } }, "put" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Update business line hunt group forwarding configuration", "description" : "Use to update the forwarding configuration for a business line hunt group", "operationId" : "updateBusinessLineHuntGroupForwardingConfiguration", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "in" : "body", "name" : "body", "description" : "Business line hunt group forwarding configuration object", "required" : true, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" }, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" }, "schema" : { "originalRef" : "ForwardConfiguration", "$ref" : "#/definitions/ForwardConfiguration" } } } }, "delete" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Delete business line hunt group forwarding configuration", "description" : "Use to delete the forwarding configuration for a business line hunt group", "operationId" : "deleteBusinessLineHuntGroupForwardingConfiguration", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}" : { "get" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Retrieve business line hunt group", "description" : "Use to retrieve a business line hunt group", "operationId" : "retrieveBusinessLineHuntGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" }, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" }, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } } }, "put" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Update business line hunt group", "description" : "Use to update a business line hunt group", "operationId" : "updateBusinessLineHuntGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Business line hunt group object", "required" : true, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" }, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" }, "schema" : { "originalRef" : "HuntGroup", "$ref" : "#/definitions/HuntGroup" } } } }, "delete" : { "tags" : [ "Business Line Hunt Group" ], "summary" : "Delete business line hunt group", "description" : "Use to delete a business line hunt group", "operationId" : "deleteBusinessLineHuntGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "huntGroupId", "in" : "path", "description" : "ID of Business Line Hunt Group", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/group" : { "get" : { "tags" : [ "Call Group" ], "summary" : "Get call group list", "description" : "Use to retrieve a list of call groups.", "operationId" : "getAllCallGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "memberType", "in" : "query", "description" : "Filter by member type", "required" : false, "type" : "string", "enum" : [ "DEVICE", "USER" ] }, { "name" : "memberId", "in" : "query", "description" : "Filter for member ID, requires member type", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Call Group" ], "summary" : "Create call group", "description" : "Use to create a call group", "operationId" : "createCallGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Call group object", "required" : true, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid call group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid call group object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/group/{callGroupId}" : { "get" : { "tags" : [ "Call Group" ], "summary" : "Retrieve a call group", "description" : "Use to retrieve a call group", "operationId" : "getCallGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "callGroupId", "in" : "path", "description" : "ID of call group", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid account ID or call group ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid account ID or call group ID" }, "404" : { "description" : "Not found" } } }, "put" : { "tags" : [ "Call Group" ], "summary" : "Update call group", "description" : "Use to update a call group", "operationId" : "updateCallGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "callGroupId", "in" : "path", "description" : "ID of Call group", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Call group object", "required" : true, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid call group ID or call group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid call group ID or call group object" }, "404" : { "description" : "Not found" } } }, "delete" : { "tags" : [ "Call Group" ], "summary" : "Delete call group", "description" : "Use to delete a call group", "operationId" : "deleteCallGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "callGroupId", "in" : "path", "description" : "ID of call group", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid call group ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid call group ID" }, "404" : { "description" : "Not found" } } }, "patch" : { "tags" : [ "Call Group" ], "summary" : "Update call group", "description" : "Use to update a call group", "operationId" : "patchCallGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "callGroupId", "in" : "path", "description" : "ID of call group", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Call group object", "required" : true, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid call group ID or call group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" }, "schema" : { "originalRef" : "CallGroupX", "$ref" : "#/definitions/CallGroupX" } }, "400" : { "description" : "Invalid call group ID or call group object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/grouppaging" : { "get" : { "tags" : [ "Paging Group" ], "summary" : "Get paging group list", "description" : "Use to retrieve a list of paging groups.", "operationId" : "getAllPagingGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Paging Group" ], "summary" : "Create paging group", "description" : "Use to create a paging group", "operationId" : "createPagingGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Paging group object", "required" : true, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid paging group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid paging group object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/grouppaging/{pagingGroupId}" : { "get" : { "tags" : [ "Paging Group" ], "summary" : "Retrieve paging group", "description" : "Use to retrieve a paging group", "operationId" : "getPagingGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pagingGroupId", "in" : "path", "description" : "ID of paging group", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid account ID or paging group ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid account ID or paging group ID" }, "404" : { "description" : "Not found" } } }, "put" : { "tags" : [ "Paging Group" ], "summary" : "Update paging group", "description" : "Use to update a paging group", "operationId" : "updatePagingGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pagingGroupId", "in" : "path", "description" : "ID of paging group", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Paging group object", "required" : true, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid paging group ID or paging group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid paging group ID or paging group object" }, "404" : { "description" : "Not found" } } }, "delete" : { "tags" : [ "Paging Group" ], "summary" : "Delete paging group", "description" : "Use to delete a paging group", "operationId" : "deletePagingGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pagingGroupId", "in" : "path", "description" : "ID of paging group", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid paging group ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid paging group ID" }, "404" : { "description" : "Not found" } } }, "patch" : { "tags" : [ "Paging Group" ], "summary" : "Update paging group", "description" : "Use to update a paging group", "operationId" : "patchPagingGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pagingGroupId", "in" : "path", "description" : "ID of paging group", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Paging group object", "required" : true, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid paging group ID or paging group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" }, "schema" : { "originalRef" : "PagingGroupX", "$ref" : "#/definitions/PagingGroupX" } }, "400" : { "description" : "Invalid paging group ID or paging group object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/grouppickup/{pickupGroupId}" : { "get" : { "tags" : [ "Pickup Group" ], "summary" : "Retrieve pickup group", "description" : "Use to retrieve a pickup group", "operationId" : "getPickupGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pickupGroupId", "in" : "path", "description" : "ID of pickup group", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid account ID or pickup group ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid account ID or pickup group ID" }, "404" : { "description" : "Not found" } } }, "put" : { "tags" : [ "Pickup Group" ], "summary" : "Update pickup group", "description" : "Use to update a pickup group", "operationId" : "updatePickupGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pickupGroupId", "in" : "path", "description" : "ID of pickup group", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Pickup group object", "required" : true, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid pickup group ID or pickup group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid pickup group ID or pickup group object" }, "404" : { "description" : "Not found" } } }, "delete" : { "tags" : [ "Pickup Group" ], "summary" : "Delete pickup group", "description" : "Use to delete a pickup group", "operationId" : "deletePickupGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pickupGroupId", "in" : "path", "description" : "ID of pickup group", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid pickup group ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid pickup group ID" }, "404" : { "description" : "Not found" } } }, "patch" : { "tags" : [ "Pickup Group" ], "summary" : "Update pickup group", "description" : "Use to update a pickup group", "operationId" : "patchPickupGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "pickupGroupId", "in" : "path", "description" : "ID of pickup group", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Pickup group object", "required" : true, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid pickup group ID or pickup group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid pickup group ID or pickup group object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/grouppickup" : { "get" : { "tags" : [ "Pickup Group" ], "summary" : "Get pickup group list", "description" : "Use to retrieve a list of pickup groups.", "operationId" : "getAllPickupGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Pickup Group" ], "summary" : "Create pickup group", "description" : "Use to create a pickup group", "operationId" : "createPickupGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Pickup group object", "required" : true, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid pickup group object" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" }, "schema" : { "originalRef" : "PickupGroupX", "$ref" : "#/definitions/PickupGroupX" } }, "400" : { "description" : "Invalid pickup group object" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/emergency-notifications/events" : { "get" : { "tags" : [ "Emergency Notification" ], "summary" : "Retrieve notification event list", "description" : "Use to retrieve all NotificationEvents for an account", "operationId" : "retrieveNotificationEvent", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" } } } } } }, "/v2/partition/{partitionId}/account/{accountId}/emergency-notifications/groups" : { "get" : { "tags" : [ "Emergency Notification" ], "summary" : "Retrieve notification group list", "description" : "Use to retrieve a list of notification group associated to an account", "operationId" : "listNotificationGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } } } } }, "/v2/partition/{partitionId}/account/{accountId}/emergency-notifications/groups/{type}/{groupId}" : { "get" : { "tags" : [ "Emergency Notification" ], "summary" : "Retrieve notification group", "description" : "Use to retrieve a specific NotificationGroup (include Compliance & configurations) for id/type", "operationId" : "retrieveNotificationGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string", "enum" : [ "ACCOUNT" ] }, { "name" : "groupId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" }, "schema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" }, "schema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } } }, "put" : { "tags" : [ "Emergency Notification" ], "summary" : "Update notification group", "description" : "Use to update specific NotificationGroup (only Compliance & configurations) for id/type", "operationId" : "updateNotificationGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string", "enum" : [ "ACCOUNT" ] }, { "name" : "groupId", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Notification Group object", "required" : true, "schema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" }, "schema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" }, "schema" : { "originalRef" : "NotificationGroup", "$ref" : "#/definitions/NotificationGroup" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/emergency-notifications/groups/{type}/{groupId}/execute-test" : { "post" : { "tags" : [ "Emergency Notification" ], "summary" : "Execute test", "description" : "Execute a test of all NotificationConfigurations associated with the specified NotificationGroup", "operationId" : "executeTest", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "type", "in" : "path", "required" : true, "type" : "string", "enum" : [ "ACCOUNT" ] }, { "name" : "groupId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" }, "schema" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" }, "schema" : { "originalRef" : "NotificationEvent", "$ref" : "#/definitions/NotificationEvent" } } } } }, "/v2/partition/{partitionId}/account/{accountId}/accountuser" : { "get" : { "tags" : [ "Account User" ], "summary" : "Get user list", "description" : "Use to retrieve a list of users. limitedData is provided to enable large result sets retreived without long retrieval times", "operationId" : "list", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "limitedData", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Account User" ], "summary" : "Create user", "description" : "Use to create a user", "operationId" : "create_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "End user object", "required" : true, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user object" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user" : { "get" : { "tags" : [ "End User" ], "summary" : "Get end user list", "description" : "Use to retrieve a list of end users. limitedData is provided to enable large result sets retreived without long retrieval times", "operationId" : "retrieveEndUserList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "limitedData", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } }, "400" : { "description" : "Invalid partition or account ID" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "End User" ], "summary" : "Create end user", "description" : "Use to create a end user", "operationId" : "createEndUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "End user object", "required" : true, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid user object" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/prevalidate/email/{email}" : { "get" : { "tags" : [ "End User" ], "summary" : "Prevalidate the end user's email address before saving the end user", "description" : "Use to prevalidate the email address. If the user hasn't been created yet, use as is. If the User already exists, provide qualified query param `userId`", "operationId" : "prevalidateEmailAddress", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "email", "in" : "path", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } }, "400" : { "description" : "Invalid partition, account ID, or user ID. Validation error if email is in use." }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } }, "400" : { "description" : "Invalid partition, account ID, or user ID. Validation error if email is in use." }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/activation" : { "post" : { "tags" : [ "End User" ], "summary" : "End User activation", "description" : "(DEPRECATED) Use to create a new end user/device/csr to an existing account", "operationId" : "activation_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account activation object", "required" : true, "schema" : { "originalRef" : "EndUserActivationV2X", "$ref" : "#/definitions/EndUserActivationV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserActivationV2X", "$ref" : "#/definitions/EndUserActivationV2X" }, "schema" : { "originalRef" : "EndUserActivationV2X", "$ref" : "#/definitions/EndUserActivationV2X" } }, "400" : { "description" : "Invalid end user activation object(s) supplied" }, "404" : { "description" : "Account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserActivationV2X", "$ref" : "#/definitions/EndUserActivationV2X" }, "schema" : { "originalRef" : "EndUserActivationV2X", "$ref" : "#/definitions/EndUserActivationV2X" } }, "400" : { "description" : "Invalid end user activation object(s) supplied" }, "404" : { "description" : "Account not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/accountuser/{userId}" : { "get" : { "tags" : [ "Account User" ], "summary" : "Retrieve user", "description" : "Use to retrieve a user", "operationId" : "getUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "name" : "idType", "in" : "query", "description" : "Defines if the Id is the userid for the username", "required" : false, "type" : "string", "enum" : [ "Id", "UserName" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid account ID or user ID" }, "404" : { "description" : "Account user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid account ID or user ID" }, "404" : { "description" : "Account user not found" } } }, "put" : { "tags" : [ "Account User" ], "summary" : "Update user", "description" : "Use to update a user", "operationId" : "update_3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account user object", "required" : true, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user ID or user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user ID or user object" }, "404" : { "description" : "User not found" } } }, "delete" : { "tags" : [ "Account User" ], "summary" : "Delete user", "description" : "Use to delete a user", "operationId" : "delete_3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid user ID" }, "404" : { "description" : "Account user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid user ID" }, "404" : { "description" : "Account user not found" } } }, "patch" : { "tags" : [ "Account User" ], "summary" : "Update user", "description" : "Use to update a user", "operationId" : "patch_3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Account user object", "required" : true, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user ID or user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user ID or user object" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/accountuser/{userId}/resetpassword" : { "put" : { "tags" : [ "Account User" ], "summary" : "Reset user password", "description" : "Use to reset the password of a user", "operationId" : "resetPassword_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user ID" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" }, "schema" : { "originalRef" : "AccountUserX", "$ref" : "#/definitions/AccountUserX" } }, "400" : { "description" : "Invalid user ID" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}" : { "get" : { "tags" : [ "End User" ], "summary" : "Retrieve end user", "description" : "Use to retrieve a end user", "operationId" : "retrieveEndUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "name" : "idType", "in" : "query", "description" : "Defines if the Id is the userid for the username", "required" : false, "type" : "string", "enum" : [ "Id", "UserName" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid account ID or user ID" }, "404" : { "description" : "End user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid account ID or user ID" }, "404" : { "description" : "End user not found" } } }, "put" : { "tags" : [ "End User" ], "summary" : "Update end user", "description" : "Use to update a end user", "operationId" : "updateEndUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "End user object", "required" : true, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID or user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID or user object" }, "404" : { "description" : "User not found" } } }, "delete" : { "tags" : [ "End User" ], "summary" : "Delete end user", "description" : "Use to delete a end user", "operationId" : "deleteEndUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Invalid end user ID" }, "404" : { "description" : "End user not found" } }, "responsesObject" : { "400" : { "description" : "Invalid end user ID" }, "404" : { "description" : "End user not found" } } }, "patch" : { "tags" : [ "End User" ], "summary" : "Update end user", "description" : "Use to update a end user", "operationId" : "patch_4", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "End user object", "required" : true, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID or user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID or user object" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/send-welcome-email" : { "post" : { "tags" : [ "End User" ], "summary" : "Send welcome email to user", "description" : "Use to send a welcome email to the user", "operationId" : "sendWelcomeEmail", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "404" : { "description" : "User not found" } }, "responsesObject" : { "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/callingplanproduct/{callingPlanProductId}" : { "put" : { "tags" : [ "End User" ], "summary" : "Change Calling Plan", "description" : "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan. If a pending calling plan already exists it will remove it and set the new calling plan", "operationId" : "changeCallingPlan_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "name" : "callingPlanProductId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/callingplanswap" : { "post" : { "tags" : [ "End User" ], "summary" : "Change Calling Plan Immediately", "description" : "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan", "operationId" : "swapCallingPlan_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "CallingPlanSwapX", "$ref" : "#/definitions/CallingPlanSwapX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/cancelpendingcallingplan" : { "delete" : { "tags" : [ "End User" ], "summary" : " Cancel Pending Callingplan", "description" : "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan", "operationId" : "cancelPendingCallingPlan_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/voicemail" : { "get" : { "tags" : [ "End User" ], "summary" : "Retrieve end user voicemail", "description" : "Use to retrieve a end user's voicemail", "operationId" : "getVoicemailData", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } } }, "400" : { "description" : "Invalid account ID or end user ID" }, "404" : { "description" : "Account or end user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } } }, "400" : { "description" : "Invalid account ID or end user ID" }, "404" : { "description" : "Account or end user not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/unlockvm" : { "put" : { "tags" : [ "End User" ], "summary" : "Unlock end user voicemail", "description" : "Use to unlock a end user's voicemail", "operationId" : "unlockVm", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "name" : "resetPin", "in" : "query", "description" : "New voicemail Pin", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid user ID or pin" }, "404" : { "description" : "End user not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid user ID or pin" }, "404" : { "description" : "End user not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/resetpassword" : { "put" : { "tags" : [ "End User" ], "summary" : "Reset end user password", "description" : "Use to reset the password of a end user", "operationId" : "resetPassword_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/repurpose" : { "put" : { "tags" : [ "End User" ], "summary" : "Repurpose an existing user to be a different user (end user swap)", "description" : "Use to reuse a user for a new user", "operationId" : "repurposeEndUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "End user data to overwrite existing user data", "required" : true, "schema" : { "originalRef" : "ReassignEndUserX", "$ref" : "#/definitions/ReassignEndUserX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID or user object" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "schema" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" } }, "400" : { "description" : "Invalid end user ID or user object" }, "404" : { "description" : "User not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device" : { "get" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Retrieve device list", "description" : "Use to retrieve a list of devices associated to an account and a user, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead", "operationId" : "listDeviceByUser", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } }, "deprecated" : true }, "post" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Create a new device", "description" : "Use to create a new device on a user, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead", "operationId" : "createDevice_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device object", "required" : true, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } ], "responses" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid device object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "201" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid device object supplied" }, "404" : { "description" : "Not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device/validateproperties" : { "get" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Pre-validate property on the Device object", "description" : "DEPRECATED use /v2/partition/{id}/account/{id}/device/{macaddress}/validateproperties endpoint instead", "operationId" : "validateProperties_3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "name" : "macaddress", "in" : "query", "description" : "Mac Address", "required" : true, "type" : "string" }, { "name" : "lineno", "in" : "query", "description" : "Line Number", "required" : true, "type" : "integer", "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "boolean" }, "schema" : { "type" : "boolean" } } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device/{deviceId}/provisioningstatus" : { "get" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Retrieve device provisioning status", "description" : "Use to retrieve a device's provisioning status, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id}/provisioningstatus endpoint instead", "operationId" : "getProvisioningStatus", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" }, "schema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" }, "schema" : { "originalRef" : "DeviceStatusX", "$ref" : "#/definitions/DeviceStatusX" } }, "404" : { "description" : "Device not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device/{deviceId}/registrationstatus" : { "get" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Retrieve device registration status", "description" : "Use to retrieve a device's registration status, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id}/registrationstatus endpoint instead", "operationId" : "getRegistrationStatus_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" }, "schema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" }, "schema" : { "originalRef" : "RegistrationStatusX", "$ref" : "#/definitions/RegistrationStatusX" } }, "404" : { "description" : "Device not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device/{deviceId}" : { "get" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Retrieve device", "description" : "Use to retrieve a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead", "operationId" : "getDevice_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid partition, account or user ID supplied" }, "404" : { "description" : "User not found" } }, "deprecated" : true }, "put" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Update device", "description" : "Use to update a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead", "operationId" : "updateDevice_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device object", "required" : true, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } }, "deprecated" : true }, "delete" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Delete device", "description" : "Use to delete a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead", "operationId" : "removeDevice_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "404" : { "description" : "Device not found" } }, "deprecated" : true }, "patch" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Update device", "description" : "Use to update a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead", "operationId" : "patchDevice", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Device object", "required" : true, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "404" : { "description" : "Device not found" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device/{deviceId}/swap" : { "post" : { "tags" : [ "Device (Deprecated)" ], "summary" : "Swap device", "description" : "Use to replace an existing device with a new device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id}/swap endpoint instead", "operationId" : "swapDevice_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "deviceId", "in" : "path", "description" : "DeviceId", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "userId", "in" : "path", "description" : "ID of end-user", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "DeviceSwap object containing the new macAddress and deviceTypeId", "required" : true, "schema" : { "originalRef" : "DeviceSwapX", "$ref" : "#/definitions/DeviceSwapX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid MAC or device type supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "schema" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "400" : { "description" : "Invalid MAC or device type supplied" } }, "deprecated" : true } }, "/v2/partition/{partitionId}/account/{accountId}/vfax/{id}" : { "get" : { "tags" : [ "Virtual Fax Line" ], "summary" : "Retrieve Virtual Fax Line", "description" : "Use to retrieve a Virtual Fax Line", "operationId" : "retrieveVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "VirtualFaxLineID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line ID supplied" }, "404" : { "description" : "Not found" } } }, "put" : { "tags" : [ "Virtual Fax Line" ], "summary" : "Update Virtual Fax Line", "description" : "Use to update a Virtual Fax Line", "operationId" : "updateVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "VirtualFaxLineID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Virtual Fax Line object", "required" : true, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line ID or Virtual Fax Line object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line ID or Virtual Fax Line object supplied" }, "404" : { "description" : "Not found" } } }, "delete" : { "tags" : [ "Virtual Fax Line" ], "summary" : "Delete Virtual Fax Line", "description" : "Use to delete a Virtual Fax Line", "operationId" : "deleteVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "VirtualFaxLineID", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid Virtual Fax Line ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid Virtual Fax Line ID supplied" }, "404" : { "description" : "Not found" } } }, "patch" : { "tags" : [ "Virtual Fax Line" ], "summary" : "Update Virtual Fax Line", "description" : "Use to update a Virtual Fax Line", "operationId" : "patchVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "id", "in" : "path", "description" : "VirtualFaxLineID", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Virtual Fax Line object", "required" : true, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line ID or Virtual Fax Line object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line ID or Virtual Fax Line object supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/vfax" : { "get" : { "tags" : [ "Virtual Fax Line" ], "summary" : "Retrieve list of Virtual Fax Lines", "description" : "Use to retrieve a list of all Virtual Fax Lines on an account", "operationId" : "retrieveVFaxList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } } }, "400" : { "description" : "Invalid partition or account ID supplied" }, "404" : { "description" : "List not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } } }, "400" : { "description" : "Invalid partition or account ID supplied" }, "404" : { "description" : "List not found" } } }, "post" : { "tags" : [ "Virtual Fax Line" ], "summary" : "Create a Virtual Fax Line", "description" : "Use to create a VirtualFaxLine", "operationId" : "createVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line object supplied" }, "404" : { "description" : "Partition or account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" }, "schema" : { "originalRef" : "VirtualFaxLineX", "$ref" : "#/definitions/VirtualFaxLineX" } }, "400" : { "description" : "Invalid Virtual Fax Line object supplied" }, "404" : { "description" : "Partition or account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/vfax/outbound" : { "get" : { "tags" : [ "Virtual Fax" ], "summary" : "Retrieve Outbound Virtual Fax Configuration", "description" : "Use to retrieve the outbound vfax configuration on an account", "operationId" : "retrieveOutboundVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" }, "schema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" } }, "403" : { "description" : "Partition or account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" }, "schema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" } }, "403" : { "description" : "Partition or account not found" } } }, "put" : { "tags" : [ "Virtual Fax" ], "summary" : "Update Outbound Virtual Fax Configuration", "description" : "Use to configure outbound vfax for an account", "operationId" : "updateOutboundVFax", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Outbound vfax configuration", "required" : true, "schema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" }, "schema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" } }, "403" : { "description" : "Partition or account not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" }, "schema" : { "originalRef" : "VfaxOutbound", "$ref" : "#/definitions/VfaxOutbound" } }, "403" : { "description" : "Partition or account not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox" : { "get" : { "tags" : [ "Voicemail Box" ], "summary" : "Retrieve voicemail box list", "description" : "Use to retrieve a list of voicemail boxes for an account", "operationId" : "retrieveVoicemailBoxList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "parentId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } } }, "400" : { "description" : "Invalid partition, account or voicemail box supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } } }, "400" : { "description" : "Invalid partition, account or voicemail box supplied" } } }, "post" : { "tags" : [ "Voicemail Box" ], "summary" : "Create voicemail box", "description" : "Use to create a new voicemail box", "operationId" : "createVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "voicemail message object", "required" : true, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/pin" : { "put" : { "tags" : [ "Voicemail Box" ], "summary" : "Set a PIN for a reference using a voicemail box", "description" : "", "operationId" : "setPin", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "PinChange", "$ref" : "#/definitions/PinChange" } } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/greetings/{greetingType}/media" : { "get" : { "tags" : [ "Voicemail Box" ], "summary" : "Retrieve User Greeting media file", "description" : "Use to retrieve media file for a users voicemail box", "operationId" : "retrieveGreeting", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "greetingType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "Personal", "PersonalNoAnswer", "PersonalBusy", "PersonalName", "PrimaryGreeting" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } } }, "put" : { "tags" : [ "Voicemail Box" ], "summary" : "Upload User Greeting media file", "description" : "Use to upload media file for a users voicemail box (wav, mp3, ogg)", "operationId" : "uploadGreeting", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "greetingType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "Personal", "PersonalNoAnswer", "PersonalBusy", "PersonalName", "PrimaryGreeting" ] }, { "name" : "file", "in" : "formData", "description" : "Media file", "required" : true, "type" : "file" } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } }, "delete" : { "tags" : [ "Voicemail Box" ], "summary" : "Delete User Greeting media file", "description" : "Use to delete media file for a users voicemail box", "operationId" : "deleteGreeting", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "greetingType", "in" : "path", "required" : true, "type" : "string", "enum" : [ "Personal", "PersonalNoAnswer", "PersonalBusy", "PersonalName", "PrimaryGreeting" ] } ], "responses" : { "default" : { "description" : "successful operation" } }, "responsesObject" : { "default" : { "description" : "successful operation" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}" : { "get" : { "tags" : [ "Voicemail Box" ], "summary" : "Get voicemail box", "description" : "Use to retrieve a voicemail box", "operationId" : "retrieveVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "invalid voicemail message id supplied" }, "404" : { "description" : "voicemail message not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "invalid voicemail message id supplied" }, "404" : { "description" : "voicemail message not found" } } }, "put" : { "tags" : [ "Voicemail Box" ], "summary" : "Update voicemail box", "description" : "Use to update a voicemail box", "operationId" : "updateVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "voicemail message object", "required" : true, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" }, "404" : { "description" : "voicemail box not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" }, "404" : { "description" : "voicemail box not found" } } }, "delete" : { "tags" : [ "Voicemail Box" ], "summary" : "Delete voicemail box", "description" : "Use to delete a voicemail box.", "operationId" : "deleteVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "voicemail box id not found" }, "404" : { "description" : "voicemail box not found" } }, "responsesObject" : { "400" : { "description" : "voicemail box id not found" }, "404" : { "description" : "voicemail box not found" } } }, "patch" : { "tags" : [ "Voicemail Box" ], "summary" : "Update voicemail box", "description" : "Use to update a voicemail box", "operationId" : "patchVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "voicemail message object", "required" : true, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" }, "404" : { "description" : "voicemail box not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" }, "404" : { "description" : "voicemail box not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/unlock" : { "put" : { "tags" : [ "Voicemail Box" ], "summary" : "Unlock a sub voicemailbox", "description" : "Use to unlock the pin on a subvoicemail box", "operationId" : "unlockVoicemailBox", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "resetPin", "in" : "query", "description" : "New voicemail Pin", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" }, "404" : { "description" : "voicemail box not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" }, "schema" : { "originalRef" : "VoicemailBoxX", "$ref" : "#/definitions/VoicemailBoxX" } }, "400" : { "description" : "voicemail error" }, "404" : { "description" : "voicemail box not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/voicemailmessage/{messageId}" : { "get" : { "tags" : [ "Voicemail Message" ], "summary" : "Get voicemail message", "description" : "Use to retrieve a voicemail message", "operationId" : "retrieve_8", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "description" : "MessageId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" }, "schema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "400" : { "description" : "invalid voicemail message id supplied" }, "404" : { "description" : "voicemail message not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" }, "schema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "400" : { "description" : "invalid voicemail message id supplied" }, "404" : { "description" : "voicemail message not found" } } }, "put" : { "tags" : [ "Voicemail Message" ], "summary" : "Update voicemail message", "description" : "Use to update a voicemail message; can only update read status", "operationId" : "update_4", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "description" : "MessageId", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "voicemail message object", "required" : true, "schema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" }, "schema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "400" : { "description" : "voicemail message not found" }, "404" : { "description" : "voicemail message not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" }, "schema" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "400" : { "description" : "voicemail message not found" }, "404" : { "description" : "voicemail message not found" } } }, "delete" : { "tags" : [ "Voicemail Message" ], "summary" : "Delete voicemail message", "description" : "Use to delete a voicemail message", "operationId" : "delete_4", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "description" : "MessageId", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "voicemail message id not found or invalid voicemail message object supplied" }, "404" : { "description" : "voicemail message not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "voicemail message id not found or invalid voicemail message object supplied" }, "404" : { "description" : "voicemail message not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/voicemailmessage" : { "get" : { "tags" : [ "Voicemail Message" ], "summary" : "Retrieve voicemail message list", "description" : "Use to retrieve a list of voicemail messages in a voicemail box", "operationId" : "list_1", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } } }, "400" : { "description" : "Invalid partition, account or voicemail box supplied" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } } }, "400" : { "description" : "Invalid partition, account or voicemail box supplied" } } }, "delete" : { "tags" : [ "Voicemail Message" ], "summary" : "Delete multiple voicemails", "description" : "Use to delete multiple voicemails in a single call", "operationId" : "deleteMultiple", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "400" : { "description" : "Invalid partition, account or voicemail box supplied" } }, "responsesObject" : { "400" : { "description" : "Invalid partition, account or voicemail box supplied" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/voicemailmessage/{messageId}/content_2" : { "get" : { "tags" : [ "Voicemail Message" ], "summary" : "Get contents of voicemail message. Will return a 302 redirect to the actual image location. Pass query param mediatype=mp3 or wav", "description" : "Use to retrieve Media of a given type", "operationId" : "getVoicemailUrl", "consumes" : [ "application/json" ], "produces" : [ "audio/mpeg", "audio/wave" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "description" : "ID of voicemail message", "required" : true, "type" : "string" }, { "name" : "mediatype", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid id" }, "404" : { "description" : "voicemail message not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid id" }, "404" : { "description" : "voicemail message not found" } } } }, "/v2/partition/{partitionId}/account/{accountId}/voicemailbox/{voicemailBoxId}/voicemailmessage/{messageId}/content" : { "get" : { "tags" : [ "Voicemail Message" ], "summary" : "get contents of a voicemail message", "description" : "Use to get contents of a voicemail message", "operationId" : "getMessageContent", "consumes" : [ "application/json" ], "produces" : [ "audio/mpeg", "audio/wave" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "accountId", "in" : "path", "description" : "ID of account", "required" : true, "type" : "string" }, { "name" : "voicemailBoxId", "in" : "path", "description" : "ID of Voicemail Box", "required" : true, "type" : "string" }, { "name" : "messageId", "in" : "path", "description" : "ID of voicemail message", "required" : true, "type" : "string" }, { "name" : "fileName", "in" : "query", "description" : "Name of prompt", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid id" }, "404" : { "description" : "voicemail message not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } }, "400" : { "description" : "Invalid id" }, "404" : { "description" : "voicemail message not found" } } } }, "/v2/partition/{partitionId}/callingplanproduct/{cppId}" : { "get" : { "tags" : [ "Calling Plan Product" ], "summary" : "Retrieve calling plan product", "description" : "Use to retrieve a calling plan product", "operationId" : "get_3", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "cppId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Calling plan not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Calling plan not found" } } }, "put" : { "tags" : [ "Calling Plan Product" ], "summary" : "Update calling plan product", "description" : "Use to update calling plan product", "operationId" : "update_5", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Calling plan product object", "required" : true, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, { "name" : "cppId", "in" : "path", "description" : "ID of calling plan product", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid ID or object supplied" }, "404" : { "description" : "Calling plan not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid ID or object supplied" }, "404" : { "description" : "Calling plan not found" } } }, "patch" : { "tags" : [ "Calling Plan Product" ], "summary" : "Update calling plan product", "description" : "Use to update calling plan product", "operationId" : "patch_5", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Calling plan product object", "required" : true, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, { "name" : "cppId", "in" : "path", "description" : "ID of calling plan product", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid ID or object supplied" }, "404" : { "description" : "Calling plan not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid ID or object supplied" }, "404" : { "description" : "Calling plan not found" } } } }, "/v2/partition/{partitionId}/callingplanproduct" : { "get" : { "tags" : [ "Calling Plan Product" ], "summary" : "Retrieve calling plan product list", "description" : "Use to retrieve a list of calling plan products", "operationId" : "retrieveCallingPlanProductList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "includeArchived", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "uniqueItems" : true }, "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "uniqueItems" : true }, "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } } }, "400" : { "description" : "Invalid partition ID supplied" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Calling Plan Product" ], "summary" : "Add calling plan product", "description" : "Use to add a calling plan product", "operationId" : "add_2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Calling plan product object", "required" : true, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid calling plan object supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } }, "400" : { "description" : "Invalid calling plan object supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/partition/{partitionId}/callingplanproduct/import" : { "post" : { "tags" : [ "Calling Plan Product" ], "operationId" : "add_1", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "required" : false, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" }, "schema" : { "originalRef" : "Calling Plan Product", "$ref" : "#/definitions/Calling Plan Product" } } } } }, "/v2/partition/{partitionId}/callingplanproduct/{cppId}/archive-callingplan" : { "delete" : { "tags" : [ "Calling Plan Product" ], "summary" : "Archive calling plan product", "description" : "Use to archive calling plan product to make them unusable for future assignment", "operationId" : "archive", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "name" : "cppId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Calling plan not found" } }, "responsesObject" : { "400" : { "description" : "Invalid ID supplied" }, "404" : { "description" : "Calling plan not found" } } } }, "/v2/partition/{partitionId}/callingplanproduct/{cppId}/callingplanproductdefinition" : { "get" : { "tags" : [ "Calling Plan Product" ], "summary" : "Retrieve the calling plan definition", "description" : "Use to download the current calling plan definition", "operationId" : "telephoneNumberCSVReport_1", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "cppId", "in" : "path", "description" : "ID of calling plan product", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID or calling plan product ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid partition ID or calling plan product ID supplied" }, "404" : { "description" : "Not found" } } }, "post" : { "tags" : [ "Calling Plan Product" ], "summary" : "Add calling plan rates", "description" : "Use to add calling plan rates", "operationId" : "add_3", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "cppId", "in" : "path", "description" : "ID of calling plan product", "required" : true, "type" : "string" }, { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionId", "in" : "path", "description" : "ID of partition", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "List of rates", "required" : true, "schema" : { "originalRef" : "MultipartFormDataInput", "$ref" : "#/definitions/MultipartFormDataInput" } } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } }, "400" : { "description" : "Invalid partition ID or calling plan product ID supplied" }, "404" : { "description" : "Not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "FileImportValidationErrorX", "$ref" : "#/definitions/FileImportValidationErrorX" } } }, "400" : { "description" : "Invalid partition ID or calling plan product ID supplied" }, "404" : { "description" : "Not found" } } } }, "/v2/ref/default-callingplan-definition" : { "get" : { "tags" : [ "Calling Plan" ], "summary" : "Retrieve the default calling plan definition file", "description" : "Use to retrieve the default calling plan definition file", "operationId" : "getCallingPlanDefinition", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "File not found" } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } }, "400" : { "description" : "Invalid" }, "404" : { "description" : "File not found" } } } }, "/v2/ref/devicetype/{id}" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "DeviceType", "description" : "Retrieve a specific DeviceType", "operationId" : "get_4", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" }, "schema" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" }, "schema" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" } } } } }, "/v2/ref/devicetype" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "DeviceTypes List", "description" : "Retrieve a list of device types available to the given partition", "operationId" : "getDeviceTypes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "partitionid", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" } } } } } }, "/v2/ref/dialplan/actiontypes" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "DialPlanActionTypes List", "description" : "Retrieve a list of available dial plan action types", "operationId" : "getDialPlanActions", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "includeRestricted", "in" : "query", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "TranslateAndReapplyDialPlan", "CallOutboundNumber", "CallCustomerServiceHuntGroup", "Callback", "CallForwardingAlways", "CallForwardingOnBusy", "CallForwardingOnNoAnswer", "CallForwardingOnUnregistered", "CallNonEmergencyServices", "CallPublicServices", "CallCanadaHealthServices", "CallerIdBlockManage", "EnterVoiceMail", "DirectToVoicemail", "CallWaitingEnable", "CallWaitingDisable", "AnonymousCallRejectEnable", "AnonymousCallRejectDisable", "AnonymousCallRejectWithInterceptEnable", "AnonymousCallRejectWithInterceptDisable", "SelectiveCallAcceptEnable", "SelectiveCallAcceptDisable", "SpecificCallerBlock", "SpecificCallerBlockWithIntercept", "SpecificCallerAllow", "SpecificCallerVipRing", "SpecificCallerForwardEnable", "AccountAnonymousCallRejectEnable", "AccountAnonymousCallRejectDisable", "AccountAnonymousCallRejectWithInterceptEnable", "AccountAnonymousCallRejectWithInterceptDisable", "AccountSelectiveCallAcceptEnable", "AccountSelectiveCallAcceptDisable", "AccountSpecificCallerBlock", "AccountSpecificCallerAllow", "AccountSpecificCallerBlockWithIntercept", "DoNotDisturbEnable", "DoNotDisturbDisable", "PickupInDirectory", "CallTrace", "ParkCall", "ParkCallRetrieval", "DirectedCallPickUp", "GroupPickup", "ReservedForHuntGroup", "GroupForwarding", "CallPull", "GroupLoginLogout" ] } } }, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "TranslateAndReapplyDialPlan", "CallOutboundNumber", "CallCustomerServiceHuntGroup", "Callback", "CallForwardingAlways", "CallForwardingOnBusy", "CallForwardingOnNoAnswer", "CallForwardingOnUnregistered", "CallNonEmergencyServices", "CallPublicServices", "CallCanadaHealthServices", "CallerIdBlockManage", "EnterVoiceMail", "DirectToVoicemail", "CallWaitingEnable", "CallWaitingDisable", "AnonymousCallRejectEnable", "AnonymousCallRejectDisable", "AnonymousCallRejectWithInterceptEnable", "AnonymousCallRejectWithInterceptDisable", "SelectiveCallAcceptEnable", "SelectiveCallAcceptDisable", "SpecificCallerBlock", "SpecificCallerBlockWithIntercept", "SpecificCallerAllow", "SpecificCallerVipRing", "SpecificCallerForwardEnable", "AccountAnonymousCallRejectEnable", "AccountAnonymousCallRejectDisable", "AccountAnonymousCallRejectWithInterceptEnable", "AccountAnonymousCallRejectWithInterceptDisable", "AccountSelectiveCallAcceptEnable", "AccountSelectiveCallAcceptDisable", "AccountSpecificCallerBlock", "AccountSpecificCallerAllow", "AccountSpecificCallerBlockWithIntercept", "DoNotDisturbEnable", "DoNotDisturbDisable", "PickupInDirectory", "CallTrace", "ParkCall", "ParkCallRetrieval", "DirectedCallPickUp", "GroupPickup", "ReservedForHuntGroup", "GroupForwarding", "CallPull", "GroupLoginLogout" ] } } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "TranslateAndReapplyDialPlan", "CallOutboundNumber", "CallCustomerServiceHuntGroup", "Callback", "CallForwardingAlways", "CallForwardingOnBusy", "CallForwardingOnNoAnswer", "CallForwardingOnUnregistered", "CallNonEmergencyServices", "CallPublicServices", "CallCanadaHealthServices", "CallerIdBlockManage", "EnterVoiceMail", "DirectToVoicemail", "CallWaitingEnable", "CallWaitingDisable", "AnonymousCallRejectEnable", "AnonymousCallRejectDisable", "AnonymousCallRejectWithInterceptEnable", "AnonymousCallRejectWithInterceptDisable", "SelectiveCallAcceptEnable", "SelectiveCallAcceptDisable", "SpecificCallerBlock", "SpecificCallerBlockWithIntercept", "SpecificCallerAllow", "SpecificCallerVipRing", "SpecificCallerForwardEnable", "AccountAnonymousCallRejectEnable", "AccountAnonymousCallRejectDisable", "AccountAnonymousCallRejectWithInterceptEnable", "AccountAnonymousCallRejectWithInterceptDisable", "AccountSelectiveCallAcceptEnable", "AccountSelectiveCallAcceptDisable", "AccountSpecificCallerBlock", "AccountSpecificCallerAllow", "AccountSpecificCallerBlockWithIntercept", "DoNotDisturbEnable", "DoNotDisturbDisable", "PickupInDirectory", "CallTrace", "ParkCall", "ParkCallRetrieval", "DirectedCallPickUp", "GroupPickup", "ReservedForHuntGroup", "GroupForwarding", "CallPull", "GroupLoginLogout" ] } } }, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "TranslateAndReapplyDialPlan", "CallOutboundNumber", "CallCustomerServiceHuntGroup", "Callback", "CallForwardingAlways", "CallForwardingOnBusy", "CallForwardingOnNoAnswer", "CallForwardingOnUnregistered", "CallNonEmergencyServices", "CallPublicServices", "CallCanadaHealthServices", "CallerIdBlockManage", "EnterVoiceMail", "DirectToVoicemail", "CallWaitingEnable", "CallWaitingDisable", "AnonymousCallRejectEnable", "AnonymousCallRejectDisable", "AnonymousCallRejectWithInterceptEnable", "AnonymousCallRejectWithInterceptDisable", "SelectiveCallAcceptEnable", "SelectiveCallAcceptDisable", "SpecificCallerBlock", "SpecificCallerBlockWithIntercept", "SpecificCallerAllow", "SpecificCallerVipRing", "SpecificCallerForwardEnable", "AccountAnonymousCallRejectEnable", "AccountAnonymousCallRejectDisable", "AccountAnonymousCallRejectWithInterceptEnable", "AccountAnonymousCallRejectWithInterceptDisable", "AccountSelectiveCallAcceptEnable", "AccountSelectiveCallAcceptDisable", "AccountSpecificCallerBlock", "AccountSpecificCallerAllow", "AccountSpecificCallerBlockWithIntercept", "DoNotDisturbEnable", "DoNotDisturbDisable", "PickupInDirectory", "CallTrace", "ParkCall", "ParkCallRetrieval", "DirectedCallPickUp", "GroupPickup", "ReservedForHuntGroup", "GroupForwarding", "CallPull", "GroupLoginLogout" ] } } } } } } }, "/v2/ref/language" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "Language List", "description" : "Retrieve a list of supported Languages", "operationId" : "getLanguages", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "LanguageReferenceX", "$ref" : "#/definitions/LanguageReferenceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "LanguageReferenceX", "$ref" : "#/definitions/LanguageReferenceX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "LanguageReferenceX", "$ref" : "#/definitions/LanguageReferenceX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "LanguageReferenceX", "$ref" : "#/definitions/LanguageReferenceX" } } } } } }, "/v2/ref/permissions" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "PermissionType and Access List", "description" : "Retrieve a list of available Permission Types and their max Access level for a given UserType", "operationId" : "getPermissions", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "usertype", "in" : "query", "required" : false, "type" : "string", "default" : "ManagementUser", "enum" : [ "AccountUser", "EndUser", "ManagementUser", "AlianzaUser", "BusinessLines" ] } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "PermissionTypeDefaultsX", "$ref" : "#/definitions/PermissionTypeDefaultsX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "PermissionTypeDefaultsX", "$ref" : "#/definitions/PermissionTypeDefaultsX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "PermissionTypeDefaultsX", "$ref" : "#/definitions/PermissionTypeDefaultsX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "PermissionTypeDefaultsX", "$ref" : "#/definitions/PermissionTypeDefaultsX" } } } } } }, "/v2/ref/routeplan-definition-template" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "RoutePlan default template", "description" : "Get the default rates csv for a RoutePlan", "operationId" : "getRoutePlanDefinitionTemplate", "consumes" : [ "application/json" ], "produces" : [ "text/csv" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "string" }, "schema" : { "type" : "string" } } } } }, "/v2/ref/secondary-location-types" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "Address - SecondaryLocationType List", "description" : "Get a list of available SecondaryLocationTypes", "operationId" : "getSecondaryLocations", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] } } }, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] } } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] } } }, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] } } } } } } }, "/v2/ref/sidecartype/{id}" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "Device - SideCarType", "description" : "Get a given SideCarType", "operationId" : "get_5", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" }, "schema" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" }, "schema" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" } } } } }, "/v2/ref/sidecartype" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "Device - SideCarType List", "description" : "Get a list of available SideCarTypes", "operationId" : "getSideCarTypes", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" } } } } } }, "/v2/ref/system-default-media/{type}" : { "get" : { "tags" : [ "Reference Resources" ], "operationId" : "getList", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "type", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SystemDefaultMediaX", "$ref" : "#/definitions/SystemDefaultMediaX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SystemDefaultMediaX", "$ref" : "#/definitions/SystemDefaultMediaX" } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "headers" : { }, "responseSchema" : { "type" : "array", "items" : { "originalRef" : "SystemDefaultMediaX", "$ref" : "#/definitions/SystemDefaultMediaX" } }, "schema" : { "type" : "array", "items" : { "originalRef" : "SystemDefaultMediaX", "$ref" : "#/definitions/SystemDefaultMediaX" } } } } } }, "/v2/ref/timezones" : { "get" : { "tags" : [ "Reference Resources" ], "summary" : "TimeZone List", "description" : "Get a list of supported TimeZones", "operationId" : "getTimeZones", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "X-AUTH-TOKEN", "in" : "header", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] } } }, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] } } } } }, "responsesObject" : { "200" : { "description" : "successful operation", "responseSchema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] } } }, "schema" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] } } } } } } } }, "definitions" : { "AddressValidationX" : { "type" : "object", "properties" : { "requiredFields" : { "type" : "array", "items" : { "type" : "string" } }, "customerServiceRecord" : { "originalRef" : "CustomerServiceRecordX", "$ref" : "#/definitions/CustomerServiceRecordX" }, "latitude" : { "type" : "string" }, "longitude" : { "type" : "string" }, "valid" : { "type" : "boolean" } } }, "CustomerServiceRecordX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "firstName" : { "type" : "string" }, "middleInitial" : { "type" : "string" }, "lastName" : { "type" : "string" }, "businessName" : { "type" : "string" }, "streetNumber" : { "type" : "string" }, "streetNumberSuffix" : { "type" : "string" }, "preDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "streetName" : { "type" : "string" }, "streetSuffix" : { "type" : "string" }, "postDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "postalCode" : { "type" : "string" }, "secondaryLocationDescription" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] }, "unit" : { "type" : "string" }, "customerType" : { "type" : "string", "enum" : [ "BUSINESS", "RESIDENTIAL" ] }, "firstNameSecondary" : { "type" : "string" }, "blockCustomerName" : { "type" : "boolean" }, "customerName" : { "type" : "string" } } }, "ZipcodeX" : { "type" : "object", "properties" : { "zipCode" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" } } }, "LoginTokenX" : { "type" : "object", "properties" : { "authToken" : { "type" : "string" }, "userId" : { "type" : "string" }, "userType" : { "type" : "string", "enum" : [ "AccountUser", "EndUser", "ManagementUser", "AlianzaUser", "BusinessLines" ] }, "endUserType" : { "type" : "string", "enum" : [ "ADMIN", "ADVANCED_ADMIN", "BASIC_ADMIN", "STANDARD", "STANDARD_ADMIN", "SUPER_ADMIN" ] }, "username" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "emailAddress" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "partitionName" : { "type" : "string" }, "accountId" : { "type" : "string" }, "permissions" : { "type" : "object", "additionalProperties" : { "type" : "string", "enum" : [ "NONE", "READ_MYUSER", "READ", "EDIT_MYUSER", "EDIT", "CREATE_MYUSER", "CREATE", "DELETE_MYUSER", "DELETE", "DENIED" ] } }, "featureToggles" : { "type" : "object", "additionalProperties" : { "type" : "boolean" } }, "mustChangePassword" : { "type" : "boolean" }, "subPartitionIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "tokenSource" : { "type" : "string" }, "grantedAuthorities" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "mustAddEmail" : { "type" : "boolean" }, "pwdHash" : { "type" : "string" }, "maxLifeInHours" : { "type" : "integer", "format" : "int32" }, "groupId" : { "type" : "string" }, "groupName" : { "type" : "string" } } }, "Login" : { "type" : "object", "required" : [ "password", "username" ], "properties" : { "username" : { "type" : "string" }, "password" : { "type" : "string" }, "changePassword" : { "type" : "string", "description" : "This should be used only when changing the password" } } }, "SsoDataX" : { "type" : "object", "properties" : { "clientId" : { "type" : "string" }, "ssoUrl" : { "type" : "string" } } }, "LanguageX" : { "type" : "object", "properties" : { "prefLang" : { "type" : "string" } } }, "RateCenterSearchViewX" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "abbrName" : { "type" : "string" }, "reorderName" : { "type" : "string" }, "reorderNameAlias" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" }, "msa" : { "type" : "string" }, "zips" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "prefixes" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberPrefixViewX", "$ref" : "#/definitions/TelephoneNumberPrefixViewX" } }, "distance" : { "type" : "number", "format" : "double" } } }, "TelephoneNumberPrefixViewX" : { "type" : "object", "properties" : { "prefix" : { "type" : "string" }, "wireless" : { "type" : "boolean" }, "wirelessBlockNumbers" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string", "format" : "byte" } } } }, "Job" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "userId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "PENDING", "IN_PROGRESS", "DONE", "FAILED" ] }, "errors" : { "type" : "array", "items" : { "originalRef" : "JobError", "$ref" : "#/definitions/JobError" } }, "inputKey" : { "type" : "string" }, "outputKey" : { "type" : "string" }, "start" : { "type" : "integer", "format" : "int64" }, "lastUpdated" : { "type" : "integer", "format" : "int64" } } }, "JobError" : { "type" : "object", "properties" : { "error" : { "type" : "string" }, "lineNumber" : { "type" : "integer", "format" : "int32" }, "column" : { "type" : "string" }, "input" : { "type" : "string" } } }, "JobUpload" : { "type" : "object", "properties" : { "url" : { "type" : "string" }, "key" : { "type" : "string" } } }, "InputStream" : { "type" : "object" }, "JobOutputUrl" : { "type" : "object", "properties" : { "url" : { "type" : "string" } } }, "JobUploadKey" : { "type" : "object", "properties" : { "key" : { "type" : "string" } } }, "FileImportValidationErrorX" : { "type" : "object", "properties" : { "lineNumber" : { "type" : "integer", "format" : "int32" }, "error" : { "type" : "string" }, "column" : { "type" : "string" }, "input" : { "type" : "string" } } }, "MultipartFormDataInput" : { "type" : "object" }, "CymbusPartitionGroup" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "supportEmail" : { "type" : "string" }, "productName" : { "type" : "string" }, "voicemailStarCode" : { "type" : "string" }, "proxyHost" : { "type" : "string" }, "groupName" : { "type" : "string" } } }, "RequestedDeviceLineX" : { "type" : "object", "properties" : { "macAddress" : { "type" : "string" }, "lineNumber" : { "type" : "integer", "format" : "int32" }, "userId" : { "type" : "string" }, "displayName" : { "type" : "string" }, "sipUsername" : { "type" : "string" }, "sipPassword" : { "type" : "string" }, "dialPlan" : { "type" : "string" }, "server" : { "type" : "string" }, "serverPort" : { "type" : "string" }, "emergencyNumber" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "faxEnabled" : { "type" : "boolean" } } }, "RequestedDeviceX" : { "type" : "object", "properties" : { "macAddress" : { "type" : "string" }, "deviceType" : { "type" : "string" }, "lineCount" : { "type" : "integer", "format" : "int32" }, "dialPlan" : { "type" : "string" }, "hasFaxEnabledLine" : { "type" : "boolean" }, "lines" : { "type" : "array", "items" : { "originalRef" : "RequestedDeviceLineX", "$ref" : "#/definitions/RequestedDeviceLineX" } } } }, "InboundRate" : { "type" : "object", "properties" : { "rate" : { "type" : "number", "format" : "double" }, "allowCalls" : { "type" : "boolean" } } }, "InboundRatePlanProductX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "name" : { "type" : "string" }, "defaultPlan" : { "type" : "boolean" }, "archived" : { "type" : "boolean" }, "rates" : { "type" : "object", "additionalProperties" : { "originalRef" : "InboundRate", "$ref" : "#/definitions/InboundRate" } } } }, "ManagementUserX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "password" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "emailAddress" : { "type" : "string" }, "mustChangePassword" : { "type" : "boolean" }, "languageTag" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "roles" : { "type" : "array", "xml" : { "wrapped" : true }, "uniqueItems" : true, "items" : { "type" : "string", "xml" : { "name" : "role" } } }, "groupIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "ManagementUserSearchResponseX" : { "type" : "object", "properties" : { "totalRecords" : { "type" : "integer", "format" : "int64" }, "results" : { "type" : "array", "items" : { "originalRef" : "ManagementUserX", "$ref" : "#/definitions/ManagementUserX" } } } }, "SsoUserX" : { "type" : "object", "properties" : { "ssoStatus" : { "type" : "string" } } }, "DialPlanRuleX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "mask" : { "type" : "string" }, "actionType" : { "type" : "string", "enum" : [ "TranslateAndReapplyDialPlan", "CallOutboundNumber", "CallCustomerServiceHuntGroup", "Callback", "CallForwardingAlways", "CallForwardingOnBusy", "CallForwardingOnNoAnswer", "CallForwardingOnUnregistered", "CallNonEmergencyServices", "CallPublicServices", "CallCanadaHealthServices", "CallerIdBlockManage", "EnterVoiceMail", "DirectToVoicemail", "CallWaitingEnable", "CallWaitingDisable", "AnonymousCallRejectEnable", "AnonymousCallRejectDisable", "AnonymousCallRejectWithInterceptEnable", "AnonymousCallRejectWithInterceptDisable", "SelectiveCallAcceptEnable", "SelectiveCallAcceptDisable", "SpecificCallerBlock", "SpecificCallerBlockWithIntercept", "SpecificCallerAllow", "SpecificCallerVipRing", "SpecificCallerForwardEnable", "AccountAnonymousCallRejectEnable", "AccountAnonymousCallRejectDisable", "AccountAnonymousCallRejectWithInterceptEnable", "AccountAnonymousCallRejectWithInterceptDisable", "AccountSelectiveCallAcceptEnable", "AccountSelectiveCallAcceptDisable", "AccountSpecificCallerBlock", "AccountSpecificCallerAllow", "AccountSpecificCallerBlockWithIntercept", "DoNotDisturbEnable", "DoNotDisturbDisable", "PickupInDirectory", "CallTrace", "ParkCall", "ParkCallRetrieval", "DirectedCallPickUp", "GroupPickup", "ReservedForHuntGroup", "GroupForwarding", "CallPull", "GroupLoginLogout" ] }, "callNumber" : { "type" : "string" }, "endingMinimumLength" : { "type" : "integer", "format" : "int32" }, "endingMaximumLength" : { "type" : "integer", "format" : "int32" }, "translationMacro" : { "type" : "string" }, "disableCallerId" : { "type" : "boolean" }, "callerIdVisibilityOverride" : { "type" : "string", "enum" : [ "UseDestinationCallerIdEnabledSetting", "Blocked", "Unblocked" ] }, "disableCallWaiting" : { "type" : "boolean" }, "overwriteCallerIdNumber" : { "type" : "string" }, "bypassAuthorization" : { "type" : "boolean" }, "outboundNumberFunction" : { "type" : "string", "enum" : [ "CUSTOMER_SERVICE", "DIRECTORY_ASSISTANCE", "EMERGENCY_SERVICES", "ESSENTIAL_COMMUNITY_SERVICES", "NONURGENT_MUNICIPAL_GOVERNMENT_SERVICES", "NONURGENT_TELEHEALTH_SERVICES", "OPERATOR", "SPEED_DIAL", "TELECOMMUNICATIONS_RELAY_SERVICE", "TRAFFIC_INFORMATION", "UNDERGROUND_PUBLIC_UTILITY_LOCATION" ] }, "id" : { "type" : "string" } } }, "MediaFriendsX" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "host" : { "type" : "string" }, "toNumber" : { "type" : "string" } } }, "PartitionX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "ARCHIVED", "HIDDEN" ] }, "customerServiceNumber" : { "type" : "string" }, "parentId" : { "type" : "string" }, "useAccountNumberDefault" : { "type" : "boolean" }, "bypassVoicemailPINValidationFromDevice" : { "type" : "boolean" }, "billingCode" : { "type" : "string" }, "country" : { "type" : "string" }, "reorderNotifications" : { "type" : "array", "items" : { "type" : "string" } }, "subPartitionIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "useOwnCarrier" : { "type" : "boolean" }, "availableInboundCarrierId" : { "type" : "array", "items" : { "type" : "string" } }, "defaultRoutePlanId" : { "type" : "string", "format" : "uuid" }, "tnDeleteCooldownDays" : { "type" : "integer", "format" : "int32" }, "defaultTimeZone" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] }, "tempTnThreshold" : { "type" : "integer", "format" : "int32" }, "serviceDialPlanRules" : { "type" : "array", "items" : { "originalRef" : "DialPlanRuleX", "$ref" : "#/definitions/DialPlanRuleX" } }, "mediaFriends" : { "originalRef" : "MediaFriendsX", "$ref" : "#/definitions/MediaFriendsX" }, "defaultSimpleDialingBehaviorType" : { "type" : "string", "enum" : [ "SEVEN_DIGIT", "TEN_DIGIT", "OPEN_DIAL_PLAN", "DIAL_NINE_SEVEN_DIGIT", "DIAL_NINE_TEN_DIGIT", "OPEN_DIAL_PLAN_TEN_DIGIT" ] }, "defaultAdvancedDialingBehaviorType" : { "type" : "string", "enum" : [ "SEVEN_DIGIT", "TEN_DIGIT", "OPEN_DIAL_PLAN", "DIAL_NINE_SEVEN_DIGIT", "DIAL_NINE_TEN_DIGIT", "OPEN_DIAL_PLAN_TEN_DIGIT" ] }, "defaultDirectoryListingType" : { "type" : "string", "enum" : [ "ERROR", "LIST_PUBLISH", "LIST_NOT_PUBLISH", "NOT_LIST_NOT_PUBLISH", "PORTED", "COMPLEX" ] }, "portPushDays" : { "type" : "integer", "format" : "int32" }, "allowedDeviceTypes" : { "type" : "array", "items" : { "type" : "string" } }, "defaultHoldTimeoutSeconds" : { "type" : "integer", "format" : "int32" }, "allowLoginByAccountNumber" : { "type" : "boolean" }, "requiresDeviceInventory" : { "type" : "boolean" }, "usesTrammellE911Verification" : { "type" : "boolean" }, "showComplexListing" : { "type" : "boolean" }, "defaultExtensionLength" : { "type" : "integer", "format" : "int32" }, "autoAssignCallerId" : { "type" : "boolean" }, "byotnCarrierId" : { "type" : "string" } } }, "PartitionSettingX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "IntegrationNotificationEmail", "CDRReportColumns", "SipTrunkProxyServer", "AllowAccountDangerousExtensions", "InboundRatePlanDefault", "SUB_DOMAINS", "SEND_WELCOME_EMAIL", "REGULATORY_TYPE", "ACCOUNT_HOLD_MUSIC_DEFAULT", "PLATFORM_TYPE_DEFAULT", "GENERATED_SIP_PASSWORD_LENGTH", "ENABLE_STAGED_CALL", "MAX_BURST_CALL_PERCENTAGE", "ALLOW_VM_MESSAGE_ACCESS" ] }, "value" : { "type" : "object" } } }, "BandwidthSettingsX" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "siteId" : { "type" : "string" }, "peerId" : { "type" : "string" } } }, "E911AccountX" : { "type" : "object", "properties" : { "e911ProviderType" : { "type" : "string", "enum" : [ "INTRADO", "WEST", "DISABLED", "BANDWIDTH", "SINCH", "INTRADO_ENTERPRISE" ] }, "accountId" : { "type" : "string" }, "authToken" : { "type" : "string" } } }, "InboundCarrierX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "carrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] }, "partitionAvailability" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "l3Settings" : { "originalRef" : "L3SettingsX", "$ref" : "#/definitions/L3SettingsX" }, "supportsCSRUpdate" : { "type" : "boolean" }, "supportCNAMChange" : { "type" : "boolean" }, "supportDirectoryListing" : { "type" : "boolean" }, "supportPorting" : { "type" : "boolean" }, "supportHotCutPorting" : { "type" : "boolean" }, "hasTNs" : { "type" : "boolean" }, "e911Account" : { "originalRef" : "E911AccountX", "$ref" : "#/definitions/E911AccountX" }, "smsCallbackUrl" : { "type" : "string" }, "portPushDays" : { "type" : "integer", "format" : "int32" }, "bandwidthSettings" : { "originalRef" : "BandwidthSettingsX", "$ref" : "#/definitions/BandwidthSettingsX" }, "enableDynamicInventory" : { "type" : "boolean" }, "enableByotn" : { "type" : "boolean" }, "sinchSettings" : { "originalRef" : "SinchSettingsX", "$ref" : "#/definitions/SinchSettingsX" }, "cnamCarrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] }, "dlCarrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] } } }, "L3SettingsX" : { "type" : "object", "properties" : { "servicePackage" : { "type" : "string", "enum" : [ "Usage", "PrimaryLocalFlatRate", "PrimaryLocalAndDomesticLDFlatRate", "SecondaryLocalFlatRate", "SecondaryLocalAndDomesticLDFlatRate" ] }, "availableServicePackages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Usage", "PrimaryLocalFlatRate", "PrimaryLocalAndDomesticLDFlatRate", "SecondaryLocalFlatRate", "SecondaryLocalAndDomesticLDFlatRate" ] } }, "seasonalSuspendServicePackage" : { "type" : "string", "enum" : [ "Usage", "PrimaryLocalFlatRate", "PrimaryLocalAndDomesticLDFlatRate", "SecondaryLocalFlatRate", "SecondaryLocalAndDomesticLDFlatRate" ] }, "b2BPartnerID" : { "type" : "string" }, "customerServiceName" : { "type" : "string" }, "bizOrg" : { "type" : "string" } } }, "SinchSettingsX" : { "type" : "object", "properties" : { "serviceType" : { "type" : "string", "enum" : [ "ALL_IN_TN", "USAGE_TN", "BYOC" ] }, "routingOption" : { "type" : "string" }, "apiKey" : { "type" : "string" }, "apiSecret" : { "type" : "string" } } }, "PartitionDataHistorySearchResponseX" : { "type" : "object", "properties" : { "totalRecords" : { "type" : "integer", "format" : "int64" }, "results" : { "type" : "array", "items" : { "originalRef" : "PartitionDataHistoryX", "$ref" : "#/definitions/PartitionDataHistoryX" } } } }, "PartitionDataHistoryX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "PARTITION", "PLATFORM_USER", "PLATFORM_USER_GROUP", "CALLING_PLAN", "INBOUND_RATE_PLAN", "LOCAL_CALLING_PLANS", "TN_INVENTORY", "PARTITION_SETTINGS", "FEATURE_TOGGLES", "IP_WHITELIST", "DIAL_PLAN_RULE", "ROUTE_PLAN" ] }, "createdDate" : { "type" : "string", "format" : "date-time" }, "userId" : { "type" : "string" }, "userName" : { "type" : "string" }, "userType" : { "type" : "string", "enum" : [ "AccountUser", "EndUser", "ManagementUser", "AlianzaUser", "BusinessLines" ] }, "searchTags" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "actionType" : { "type" : "string" }, "relatedDataId" : { "type" : "string" }, "relatedDataType" : { "type" : "string" }, "relatedDataDisplayName" : { "type" : "string" }, "oldValue" : { "type" : "string" }, "newValue" : { "type" : "string" } } }, "StreamingOutput" : { "type" : "object" }, "ReportSummaryX" : { "type" : "object", "properties" : { "newCount" : { "type" : "integer", "format" : "int64" }, "totalCount" : { "type" : "integer", "format" : "int64" } } }, "SecurityPermissionX" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "NONE", "Account", "AccountHistory", "AccountCallHistory", "AccountBulkStatuses", "IpWhitelist", "PhoneNumber", "PhoneNumberServiceActivation", "PhoneNumberInventory", "Product", "ProductCallingPlan", "ProductGroups", "ProductUsers", "Reports", "RoutePlan", "SipCredentials", "EU_DeviceSwapCreate", "EU_Account", "EU_AccountMedia", "EU_CallHistory", "EU_Device", "EU_DeviceSwap", "EU_DeviceLine", "EU_IVR", "EU_LineAppearance", "EU_LineHardware", "EU_LineHuntGroup", "EU_Voicemail", "EU_VoicemailMessage", "EU_VoicemailUnlock", "EU_Telephone", "EU_SipTrunk", "EU_User", "EU_UserResetPassword", "EU_History", "EU_BUSINESS_LINE", "EU_BUSINESS_LINE_PROVISIONING", "EU_BUSINESS_LINE_VOICEMAIL", "EU_BUSINESS_LINE_HUNT_GROUP", "EU_911_ADDRESS", "EU_TELEPHONE_DESTINATION", "EU_ENDUSER_REPURPOSE", "ALIANZA_MasterRoutePlan", "ALIANZA_TogglzAdmin", "ANY_END_USER", "ANY_MANAGEMENT_USER", "ANY_ALIANZA_USER" ] }, "accessType" : { "type" : "string", "enum" : [ "NONE", "READ_MYUSER", "READ", "EDIT_MYUSER", "EDIT", "CREATE_MYUSER", "CREATE", "DELETE_MYUSER", "DELETE", "DENIED" ] } } }, "SecurityRoleX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "name" : { "type" : "string" }, "userType" : { "type" : "string", "enum" : [ "AccountUser", "EndUser", "ManagementUser", "AlianzaUser", "BusinessLines" ] }, "userCount" : { "type" : "integer", "format" : "int32" }, "permissions" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "SecurityPermissionX", "$ref" : "#/definitions/SecurityPermissionX" } } } }, "TelephoneNumberViewX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "phoneNumber" : { "type" : "string" }, "rateCenter" : { "type" : "string" }, "rateCenterReorderName" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "prefix" : { "type" : "string" }, "accountId" : { "type" : "string" }, "carrierId" : { "type" : "string" }, "cooldownExpireDate" : { "type" : "string", "format" : "date-time" }, "cooldownRecoveredDate" : { "type" : "string", "format" : "date-time" }, "functionType" : { "type" : "string", "enum" : [ "ELS", "TollFree", "TemporaryNumber", "SPTN" ] }, "claimTicketId" : { "type" : "string" }, "matchesZip" : { "type" : "boolean" }, "distance" : { "type" : "number", "format" : "float" }, "byotn" : { "type" : "boolean" }, "activationDate" : { "type" : "integer", "format" : "int64" }, "isInInventory" : { "type" : "boolean" }, "operationalStatus" : { "type" : "string", "enum" : [ "ACTIVE", "STAGED" ] }, "id" : { "type" : "string" }, "port" : { "type" : "boolean" } } }, "TelephoneNumberAvailabilityX" : { "type" : "object", "properties" : { "prefix" : { "type" : "string" }, "reorderName" : { "type" : "string" }, "originalReorderName" : { "type" : "string" }, "name" : { "type" : "string" }, "abbrName" : { "type" : "string" }, "msa" : { "type" : "string" }, "zips" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "wireless" : { "type" : "boolean" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "portable" : { "type" : "boolean" }, "serviceAvailable" : { "type" : "boolean" }, "inboundCarrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] } } }, "ServiceActivationEventLogX" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "PENDING", "IN_PROGRESS", "REJECTED", "FOC_RECEIVED", "FOC_REMOVED", "CANCELLED", "CANCEL_PENDING", "CARRIER_CANCELLED", "DELETE_PENDING", "DELETE_SCHEDULED", "COMPLETED", "CORRECTED_COMPLETED", "COOLDOWN", "HOT_CUT_PORT", "ON_HOLD", "RESELLER_PENDING" ] }, "actionDate" : { "type" : "string", "format" : "date-time" }, "code" : { "type" : "string" }, "message" : { "type" : "string" }, "creationDate" : { "type" : "string", "format" : "date-time" }, "generatedTicketId" : { "type" : "string" } } }, "ServiceActivationEventResponseX" : { "type" : "object", "properties" : { "totalRecords" : { "type" : "integer", "format" : "int64" }, "results" : { "type" : "array", "items" : { "originalRef" : "ServiceActivationEventX", "$ref" : "#/definitions/ServiceActivationEventX" } } } }, "ServiceActivationEventX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "serviceType" : { "type" : "string", "enum" : [ "PORT_REQUEST", "CSR_CHANGE_REQUEST", "ACTIVATION", "NINE_ONE_ONE_ADDRESS", "DISCONNECT", "DYNAMIC_RESERVATION", "BYOTN_REQUEST", "SERVICE_PROVIDER_TN" ] }, "referenceType" : { "type" : "string", "enum" : [ "TELEPHONE", "PORT", "DYNAMIC_INVENTORY", "BYOTN", "BYOTN_PORT" ] }, "referenceId" : { "type" : "string" }, "activationStatusType" : { "type" : "string", "enum" : [ "PENDING", "IN_PROGRESS", "REJECTED", "FOC_RECEIVED", "FOC_REMOVED", "CANCELLED", "CANCEL_PENDING", "CARRIER_CANCELLED", "DELETE_PENDING", "DELETE_SCHEDULED", "COMPLETED", "CORRECTED_COMPLETED", "COOLDOWN", "HOT_CUT_PORT", "ON_HOLD", "RESELLER_PENDING" ] }, "createdDate" : { "type" : "string", "format" : "date-time" }, "lastUpdatedDate" : { "type" : "string", "format" : "date-time" }, "focDate" : { "type" : "string", "format" : "date-time" }, "crdDate" : { "type" : "string", "format" : "date-time" }, "city" : { "type" : "string" }, "mainTelephoneNumber" : { "type" : "string" }, "subTelephoneNumbers" : { "type" : "array", "items" : { "type" : "string" } }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "companyName" : { "type" : "string" }, "state" : { "type" : "string" }, "l3Reaction" : { "type" : "string", "enum" : [ "IGNORE", "RESUBMIT", "CANCEL", "SEND_EMAIL" ] }, "parentOrderId" : { "type" : "string" }, "editableFieldTypes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "crdDate", "wirelessAccountNumber", "wirelessPin", "name" ] } }, "losingCarrier" : { "type" : "string" }, "inboundCarrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] }, "logs" : { "type" : "array", "items" : { "originalRef" : "ServiceActivationEventLogX", "$ref" : "#/definitions/ServiceActivationEventLogX" } } } }, "TelephoneNumberReservedX" : { "type" : "object", "properties" : { "tn" : { "type" : "string" }, "reservedTime" : { "type" : "string", "format" : "date-time" }, "id" : { "type" : "string" }, "reserved" : { "type" : "boolean" } } }, "Account" : { "type" : "object", "required" : [ "accountName", "accountNumber", "accountType", "billingCycleDay", "dialingBehaviorType", "extensionLength", "id", "inboundRatePlanProductId", "partitionId", "regulatoryType", "status", "timeZone" ], "properties" : { "id" : { "type" : "string", "description" : "Required to update an account, not required for new account" }, "partitionId" : { "type" : "string" }, "accountNumber" : { "type" : "string" }, "accountName" : { "type" : "string" }, "billingCycleDay" : { "type" : "integer", "format" : "int32" }, "customField" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "DISABLED", "DELETED", "DELETE_PENDING", "SUSPENDED", "PENDING" ] }, "timeZone" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] }, "deletionDate" : { "type" : "string", "format" : "date-time" }, "accountType" : { "type" : "string", "enum" : [ "SIMPLE", "ADVANCED" ] }, "platformType" : { "type" : "string", "enum" : [ "V2_0", "V2_1", "CPE1", "CPE2" ] }, "platformChangeDate" : { "type" : "string", "format" : "date-time" }, "inboundRatePlanProductId" : { "type" : "string", "description" : "inboundRatePlanProductId is only required for accounts with toll-free numbers" }, "extensionLength" : { "type" : "integer", "format" : "int32", "description" : "Length of extension, not required for simple account" }, "dialingBehaviorType" : { "type" : "string", "enum" : [ "SEVEN_DIGIT", "TEN_DIGIT", "OPEN_DIAL_PLAN", "DIAL_NINE_SEVEN_DIGIT", "DIAL_NINE_TEN_DIGIT", "OPEN_DIAL_PLAN_TEN_DIGIT" ] }, "routePlanId" : { "type" : "string", "format" : "uuid", "description" : "Route plan to be used to route outbound calls from this account" }, "callScreeningSettings" : { "description" : "Call Screening settings to be applied to all phone numbers on reception of inbound calls", "originalRef" : "CallScreeningSettingsX", "$ref" : "#/definitions/CallScreeningSettingsX" }, "holdMusicMediaId" : { "type" : "string", "description" : "HoldMusic Media Id" }, "holdTimeoutSeconds" : { "type" : "integer", "format" : "int32", "description" : "Hold Timeout Seconds" }, "allowDangerousExtensions" : { "type" : "boolean", "description" : "Allows extensions starting with 1" }, "domain" : { "type" : "string", "description" : "Overrides partition default brand which is used for end user emails and portal" }, "sendWelcomeEmail" : { "type" : "boolean", "description" : "Specifies if new users will receive a welcome email" }, "regulatoryType" : { "type" : "string", "enum" : [ "RESIDENTIAL", "COMMERCIAL", "GOVERNMENT" ] }, "endUserCount" : { "type" : "integer", "format" : "int64" }, "customHoldMusicMediaId" : { "type" : "string" }, "callingPlans" : { "type" : "array", "xml" : { "wrapped" : true }, "items" : { "xml" : { "name" : "callingPlan" }, "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } } } }, "AddressX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "firstName" : { "type" : "string" }, "middleInitial" : { "type" : "string" }, "lastName" : { "type" : "string" }, "businessName" : { "type" : "string" }, "streetNumber" : { "type" : "string" }, "streetNumberSuffix" : { "type" : "string" }, "preDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "streetName" : { "type" : "string" }, "streetSuffix" : { "type" : "string" }, "postDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "postalCode" : { "type" : "string" }, "secondaryLocationDescription" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] }, "unit" : { "type" : "string" } } }, "CallHandlingScheduleX" : { "type" : "object", "properties" : { "schedule" : { "originalRef" : "ScheduleX", "$ref" : "#/definitions/ScheduleX" }, "callHandling" : { "originalRef" : "CallHandlingSettingsX", "$ref" : "#/definitions/CallHandlingSettingsX" } } }, "CallHandlingSettingsX" : { "type" : "object", "properties" : { "callWaitingEnabled" : { "type" : "boolean" }, "doNotDisturbEnabled" : { "type" : "boolean" }, "callHandlingOptionType" : { "type" : "string", "enum" : [ "RingPhone", "ForwardAlways", "SimultaneousRing", "FindMeFollowMe" ] }, "forwardAlwaysToNumber" : { "type" : "string" }, "forwardAlwaysToNumberDescription" : { "type" : "string" }, "ringPhoneCallHandling" : { "originalRef" : "RingPhoneCallHandlingX", "$ref" : "#/definitions/RingPhoneCallHandlingX" }, "simultaneousRingCallHandling" : { "originalRef" : "SimultaneousRingCallHandlingX", "$ref" : "#/definitions/SimultaneousRingCallHandlingX" }, "findMeFollowMeCallHandling" : { "originalRef" : "FindMeFollowMeCallHandlingX", "$ref" : "#/definitions/FindMeFollowMeCallHandlingX" } } }, "CallHandlingWithTimeoutX" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "Forward", "Voicemail", "Busy", "RingForever" ] }, "timeout" : { "type" : "integer", "format" : "int32" }, "forwardToNumber" : { "type" : "string" }, "description" : { "type" : "string" } } }, "CallHandlingX" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "Forward", "Voicemail", "Busy" ] }, "forwardToNumber" : { "type" : "string" }, "description" : { "type" : "string" } } }, "CallScreeningSettingsX" : { "type" : "object", "properties" : { "anonymousCallScreen" : { "type" : "string", "enum" : [ "Allow", "Block", "Voicemail", "Forward", "VipRing", "BlockWithPrompt" ] }, "anonymousRingType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "tollFreeCallScreen" : { "type" : "string", "enum" : [ "Allow", "Block", "Voicemail", "Forward", "VipRing", "BlockWithPrompt" ] }, "tollFreeRingType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "defaultCallScreen" : { "type" : "string", "enum" : [ "Allow", "Block", "Voicemail", "Forward", "VipRing", "BlockWithPrompt" ] }, "defaultRingType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "customCallScreenList" : { "type" : "array", "items" : { "originalRef" : "CustomCallScreenX", "$ref" : "#/definitions/CustomCallScreenX" } }, "forwardTn" : { "type" : "string" } } }, "CallerIdConfigX" : { "type" : "object", "required" : [ "callerIdNumber", "extensionCallerIdVisible", "externalCallerIdVisible" ], "properties" : { "callerIdNumber" : { "type" : "string" }, "externalCallerIdVisible" : { "type" : "boolean" }, "extensionCallerIdVisible" : { "type" : "boolean" }, "callerIdNumberReservationId" : { "type" : "string" } } }, "CallingPlanX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "referenceId" : { "type" : "string" }, "referenceType" : { "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "IVR", "ACCOUNT", "SPECIALTY_LINE", "CONTACT_CENTER" ] }, "callingPlanProductId" : { "type" : "string" }, "endDate" : { "type" : "string", "format" : "date-time" }, "startDate" : { "type" : "string", "format" : "date-time" }, "planMinutes" : { "type" : "integer", "format" : "int32" }, "secondsRemaining" : { "type" : "integer", "format" : "int64" } } }, "CustomCallScreenX" : { "type" : "object", "properties" : { "telephoneNumber" : { "type" : "string" }, "blockType" : { "type" : "string", "enum" : [ "Allow", "Block", "Voicemail", "Forward", "VipRing", "BlockWithPrompt" ] }, "ringType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] } } }, "CustomScheduleX" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date-time" }, "startTime" : { "type" : "string" }, "endTime" : { "type" : "string" } } }, "DeviceX" : { "type" : "object", "required" : [ "accountId", "deviceName", "deviceTypeId", "faxEnabled", "id", "partitionId", "userId" ], "properties" : { "id" : { "type" : "string" }, "deviceTypeId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "macAddress" : { "type" : "string" }, "deviceName" : { "type" : "string" }, "emergencyNumber" : { "type" : "string", "description" : "Required if emergencyNumberReservationId is absent" }, "emergencyNumberReservationId" : { "type" : "string", "description" : "Required if emergencyNumber is absent" }, "faxEnabled" : { "type" : "boolean" }, "lineNumber" : { "type" : "integer", "format" : "int32", "description" : "Required for POST & PUT operations only" }, "userId" : { "type" : "string" }, "sipPassword" : { "type" : "string" }, "sipUsername" : { "type" : "string", "description" : "Required to be globally unique if specified" }, "zipcode" : { "type" : "string" }, "state" : { "type" : "string" }, "lineType" : { "type" : "string", "enum" : [ "Line", "AdvancedSharedLine", "ReferencedUser", "IntercomLine", "PresenceBlfUser", "SpeedDialUser", "SpeedDialTn", "CallParkingSpot", "SipPaging" ] }, "referenceId" : { "type" : "string", "description" : "Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number" } } }, "DirectoryListingX" : { "type" : "object", "properties" : { "listed" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "ERROR", "LIST_PUBLISH", "LIST_NOT_PUBLISH", "NOT_LIST_NOT_PUBLISH", "PORTED", "COMPLEX" ] }, "address" : { "originalRef" : "AddressX", "$ref" : "#/definitions/AddressX" } } }, "DynamicTelephoneNumberActivationX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "carrierId" : { "type" : "string" }, "orderId" : { "type" : "string" }, "tnQuantity" : { "type" : "integer", "format" : "int32" }, "deviceId" : { "type" : "string" }, "userId" : { "type" : "string" }, "customerServiceRecord" : { "originalRef" : "LatLongCustomerServiceRecordX", "$ref" : "#/definitions/LatLongCustomerServiceRecordX" }, "directoryListing" : { "originalRef" : "DirectoryListingX", "$ref" : "#/definitions/DirectoryListingX" }, "e911Address" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "tnSettings" : { "originalRef" : "TelephoneNumberAccountBareX", "$ref" : "#/definitions/TelephoneNumberAccountBareX" }, "ringType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "archived" : { "type" : "boolean" }, "alianzaOrderId" : { "type" : "string" }, "id" : { "type" : "string" } } }, "E911AddressX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "firstName" : { "type" : "string" }, "middleInitial" : { "type" : "string" }, "lastName" : { "type" : "string" }, "businessName" : { "type" : "string" }, "streetNumber" : { "type" : "string" }, "streetNumberSuffix" : { "type" : "string" }, "preDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "streetName" : { "type" : "string" }, "streetSuffix" : { "type" : "string" }, "postDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "postalCode" : { "type" : "string" }, "secondaryLocationDescription" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] }, "unit" : { "type" : "string" }, "customerType" : { "type" : "string", "enum" : [ "BUSINESS", "RESIDENTIAL" ] }, "latitude" : { "type" : "string", "description" : "-90 through 90, 4-6 decimals" }, "longitude" : { "type" : "string", "description" : "-180 through 180, 4-6 decimals" }, "language" : { "type" : "string", "description" : "Optional, see /v2/ref/language for supported languages" } } }, "EndUserV2X" : { "type" : "object", "required" : [ "timeZone" ], "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "password" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "emailAddress" : { "type" : "string" }, "mustChangePassword" : { "type" : "boolean" }, "languageTag" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "callingPlans" : { "type" : "array", "xml" : { "wrapped" : true }, "description" : "callingPlans", "readOnly" : true, "items" : { "xml" : { "name" : "callingPlan" }, "originalRef" : "CallingPlanX", "$ref" : "#/definitions/CallingPlanX" } }, "devices" : { "type" : "array", "xml" : { "wrapped" : true }, "description" : "devices", "readOnly" : true, "items" : { "xml" : { "name" : "device" }, "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } }, "timeZone" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] }, "extension" : { "type" : "string" }, "callerIdConfig" : { "originalRef" : "CallerIdConfigX", "$ref" : "#/definitions/CallerIdConfigX" }, "callHandlingSettings" : { "originalRef" : "CallHandlingSettingsX", "$ref" : "#/definitions/CallHandlingSettingsX" }, "callScreeningSettings" : { "originalRef" : "CallScreeningSettingsX", "$ref" : "#/definitions/CallScreeningSettingsX" }, "newCppId" : { "type" : "string" }, "mediaFriends" : { "originalRef" : "MediaFriendsX", "$ref" : "#/definitions/MediaFriendsX" }, "callHandlingSchedules" : { "type" : "array", "items" : { "originalRef" : "CallHandlingScheduleX", "$ref" : "#/definitions/CallHandlingScheduleX" } }, "voicemailBoxId" : { "type" : "string" }, "endUserType" : { "type" : "string", "enum" : [ "ADMIN", "ADVANCED_ADMIN", "BASIC_ADMIN", "STANDARD", "STANDARD_ADMIN", "SUPER_ADMIN" ] }, "userProductPlan" : { "type" : "string", "enum" : [ "STANDARD", "ADVANCED", "PROFESSIONAL" ] }, "softphoneClientType" : { "type" : "string", "enum" : [ "STRETTO", "CYMBUS" ] }, "pinLockedOut" : { "type" : "boolean" }, "welcomeEmailSent" : { "type" : "string", "format" : "date-time" }, "blockEmail" : { "type" : "boolean" }, "allowPortalAccess" : { "type" : "boolean" }, "tags" : { "type" : "string" }, "group" : { "originalRef" : "UserGroupX", "$ref" : "#/definitions/UserGroupX" } } }, "EndUserWithMultipleTnActivationX" : { "type" : "object", "properties" : { "user" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "telephoneNumberAccounts" : { "type" : "array", "items" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" } }, "dynamicTelephoneNumberActivation" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "port" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "holdActivation" : { "type" : "boolean" } } }, "FindMeEndpointX" : { "type" : "object", "properties" : { "ringUserDevice" : { "type" : "boolean" }, "toNumber" : { "type" : "string" }, "description" : { "type" : "string" }, "timeout" : { "type" : "integer", "format" : "int32" } } }, "FindMeFollowMeCallHandlingX" : { "type" : "object", "properties" : { "findMeEndpoints" : { "type" : "array", "items" : { "originalRef" : "FindMeEndpointX", "$ref" : "#/definitions/FindMeEndpointX" } }, "timeoutType" : { "type" : "string", "enum" : [ "Forward", "Voicemail", "Busy", "RingForever" ] } } }, "LatLongCustomerServiceRecordX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "firstName" : { "type" : "string" }, "middleInitial" : { "type" : "string" }, "lastName" : { "type" : "string" }, "businessName" : { "type" : "string" }, "streetNumber" : { "type" : "string" }, "streetNumberSuffix" : { "type" : "string" }, "preDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "streetName" : { "type" : "string" }, "streetSuffix" : { "type" : "string" }, "postDirectional" : { "type" : "string", "enum" : [ "", "N", "NE", "E", "SE", "S", "SW", "W", "NW" ] }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "country" : { "type" : "string" }, "postalCode" : { "type" : "string" }, "secondaryLocationDescription" : { "type" : "string", "enum" : [ "", "APARTMENT", "BUILDING", "BASEMENT", "DEPARTMENT", "FLOOR", "FRONT", "HANGER", "KEY", "LOBBY", "LOT", "LOWER", "OFFICE", "PENTHOUSE", "PIER", "REAR", "ROOM", "SIDE", "SLIP", "SPACE", "SUITE", "STOP", "TRAILER", "UNIT", "UPPER" ] }, "unit" : { "type" : "string" }, "customerType" : { "type" : "string", "enum" : [ "BUSINESS", "RESIDENTIAL" ] }, "firstNameSecondary" : { "type" : "string" }, "blockCustomerName" : { "type" : "boolean" }, "customerName" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" } } }, "MultipleActivationX" : { "type" : "object", "required" : [ "account" ], "properties" : { "account" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" }, "endUsers" : { "type" : "array", "items" : { "originalRef" : "EndUserWithMultipleTnActivationX", "$ref" : "#/definitions/EndUserWithMultipleTnActivationX" } } } }, "PortX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "telephoneNumbers" : { "type" : "array", "xml" : { "wrapped" : true }, "items" : { "type" : "string", "xml" : { "name" : "telephoneNumber" } } }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "ACTIVATION_ON_HOLD", "ACTIVATION_PENDING", "PORT_PENDING", "CANCEL_PORT", "CANCEL_PORT_EXPIDITED", "DELETE_PENDING", "DELETED", "CANCEL_PORT_COMPLETE", "PORT_REJECTED", "INVENTORY", "INVENTORY_CLAIMED", "COOLDOWN", "RECOVERED" ] }, "sendLoa" : { "type" : "boolean" }, "loaSaved" : { "type" : "boolean" }, "carrierId" : { "type" : "string" }, "carrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] }, "customerServiceRecord" : { "originalRef" : "CustomerServiceRecordX", "$ref" : "#/definitions/CustomerServiceRecordX" }, "crdDate" : { "type" : "string", "format" : "date-time" }, "billingTelephoneNumber" : { "type" : "string" }, "portingWireType" : { "type" : "string", "enum" : [ "Wireless", "Wireline" ] }, "portingAuthorizedName" : { "type" : "string" }, "wirelessAccountNumber" : { "type" : "string" }, "wirelessPin" : { "type" : "string" }, "focDate" : { "type" : "string", "format" : "date-time" }, "focDateTimeZone" : { "type" : "string", "enum" : [ "US/Samoa", "US/Hawaii", "US/Alaska", "US/Pacific", "US/Arizona", "US/Mountain", "US/Central", "US/Eastern", "America/St_Thomas", "Canada/Pacific", "Canada/Mountain", "Canada/Central", "Canada/Eastern", "Canada/Atlantic", "Canada/Newfoundland" ] }, "createdDate" : { "type" : "string", "format" : "date-time" }, "completedDate" : { "type" : "string", "format" : "date-time" }, "cancelType" : { "type" : "string", "enum" : [ "NORMAL", "EXPIDITED", "BY_CARRIER" ] }, "telecomSettings" : { "originalRef" : "TelecomSettingsX", "$ref" : "#/definitions/TelecomSettingsX" }, "hotCutPortId" : { "type" : "string" }, "portNow" : { "type" : "boolean" }, "canAcceptSMS" : { "type" : "boolean" }, "smsCallbackUrl" : { "type" : "string" } } }, "RingPhoneCallHandlingX" : { "type" : "object", "properties" : { "busyCallHandling" : { "originalRef" : "CallHandlingX", "$ref" : "#/definitions/CallHandlingX" }, "noAnswerCallHandling" : { "originalRef" : "CallHandlingWithTimeoutX", "$ref" : "#/definitions/CallHandlingWithTimeoutX" }, "unregisteredCallHandling" : { "originalRef" : "CallHandlingX", "$ref" : "#/definitions/CallHandlingX" } } }, "ScheduleX" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "CUSTOM", "WEEKLY" ] }, "weekly" : { "type" : "object", "additionalProperties" : { "originalRef" : "WeeklyScheduleX", "$ref" : "#/definitions/WeeklyScheduleX" } }, "custom" : { "type" : "array", "items" : { "originalRef" : "CustomScheduleX", "$ref" : "#/definitions/CustomScheduleX" } } } }, "SimultaneousRingCallHandlingX" : { "type" : "object", "properties" : { "forwardToNumberList" : { "type" : "array", "items" : { "type" : "string" } }, "noAnswerCallHandling" : { "originalRef" : "CallHandlingWithTimeoutX", "$ref" : "#/definitions/CallHandlingWithTimeoutX" } } }, "TelecomSettingsX" : { "type" : "object", "properties" : { "notes" : { "type" : "string" }, "currentCarrier" : { "type" : "string" }, "currentCarrierName" : { "type" : "string" }, "localReseller" : { "type" : "string" }, "loaDate" : { "type" : "string", "format" : "date-time" }, "disconnectInternetService" : { "type" : "boolean" }, "disconnectTelevisionService" : { "type" : "boolean" }, "tnData" : { "type" : "object", "additionalProperties" : { "originalRef" : "TnData", "$ref" : "#/definitions/TnData" } } } }, "TelephoneNumberAccountBareX" : { "type" : "object", "properties" : { "phoneNumber" : { "type" : "string" }, "referenceType" : { "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "IVR", "LINE_APPEARANCE", "LINE_HUNTGROUP", "TELEPHONE", "VFAX", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "AUTO_ATTENDANT", "SPECIALTY_LINE", "CONTACT_CENTER" ] }, "referenceId" : { "type" : "string" }, "functionType" : { "type" : "string", "enum" : [ "ELS", "TollFree", "TemporaryNumber", "SPTN" ] }, "canAcceptSMS" : { "type" : "boolean" }, "operationalStatus" : { "type" : "string", "enum" : [ "ACTIVE", "STAGED" ] }, "portId" : { "type" : "string" }, "servicePackageType" : { "type" : "string", "enum" : [ "Usage", "PrimaryLocalFlatRate", "PrimaryLocalAndDomesticLDFlatRate", "SecondaryLocalFlatRate", "SecondaryLocalAndDomesticLDFlatRate" ] }, "id" : { "type" : "string" }, "tollFree" : { "type" : "boolean" } } }, "TelephoneNumberAccountV2X" : { "type" : "object", "properties" : { "phoneNumber" : { "type" : "string" }, "referenceType" : { "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "IVR", "LINE_APPEARANCE", "LINE_HUNTGROUP", "TELEPHONE", "VFAX", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "AUTO_ATTENDANT", "SPECIALTY_LINE", "CONTACT_CENTER" ] }, "referenceId" : { "type" : "string" }, "functionType" : { "type" : "string", "enum" : [ "ELS", "TollFree", "TemporaryNumber", "SPTN" ] }, "canAcceptSMS" : { "type" : "boolean" }, "operationalStatus" : { "type" : "string", "enum" : [ "ACTIVE", "STAGED" ] }, "portId" : { "type" : "string" }, "servicePackageType" : { "type" : "string", "enum" : [ "Usage", "PrimaryLocalFlatRate", "PrimaryLocalAndDomesticLDFlatRate", "SecondaryLocalFlatRate", "SecondaryLocalAndDomesticLDFlatRate" ] }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "customerServiceRecord" : { "originalRef" : "CustomerServiceRecordX", "$ref" : "#/definitions/CustomerServiceRecordX" }, "carrierStatus" : { "type" : "string", "enum" : [ "ACTIVE", "ACTIVATION_ON_HOLD", "ACTIVATION_PENDING", "PORT_PENDING", "CANCEL_PORT", "CANCEL_PORT_EXPIDITED", "DELETE_PENDING", "DELETED", "CANCEL_PORT_COMPLETE", "PORT_REJECTED", "INVENTORY", "INVENTORY_CLAIMED", "COOLDOWN", "RECOVERED" ] }, "orderVersion" : { "type" : "string" }, "e911Address" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "temporaryNumber" : { "type" : "string" }, "directoryListing" : { "originalRef" : "DirectoryListingX", "$ref" : "#/definitions/DirectoryListingX" }, "assignAsCallerId" : { "type" : "boolean" }, "byotnCarrierId" : { "type" : "string" }, "ringType" : { "type" : "string", "description" : "Default ringtype for this phone", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "carrierId" : { "type" : "string" }, "id" : { "type" : "string" }, "tollFree" : { "type" : "boolean" } } }, "TnData" : { "type" : "object", "properties" : { "tn" : { "type" : "string" }, "rateCenter" : { "type" : "string" }, "wireless" : { "type" : "boolean" } } }, "UserGroupX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "WeeklyScheduleX" : { "type" : "object", "properties" : { "startTime" : { "type" : "string" }, "endTime" : { "type" : "string" } } }, "AccountActivationV2X" : { "type" : "object", "properties" : { "device" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "user" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "telephoneNumberAccount" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "dynamicTelephoneNumberActivation" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "port" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "holdActivation" : { "type" : "boolean" }, "account" : { "originalRef" : "Account", "$ref" : "#/definitions/Account" } } }, "AccountViewX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "id" : { "type" : "string" }, "accountNumber" : { "type" : "string" }, "accountName" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "SIMPLE", "ADVANCED" ] }, "accountStatus" : { "type" : "string", "enum" : [ "ACTIVE", "DISABLED", "DELETED", "DELETE_PENDING", "SUSPENDED", "PENDING" ] }, "platformType" : { "type" : "string", "enum" : [ "V2_0", "V2_1", "CPE1", "CPE2" ] }, "platformChangeDate" : { "type" : "integer", "format" : "int64" }, "matches" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "AccountHistorySearchResponseX" : { "type" : "object", "properties" : { "totalRecords" : { "type" : "integer", "format" : "int64" }, "accountCreatedDate" : { "type" : "string", "format" : "date-time" }, "accountLastUpdatedDate" : { "type" : "string", "format" : "date-time" }, "results" : { "type" : "array", "items" : { "originalRef" : "AccountHistoryX", "$ref" : "#/definitions/AccountHistoryX" } } } }, "AccountHistoryX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "accountId" : { "type" : "string" }, "accountNumber" : { "type" : "string" }, "oldValue" : { "type" : "string" }, "newValue" : { "type" : "string" }, "userName" : { "type" : "string" }, "userId" : { "type" : "string" }, "userType" : { "type" : "string", "enum" : [ "AccountUser", "EndUser", "ManagementUser", "AlianzaUser", "BusinessLines" ] }, "partitionName" : { "type" : "string" }, "accountHistoryType" : { "type" : "string", "enum" : [ "PHONE_NUMBER", "PROVISIONING", "CALL_FORWARDING", "CALL_SCREENING", "ADDRESS", "ADDRESS_CSR", "ADDRESS_E911", "ADDRESS_DIRECTORY_LISTING", "ACCOUNT_STATUS", "VOICEMAIL", "CALLING_PLAN", "INBOUND_CALLING_PLAN", "IVR", "SIP_TRUNK", "SIP_TRUNK_FORWARD", "SIP_TRUNK_GROUP", "DEVICE", "DEVICE_METADATA", "USER", "USER_API_AUTH", "LINE_HUNTGROUP", "ACCOUNT", "LINE_APPEARANCE", "LINE_HARDWARE", "VFAX", "PAGING_GROUP", "PICKUP_GROUP", "GROUP_OF_REFERENCES", "CALL_PARKING_SPOT", "ACCOUNT_USER", "SIP_CREDENTIALS", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "USER_DEVICE_LINE", "EMERGENCY_NOTIFICATION", "DYNAMIC_RESERVATION", "SPECIALTY_LINE", "AUTHORITY", "AUTO_ATTENDANT", "CONTACT", "CONTACT_CENTER", "CALL_RECORDING", "ACCOUNT_CODE", "SHORT_CODE", "MEDIA_MANAGEMENT", "SOUNDS", "USER_GROUP" ] }, "loggedDate" : { "type" : "string", "format" : "date-time" }, "referenceType" : { "type" : "string", "enum" : [ "Account", "LineAppearance", "LineHuntGroup", "SipTrunk", "SipTrunkForward", "Device", "Telephone", "IVR", "EndUser", "VFax", "VoicemailBox", "PagingGroup", "GroupOfReferences", "PickupGroup", "CallParkingSpot", "AccountUser", "SIP_CREDENTIALS", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "USER_DEVICE_LINE", "SIP_TRUNK", "SIP_TRUNK_GROUP", "EMERGENCY_NOTIFICATION_COMPLIANCE", "DYNAMIC_RESERVATION", "SPECIALTY_LINE", "AUTHORITY_ROLE", "AUTO_ATTENDANT", "END_USER_CONTACT", "CUSTOM_CONTACT", "CONTACT_CENTER", "CALL_RECORDING", "ACCOUNT_CODE", "SHORT_CODE", "MEDIA_MANAGEMENT", "SOUNDS", "USER_GROUP", "USER_API_AUTH" ] }, "referenceId" : { "type" : "string" }, "referenceName" : { "type" : "string" }, "action" : { "type" : "string", "enum" : [ "CREATE", "UPDATE", "PROVISION_REQUEST", "DELETE" ] } } }, "PortAvailabilityResponseV2X" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "businessPartnerTicketID" : { "type" : "string" }, "carrierTicketId" : { "type" : "string" }, "requestedActivation" : { "originalRef" : "TelephoneNumberActivationsV2X", "$ref" : "#/definitions/TelephoneNumberActivationsV2X" }, "serviceAvailable" : { "type" : "boolean" }, "carrierType" : { "type" : "string", "enum" : [ "LEVEL_3", "NO_API", "E911", "TELUS", "TELUS_API", "TELUS_ONEVOICE", "PROVTEL", "VERIZON_CARIANZA", "ONVOY_CARIANZA", "LEVEL3_CARIANZA", "BANDWIDTH", "LUMEN_IMS", "LUMEN_VOICE_LI_ELS", "SINCH", "SERVICE_PROVIDER_CARRIER" ] }, "earliestCRD" : { "type" : "string", "format" : "date" }, "latestCRD" : { "type" : "string", "format" : "date" }, "availabilityList" : { "type" : "array", "items" : { "type" : "string", "format" : "date" } }, "resultCSRs" : { "type" : "array", "items" : { "originalRef" : "CustomerServiceRecordX", "$ref" : "#/definitions/CustomerServiceRecordX" } }, "exception" : { "type" : "string" }, "thirdPartyResultCode" : { "type" : "string" }, "thirdPartyResultContext" : { "type" : "string" }, "thirdPartyResultMessage" : { "type" : "string" }, "directoryListingAllowed" : { "type" : "boolean" }, "wirelessPort" : { "type" : "boolean" }, "lnp" : { "type" : "boolean" } } }, "TelephoneNumberActivationsV2X" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "port" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "l3Settings" : { "originalRef" : "L3SettingsX", "$ref" : "#/definitions/L3SettingsX" }, "customerServiceRecord" : { "originalRef" : "CustomerServiceRecordX", "$ref" : "#/definitions/CustomerServiceRecordX" }, "directoryListing" : { "originalRef" : "DirectoryListingX", "$ref" : "#/definitions/DirectoryListingX" }, "e911Address" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "holdActivation" : { "type" : "boolean", "description" : "Use this when activating phone numbers to prevent carrier activation until a later date" }, "telephoneNumbers" : { "type" : "array", "xml" : { "wrapped" : true }, "items" : { "xml" : { "name" : "telephoneNumber" }, "originalRef" : "TelephoneNumberAccountBareX", "$ref" : "#/definitions/TelephoneNumberAccountBareX" } }, "byotnCarrierId" : { "type" : "string" }, "id" : { "type" : "string" } } }, "E911PrevalidateResponseX" : { "type" : "object", "properties" : { "valid" : { "type" : "string", "enum" : [ "VALID", "INVALID", "UNKNOWN" ] }, "errors" : { "type" : "array", "items" : { "type" : "string" } }, "addressAlternatives" : { "type" : "array", "items" : { "originalRef" : "AddressX", "$ref" : "#/definitions/AddressX" } }, "address" : { "originalRef" : "AddressX", "$ref" : "#/definitions/AddressX" } } }, "ModifyCallingPlanX" : { "type" : "object", "properties" : { "referenceType" : { "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "IVR", "ACCOUNT", "SPECIALTY_LINE", "CONTACT_CENTER" ] }, "referenceId" : { "type" : "string" }, "callingPlanProductId" : { "type" : "string", "description" : "Deprecated. Use the callingPlanReferenceId" }, "callingPlanReferenceId" : { "type" : "string", "description" : "When modifying an existing calling plan list, this is the calling plan product id. When opting to share an existing calling plan list, this is the the reference id that has the calling plan list that the new reference would share." }, "callingPlanType" : { "type" : "string", "description" : "Indicates if the request is for a change to an existing calling plan list, share a calling plan list with another reference, or stop sharing the configured list with other references.", "enum" : [ "SHARED_CALLING_PLAN", "NEW_CALLING_PLAN", "UNSHARED_CALLING_PLAN" ] }, "pending" : { "type" : "boolean", "description" : "If false then the calling plan change will apply immediately. If true then the change will take place at the account billing date. Does not apply when the request is to share a calling plan." }, "minutesUsed" : { "type" : "integer", "format" : "int32", "description" : "Only used on add. Will only be applied to new plans. Will not be applied to pending plans plans. Does not apply when the request is to share a calling plan." } } }, "CallingPlanSwapX" : { "type" : "object", "properties" : { "swapCallingPlanProductId" : { "type" : "string" }, "newMinutesUsed" : { "type" : "integer", "format" : "int32" } } }, "AccountDeviceDataX" : { "type" : "object", "properties" : { "referenceType" : { "type" : "string", "enum" : [ "LINE_HARDWARE", "USER" ] }, "macAddress" : { "type" : "string" }, "deviceType" : { "originalRef" : "DeviceTypeX", "$ref" : "#/definitions/DeviceTypeX" }, "sideCarType" : { "originalRef" : "SideCarTypeX", "$ref" : "#/definitions/SideCarTypeX" }, "numSideCars" : { "type" : "integer", "format" : "int32" }, "devices" : { "type" : "array", "items" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" } } } }, "DeviceTypeX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "numLines" : { "type" : "integer", "format" : "int32" }, "deviceTypeManufacturer" : { "type" : "string", "enum" : [ "CISCO_LINKSYS_SIPURA", "POLYCOM", "ARRIS", "OBIHAI", "INNOMEDIA", "THIRD_PARTY", "SOFT_PHONE", "ZTE", "SCIENTIFIC_ATLANTA", "CALIX", "YEALINK", "SNOM", "SMART_RG", "ACROBITS", "GRANDSTREAM", "ADTRAN", "MEDIATRIX", "ALGO", "MITEL", "CLEARLY_IP" ] }, "acceptsRemoteResync" : { "type" : "boolean" }, "faxSupported" : { "type" : "boolean" }, "macAddressRequired" : { "type" : "boolean" }, "showProvisionStatus" : { "type" : "boolean" }, "enforceUniqueAdminPassword" : { "type" : "boolean" }, "customEncryptionKeys" : { "type" : "boolean" }, "sipPagingEnabled" : { "type" : "boolean" }, "distinctiveRingInfo" : { "type" : "string" }, "smbDevice" : { "type" : "boolean" }, "sideCarTypeIds" : { "type" : "array", "items" : { "type" : "string" } }, "maxSideCars" : { "type" : "integer", "format" : "int32" }, "ringTypeAlertInfo" : { "type" : "array", "items" : { "originalRef" : "RingTypeAlertInfoX", "$ref" : "#/definitions/RingTypeAlertInfoX" } } } }, "RingTypeAlertInfoX" : { "type" : "object", "required" : [ "alertInfoHeaderValue", "ringType" ], "properties" : { "ringType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "alertInfoHeaderValue" : { "type" : "string", "description" : "sip header for this ring type" } } }, "SideCarTypeX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "numLinesPerPage" : { "type" : "integer", "format" : "int32" }, "numPages" : { "type" : "integer", "format" : "int32" } } }, "UserProductPlanX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "displayName" : { "type" : "string" }, "description" : { "type" : "string" }, "emailAddressRequired" : { "type" : "boolean" } } }, "CallParkingSpotX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "name" : { "type" : "string" }, "spotNumber" : { "type" : "string" } } }, "CallDetailRecord" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "partitionId" : { "type" : "string" }, "startTime" : { "type" : "integer", "format" : "int64" }, "connectTime" : { "type" : "integer", "format" : "int64" }, "endTime" : { "type" : "integer", "format" : "int64" }, "createdDate" : { "type" : "integer", "format" : "int64" }, "actualCallLengthSeconds" : { "type" : "integer", "format" : "int64" }, "billCallLengthSeconds" : { "type" : "integer", "format" : "int64" }, "ratePerMinute" : { "type" : "number", "format" : "double" }, "cost" : { "type" : "number" }, "inPlan" : { "type" : "boolean" }, "dialedNumber" : { "type" : "string" }, "origNumber" : { "type" : "string" }, "origLocation" : { "type" : "string" }, "origCityName" : { "type" : "string" }, "origAbbrRCName" : { "type" : "string" }, "origState" : { "type" : "string" }, "origCountry" : { "type" : "string" }, "origCarrier" : { "type" : "string" }, "origCallCategory" : { "type" : "string", "enum" : [ "OffNet", "OnNet", "DirectoryAssistance", "Emergency", "Operator", "PhoneSupport", "TeleRelayService", "NonEmergencyServices", "Other", "PublicServices", "NotResolved", "EmergencyServicesVerification", "DomesticViolenceHotline" ] }, "identityAttestLevel" : { "type" : "string" }, "identityOriginationId" : { "type" : "string" }, "identitySignOrganization" : { "type" : "string" }, "identitySignSPCode" : { "type" : "string" }, "verstat" : { "type" : "string", "enum" : [ "TN_VALIDATION_PASSED", "TN_VALIDATION_FAILED", "NO_TN_VALIDATION" ] }, "verstatReason" : { "type" : "string", "enum" : [ "BAD_IDENTITY_INFO", "CLAIM_TO_SIP_MISMATCH", "IDENTITY_HEADER_REQUIRED", "INVALID_IDENTITY_HEADER", "MALFORMED_IDENTITY_HEADER", "STALE_DATE", "UNSUPPORTED_CREDENTIAL", "UNSUPPORTED_PASSPORT_FORMAT" ] }, "correlationData" : { "type" : "object", "additionalProperties" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } }, "accountCode" : { "type" : "string" }, "termNumber" : { "type" : "string" }, "termLocation" : { "type" : "string" }, "termCityName" : { "type" : "string" }, "termAbbrRCName" : { "type" : "string" }, "termState" : { "type" : "string" }, "termCountry" : { "type" : "string" }, "termCarrier" : { "type" : "string" }, "termCallCategory" : { "type" : "string", "enum" : [ "OffNet", "OnNet", "DirectoryAssistance", "Emergency", "Operator", "PhoneSupport", "TeleRelayService", "NonEmergencyServices", "Other", "PublicServices", "NotResolved", "EmergencyServicesVerification", "DomesticViolenceHotline" ] }, "forwardingNumber" : { "type" : "string" }, "forwardingNumberCityName" : { "type" : "string" }, "forwardingNumberAbbrRCName" : { "type" : "string" }, "forwardingNumberLocation" : { "type" : "string" }, "forwardingNumberState" : { "type" : "string" }, "forwardingNumberCountry" : { "type" : "string" }, "mediaServerType" : { "type" : "string" }, "legType" : { "type" : "string", "enum" : [ "Origination", "Termination", "Forward" ] }, "callType" : { "type" : "string", "enum" : [ "INBOUND", "OUTBOUND" ] }, "callFlagType" : { "type" : "string", "enum" : [ "MISSED", "VOICEMAIL", "FORWARDED", "BUSY", "ANSWERED", "OTHER", "PICKUP", "PICKED_UP" ] }, "disconnectType" : { "type" : "string", "enum" : [ "Busy", "NoAnswer", "HangUp", "HangUpOther", "BlindTransfer", "SupervisedTransfer", "Error", "Cancelled", "NextMenu", "NetworkBusy", "Unauthorized", "PickedUp", "NoURL", "BadURL", "URLExpired", "NoCallWaiting", "ImportantCall", "RefreshTimeout", "LocationCapacity", "Capacity", "SystemHangUp", "Rejected", "NotFound", "Other", "Forward", "Screened", "Unregistered", "DoNotOriginate" ] }, "metroServiceArea" : { "type" : "string" }, "rateType" : { "type" : "string", "enum" : [ "Local", "OnPlanMinutes", "OnPlanRated", "OffPlanRated", "Free", "TollFree", "_411", "Operator", "IntraPartitionFree", "SipTrunkInbound" ] }, "rateLocalFromNumber" : { "type" : "string" }, "serviceType" : { "type" : "string", "enum" : [ "INTERSTATE", "INTRASTATE", "INTERNATIONAL", "TOLL_FREE", "NOT_APPLICABLE", "UNKNOWN" ] }, "local" : { "type" : "boolean" }, "sessionId" : { "type" : "string" }, "accountBillableNumber" : { "type" : "string" }, "accountBillableCityName" : { "type" : "string" }, "accountBillableAbbrRCName" : { "type" : "string" }, "accountBillableLocation" : { "type" : "string" }, "accountBillableState" : { "type" : "string" }, "accountBillableCountry" : { "type" : "string" }, "referenceId" : { "type" : "string" }, "referenceType" : { "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "ACCOUNT", "SPECIALTY_LINE" ] }, "referenceName" : { "type" : "string" }, "acctId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "callingPlanProductId" : { "type" : "string" }, "callingPlanProductName" : { "type" : "string" }, "accountNumber" : { "type" : "string" }, "accountCustomField" : { "type" : "string" }, "partitionBillingCode" : { "type" : "string" }, "accountBillingCycleDay" : { "type" : "integer", "format" : "int32" }, "accountTimeZone" : { "type" : "string" }, "sipCallIds" : { "type" : "array", "items" : { "type" : "string" } }, "meanOpinionScoreAverage" : { "type" : "number", "format" : "double" }, "meanOpinionScores" : { "type" : "object", "additionalProperties" : { "type" : "number", "format" : "double" } }, "callPickupFromId" : { "type" : "string" }, "callPickupById" : { "type" : "string" }, "applicationData" : { "originalRef" : "CdrApplicationData", "$ref" : "#/definitions/CdrApplicationData" }, "origCnam" : { "type" : "string" }, "termCnam" : { "type" : "string" }, "forwardingCnam" : { "type" : "string" }, "origNumberTags" : { "type" : "array", "items" : { "type" : "string" } }, "termNumberTags" : { "type" : "array", "items" : { "type" : "string" } }, "remoteChargeInfo" : { "type" : "string" } } }, "CallDetailRecordSearchResponse" : { "type" : "object", "properties" : { "totalRecords" : { "type" : "integer", "format" : "int64" }, "results" : { "type" : "array", "items" : { "originalRef" : "CallDetailRecord", "$ref" : "#/definitions/CallDetailRecord" } } } }, "CdrApplicationData" : { "type" : "object", "discriminator" : "type" }, "CdrAudioInfo" : { "allOf" : [ { "originalRef" : "CdrMediaInfo", "$ref" : "#/definitions/CdrMediaInfo" }, { "type" : "object", "properties" : { "codec" : { "type" : "string" }, "bitRate" : { "type" : "integer", "format" : "int32" } } } ] }, "CdrMediaInfo" : { "type" : "object", "discriminator" : "type" }, "CdrT38Info" : { "allOf" : [ { "originalRef" : "CdrMediaInfo", "$ref" : "#/definitions/CdrMediaInfo" }, { "type" : "object", "properties" : { "errorCorrectionEnabled" : { "type" : "boolean" } } } ] }, "SipTrunkApplicationDataOLD" : { "type" : "object", "properties" : { "sipTrunkId" : { "type" : "string" }, "burstCallsCount" : { "type" : "integer", "format" : "int32" }, "concurrentCallsCount" : { "type" : "integer", "format" : "int32" }, "burst" : { "type" : "boolean" } } }, "SipTrunkCdrApplicationData" : { "allOf" : [ { "originalRef" : "CdrApplicationData", "$ref" : "#/definitions/CdrApplicationData" }, { "type" : "object", "properties" : { "sipTrunkId" : { "type" : "string" }, "burstCallsCount" : { "type" : "integer", "format" : "int32" }, "concurrentCallsCount" : { "type" : "integer", "format" : "int32" }, "burst" : { "type" : "boolean" } } } ] }, "SipTrunkCdrApplicationDataOLD" : { "allOf" : [ { "originalRef" : "CdrApplicationData", "$ref" : "#/definitions/CdrApplicationData" }, { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "originalRef" : "SipTrunkApplicationDataOLD", "$ref" : "#/definitions/SipTrunkApplicationDataOLD" } } } } ] }, "VirtualFaxFailureCdrApplicationData" : { "allOf" : [ { "originalRef" : "CdrApplicationData", "$ref" : "#/definitions/CdrApplicationData" }, { "type" : "object", "properties" : { "resolution" : { "type" : "string" }, "fileSize" : { "type" : "integer", "format" : "int64" }, "badRows" : { "type" : "integer", "format" : "int32" }, "mediaInfo" : { "originalRef" : "CdrMediaInfo", "$ref" : "#/definitions/CdrMediaInfo" }, "totalPageCount" : { "type" : "integer", "format" : "int32" } } } ] }, "VirtualFaxSetupFailureCdrApplicationData" : { "allOf" : [ { "originalRef" : "CdrApplicationData", "$ref" : "#/definitions/CdrApplicationData" }, { "type" : "object" } ] }, "VirtualFaxSuccessCdrApplicationData" : { "allOf" : [ { "originalRef" : "CdrApplicationData", "$ref" : "#/definitions/CdrApplicationData" }, { "type" : "object", "properties" : { "resolution" : { "type" : "string" }, "fileSize" : { "type" : "integer", "format" : "int64" }, "badRows" : { "type" : "integer", "format" : "int32" }, "mediaInfo" : { "originalRef" : "CdrMediaInfo", "$ref" : "#/definitions/CdrMediaInfo" }, "totalPageCount" : { "type" : "integer", "format" : "int32" } } } ] }, "CymbusAccountGroup" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "accountName" : { "type" : "string" }, "groupName" : { "type" : "string" }, "partitionId" : { "type" : "string" } } }, "SipCredentialData" : { "type" : "object", "properties" : { "sipUsernameLine1" : { "type" : "string" }, "sipUsernameLine2" : { "type" : "string" }, "sipPassword" : { "type" : "string" } } }, "DeviceStatusX" : { "type" : "object", "properties" : { "success" : { "type" : "boolean" }, "failureMessage" : { "type" : "string" }, "macAddress" : { "type" : "string" }, "request" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "response" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "updated" : { "type" : "string", "format" : "date-time" } } }, "ProvisioningRequestX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "requestDate" : { "type" : "string", "format" : "date-time" }, "httpStatus" : { "type" : "integer", "format" : "int32" }, "deviceId" : { "type" : "string" }, "ipAddress" : { "type" : "string" }, "userAgent" : { "type" : "string" } } }, "RegistrationStatusX" : { "type" : "object", "properties" : { "registered" : { "type" : "boolean" } } }, "DeviceSwapX" : { "type" : "object", "properties" : { "macAddress" : { "type" : "string" }, "deviceTypeId" : { "type" : "string" }, "deviceName" : { "type" : "string" } } }, "DeviceMetadataX" : { "type" : "object", "properties" : { "macAddress" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "deviceTypeId" : { "type" : "string" }, "sideCarTypeId" : { "type" : "string" }, "numSideCars" : { "type" : "integer", "format" : "int32" }, "adminPassword" : { "type" : "string" }, "provisionerType" : { "type" : "string", "enum" : [ "ALIANZA", "PHONISM" ] }, "id" : { "type" : "string" } } }, "DynamicInventoryOrderTelephoneNumberX" : { "type" : "object", "properties" : { "tn" : { "type" : "string" }, "id" : { "type" : "string" } } }, "DynamicInventoryX" : { "type" : "object", "properties" : { "carrierId" : { "type" : "string" }, "orderId" : { "type" : "string" }, "tns" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "DynamicInventoryOrderTelephoneNumberX", "$ref" : "#/definitions/DynamicInventoryOrderTelephoneNumberX" } }, "id" : { "type" : "string" } } }, "DynamicInventoryOrderX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "customerServiceRecord" : { "originalRef" : "LatLongCustomerServiceRecordX", "$ref" : "#/definitions/LatLongCustomerServiceRecordX" }, "directoryListing" : { "originalRef" : "DirectoryListingX", "$ref" : "#/definitions/DirectoryListingX" }, "e911Address" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "inventory" : { "type" : "array", "uniqueItems" : true, "items" : { "originalRef" : "DynamicInventoryX", "$ref" : "#/definitions/DynamicInventoryX" } }, "id" : { "type" : "string" } } }, "DIRECTORY" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "introPrompt" : { "type" : "string" }, "invalidSelectionPrompt" : { "type" : "string" }, "directoryDialType" : { "type" : "string", "enum" : [ "NAME", "EXTENSION" ] } } } ] }, "DTMF" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "digit" : { "type" : "string" } } } ] }, "FORWARD" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "toNumber" : { "type" : "string" } } } ] }, "GROUP" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "routedToList" : { "type" : "array", "items" : { "originalRef" : "RoutedTo", "$ref" : "#/definitions/RoutedTo" } }, "ringType" : { "type" : "string", "enum" : [ "SIMULTANEOUS", "SEQUENTIAL", "SINGLE_DEVICE_FROM_GROUP" ] }, "groupType" : { "type" : "string", "enum" : [ "USER", "DEVICE" ] }, "timeoutSeconds" : { "type" : "integer", "format" : "int32" }, "timeoutComponentId" : { "type" : "string" } } } ] }, "HANGUP" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "goodBye" : { "type" : "string" } } } ] }, "INCOMING" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { } } ] }, "IVRComponentMappingX" : { "type" : "object", "properties" : { "fromIvrComponentId" : { "type" : "string" }, "toIvrComponentId" : { "type" : "string" } } }, "IVRComponentX" : { "type" : "object", "discriminator" : "type", "properties" : { "id" : { "type" : "string" }, "left" : { "type" : "string" }, "top" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "HANGUP", "MENU", "DIRECTORY", "GROUP", "INCOMING", "SCHEDULE", "DTMF", "MENU_FAILURE", "SCHEDULE_RULE_COMPONENT", "USER", "LINE_HUNTGROUP", "FORWARD" ] } } }, "IVRX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "name" : { "type" : "string" }, "top" : { "type" : "string" }, "left" : { "type" : "string" }, "fixedPosition" : { "type" : "boolean" }, "ivrComponents" : { "type" : "array", "items" : { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" } }, "ivrComponentMappings" : { "type" : "array", "items" : { "originalRef" : "IVRComponentMappingX", "$ref" : "#/definitions/IVRComponentMappingX" } } } }, "MENU" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "initPromptId" : { "type" : "string" }, "allowBargeInDuringInitPrompt" : { "type" : "boolean" }, "menuPromptId" : { "type" : "string" }, "menuRepeatDelay" : { "type" : "integer", "format" : "int32" }, "dtmf" : { "type" : "array", "items" : { "originalRef" : "DTMF", "$ref" : "#/definitions/DTMF" } }, "failure" : { "originalRef" : "MenuFailureX", "$ref" : "#/definitions/MenuFailureX" } } } ] }, "MenuFailureX" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "menuTimeout" : { "type" : "integer", "format" : "int32" }, "invalidSelectionPrompt" : { "type" : "string" }, "maxInvalidSelections" : { "type" : "integer", "format" : "int32" } } } ] }, "RoutedTo" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "timeoutSeconds" : { "type" : "integer", "format" : "int32" } } }, "SCHEDULE" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "scheduleComponent" : { "type" : "array", "items" : { "originalRef" : "SCHEDULE_RULE_COMPONENT", "$ref" : "#/definitions/SCHEDULE_RULE_COMPONENT" } } } } ] }, "SCHEDULE_RULE_COMPONENT" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "weekly" : { "type" : "object", "additionalProperties" : { "originalRef" : "WeeklyScheduleX", "$ref" : "#/definitions/WeeklyScheduleX" } }, "custom" : { "originalRef" : "CustomScheduleX", "$ref" : "#/definitions/CustomScheduleX" } } } ] }, "USER" : { "allOf" : [ { "originalRef" : "IVRComponentX", "$ref" : "#/definitions/IVRComponentX" }, { "type" : "object", "properties" : { "userId" : { "type" : "string" }, "sendDirectlyToVoicemail" : { "type" : "boolean" } } } ] }, "MediaX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "url" : { "type" : "string" } } }, "HoldMusicX" : { "type" : "object", "properties" : { "storageId" : { "type" : "string" }, "url" : { "type" : "string" } } }, "LOAX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } }, "extension" : { "type" : "string" }, "date" : { "type" : "integer", "format" : "int64" }, "contentType" : { "type" : "string" } } }, "CallingPlan" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "referenceId" : { "type" : "string" }, "referenceType" : { "type" : "string" }, "callingPlanProductId" : { "type" : "string" }, "endDate" : { "type" : "string", "format" : "date-time" }, "startDate" : { "type" : "string", "format" : "date-time" }, "planMinutes" : { "type" : "integer", "format" : "int32" }, "secondsRemaining" : { "type" : "integer", "format" : "int64" } } }, "SbcEndpoint" : { "type" : "object", "properties" : { "site" : { "type" : "string" }, "address" : { "type" : "string" }, "port" : { "type" : "integer", "format" : "int32" }, "protocol" : { "type" : "string" } } }, "SetupCallingPlan" : { "type" : "object", "properties" : { "referenceId" : { "type" : "string" }, "callingPlanType" : { "type" : "string", "enum" : [ "SHARED_CALLING_PLAN", "NEW_CALLING_PLAN", "UNSHARED_CALLING_PLAN" ] } } }, "SipTrunk" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "trunkName" : { "type" : "string" }, "id" : { "type" : "string" }, "sipPassword" : { "type" : "string" }, "sipUsername" : { "type" : "string" }, "callbackNumber" : { "type" : "string" }, "concurrentCalls" : { "type" : "integer", "format" : "int32" }, "maxBurstCalls" : { "type" : "integer", "format" : "int32" }, "callingPlans" : { "type" : "array", "items" : { "originalRef" : "CallingPlan", "$ref" : "#/definitions/CallingPlan" } }, "telephoneNumbers" : { "type" : "array", "items" : { "type" : "string" } }, "sipProxyServer" : { "type" : "string" }, "lockedOut" : { "type" : "boolean" }, "localServicesEnabled" : { "type" : "boolean" }, "primaryTn" : { "type" : "string" }, "extensionPatterns" : { "type" : "array", "items" : { "type" : "string" } }, "externalChargeNumber" : { "type" : "string" }, "newCppId" : { "type" : "string" }, "setupCallingPlan" : { "originalRef" : "SetupCallingPlan", "$ref" : "#/definitions/SetupCallingPlan" }, "provisioningStatus" : { "type" : "string" }, "ipBasedAuthEnabled" : { "type" : "boolean" }, "ipAddress" : { "type" : "string" }, "portNumber" : { "type" : "integer", "format" : "int32" }, "accessEndpoints" : { "type" : "array", "items" : { "originalRef" : "SbcEndpoint", "$ref" : "#/definitions/SbcEndpoint" } }, "sipTrunkGroupId" : { "type" : "string" }, "pbxTnDigits" : { "type" : "integer", "format" : "int32" }, "languageTag" : { "type" : "string" } } }, "ForwardAlwaysReference" : { "type" : "object", "properties" : { "referenceType" : { "type" : "string", "enum" : [ "BUSY", "END_USER", "IVR", "AUTO_ATTENDANT", "SIP_TRUNK", "TELEPHONE", "VOICE_MAIL" ] }, "referenceId" : { "type" : "string" }, "enabled" : { "type" : "boolean" } } }, "ForwardReference" : { "type" : "object", "properties" : { "referenceType" : { "type" : "string", "enum" : [ "BUSY", "END_USER", "IVR", "AUTO_ATTENDANT", "SIP_TRUNK", "TELEPHONE", "VOICE_MAIL" ] }, "referenceId" : { "type" : "string" } } }, "SipTrunkForwardRules" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "sipTrunkId" : { "type" : "string" }, "forwardAlways" : { "originalRef" : "ForwardAlwaysReference", "$ref" : "#/definitions/ForwardAlwaysReference" }, "forwardOnFailure" : { "type" : "array", "items" : { "originalRef" : "ForwardReference", "$ref" : "#/definitions/ForwardReference" } }, "forwardOnCapacityExceeded" : { "type" : "array", "items" : { "originalRef" : "ForwardReference", "$ref" : "#/definitions/ForwardReference" } } } }, "RegistrationStatus" : { "type" : "object", "properties" : { "registered" : { "type" : "boolean" }, "lockedOut" : { "type" : "boolean" } } }, "CancelActionX" : { "type" : "object", "properties" : { "referenceId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" } } }, "TelephoneNumberUsagesX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "phoneNumber" : { "type" : "string" }, "users" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "ExternalTnX" : { "type" : "object", "properties" : { "phoneNumber" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "userId" : { "type" : "string" }, "inboundCarrierId" : { "type" : "string" }, "functionType" : { "type" : "string" }, "cnam" : { "type" : "string" }, "customerServiceRecord" : { "originalRef" : "CustomerServiceRecordX", "$ref" : "#/definitions/CustomerServiceRecordX" }, "e911Address" : { "originalRef" : "E911AddressX", "$ref" : "#/definitions/E911AddressX" }, "callable" : { "type" : "boolean" }, "id" : { "type" : "string" } } }, "TelephoneNumberDestinationX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "telephoneNumber" : { "type" : "string" }, "referenceId" : { "type" : "string" }, "referenceType" : { "type" : "string", "enum" : [ "SIP_TRUNK", "END_USER", "IVR", "LINE_APPEARANCE", "LINE_HUNTGROUP", "TELEPHONE", "VFAX", "BUSINESS_LINE", "BUSINESS_LINE_HUNT_GROUP", "CALL_GROUP", "CALL_QUEUE", "AUTO_ATTENDANT", "SPECIALTY_LINE", "CONTACT_CENTER" ] }, "ringType" : { "type" : "string", "enum" : [ "StandardRing", "Ring1", "Ring2", "Ring3", "Ring4", "Ring5", "Ring6", "Ring7" ] }, "assignAsCallerId" : { "type" : "boolean" }, "id" : { "type" : "string" } } }, "BusinessLine" : { "type" : "object", "required" : [ "accountId", "name", "partitionId" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "callerIdPhoneNumber" : { "type" : "string", "pattern" : "\\d+" }, "callerIdVisible" : { "type" : "boolean" }, "emergencyCallbackPhoneNumber" : { "type" : "string", "pattern" : "\\d+" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" } } }, "BusinessLineExpandedView" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "callerIdPhoneNumber" : { "type" : "string" }, "callerIdVisible" : { "type" : "boolean" }, "emergencyCallbackPhoneNumber" : { "type" : "string" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "callHandling" : { "originalRef" : "CallHandlingView", "$ref" : "#/definitions/CallHandlingView" }, "sipCredentials" : { "originalRef" : "SipCredentialsView", "$ref" : "#/definitions/SipCredentialsView" }, "device" : { "originalRef" : "PortAssignmentView", "$ref" : "#/definitions/PortAssignmentView" } } }, "BusyRingFailoverAction" : { "allOf" : [ { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, { "type" : "object" } ] }, "CallHandlingView" : { "type" : "object", "properties" : { "activeCallHandling" : { "type" : "string", "enum" : [ "RING_LINE", "FORWARD" ] }, "callWaitingEnabled" : { "type" : "boolean" }, "busyFailoverAction" : { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, "unregisteredFailoverAction" : { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, "ringTimeoutConfiguration" : { "originalRef" : "RingTimeoutConfiguration", "$ref" : "#/definitions/RingTimeoutConfiguration" }, "forwardToPhoneNumber" : { "type" : "string" }, "voicemailBoxId" : { "type" : "string" } } }, "ForwardRingFailoverAction" : { "allOf" : [ { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, { "type" : "object", "required" : [ "forwardToPhoneNumber" ], "properties" : { "forwardToPhoneNumber" : { "type" : "string", "pattern" : "\\d+" } } } ] }, "LimitedRingTimeoutConfiguration" : { "allOf" : [ { "originalRef" : "RingTimeoutConfiguration", "$ref" : "#/definitions/RingTimeoutConfiguration" }, { "type" : "object", "required" : [ "noAnswerAction" ], "properties" : { "timeoutSeconds" : { "type" : "integer", "format" : "int32" }, "noAnswerAction" : { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" } } } ] }, "PortAssignmentView" : { "type" : "object", "properties" : { "deviceTypeId" : { "type" : "string" }, "macAddress" : { "type" : "string" }, "portNumber" : { "type" : "integer", "format" : "int32" }, "faxEnabled" : { "type" : "boolean" } } }, "RingFailoverAction" : { "type" : "object", "required" : [ "@type" ], "discriminator" : "@type", "properties" : { "@type" : { "type" : "string", "enum" : [ "VoicemailRingFailoverAction", "BusyRingFailoverAction", "ForwardRingFailoverAction" ] } } }, "RingTimeoutConfiguration" : { "type" : "object", "required" : [ "@type" ], "discriminator" : "@type", "properties" : { "@type" : { "type" : "string", "enum" : [ "LimitedRingTimeoutConfiguration", "UnlimitedRingTimeoutConfiguration" ] } } }, "SipCredentialsView" : { "type" : "object", "properties" : { "sipUsername" : { "type" : "string" } } }, "UnlimitedRingTimeoutConfiguration" : { "allOf" : [ { "originalRef" : "RingTimeoutConfiguration", "$ref" : "#/definitions/RingTimeoutConfiguration" }, { "type" : "object" } ] }, "VoicemailRingFailoverAction" : { "allOf" : [ { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, { "type" : "object" } ] }, "CallHandling" : { "type" : "object", "required" : [ "activeCallHandling", "busyFailoverAction", "ringTimeoutConfiguration", "unregisteredFailoverAction" ], "properties" : { "activeCallHandling" : { "type" : "string", "enum" : [ "RING_LINE", "FORWARD" ] }, "callWaitingEnabled" : { "type" : "boolean" }, "busyFailoverAction" : { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, "unregisteredFailoverAction" : { "originalRef" : "RingFailoverAction", "$ref" : "#/definitions/RingFailoverAction" }, "ringTimeoutConfiguration" : { "originalRef" : "RingTimeoutConfiguration", "$ref" : "#/definitions/RingTimeoutConfiguration" }, "forwardToPhoneNumber" : { "type" : "string", "pattern" : "\\d+" }, "voicemailBoxId" : { "type" : "string" } } }, "PortAssignment" : { "type" : "object", "required" : [ "deviceTypeId" ], "properties" : { "businessLineId" : { "type" : "string", "format" : "uuid" }, "macAddress" : { "type" : "string" }, "portNumber" : { "type" : "integer", "format" : "int32", "minimum" : 1, "maximum" : 100 }, "deviceTypeId" : { "type" : "string" }, "faxEnabled" : { "type" : "boolean" } } }, "DeviceSwap" : { "type" : "object", "required" : [ "deviceTypeId", "macAddress" ], "properties" : { "macAddress" : { "type" : "string" }, "deviceTypeId" : { "type" : "string" } } }, "SipCredentials" : { "type" : "object", "required" : [ "sipPassword", "sipUsername" ], "properties" : { "sipUsername" : { "type" : "string" }, "sipPassword" : { "type" : "string" } } }, "VoicemailBox" : { "type" : "object", "required" : [ "accountId", "name", "partitionId" ], "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "forwardMessageToEmailAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "forwardMessageToEmailEnabled" : { "type" : "boolean" }, "shouldKeepMessageAfterForward" : { "type" : "boolean" }, "locale" : { "type" : "string", "pattern" : "en-US|fr-CA|es-MX" } } }, "VoicemailBoxAssignment" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "display" : { "type" : "string" } } }, "VoicemailBoxExpandedView" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "forwardMessageToEmailAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "forwardMessageToEmailEnabled" : { "type" : "boolean" }, "shouldKeepMessageAfterForward" : { "type" : "boolean" }, "locale" : { "type" : "string" }, "assignedTo" : { "type" : "array", "items" : { "originalRef" : "VoicemailBoxAssignment", "$ref" : "#/definitions/VoicemailBoxAssignment" } } } }, "PinStatusResponse" : { "type" : "object", "properties" : { "lockedOut" : { "type" : "boolean" } } }, "VoicemailMessage" : { "type" : "object", "properties" : { "storageId" : { "type" : "string", "format" : "uuid" }, "voicemailBoxId" : { "type" : "string" }, "createdDate" : { "type" : "integer", "format" : "int64" }, "fromName" : { "type" : "string" }, "fromAddress" : { "type" : "string" }, "lengthInSeconds" : { "type" : "integer", "format" : "int32" }, "read" : { "type" : "boolean" }, "toPhoneNumber" : { "type" : "string" }, "storageStatus" : { "type" : "string" }, "sizeInBytes" : { "type" : "integer", "format" : "int64" } } }, "BulkVoicemailAction" : { "type" : "object", "required" : [ "actionType" ], "properties" : { "actionType" : { "type" : "string", "enum" : [ "DELETE", "MARK_AS_READ", "MARK_AS_UNREAD" ] }, "messageIds" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" } } } }, "ReadMessage" : { "type" : "object", "properties" : { "markAsRead" : { "type" : "boolean" } } }, "HuntGroup" : { "type" : "object", "required" : [ "accountId", "huntingConfiguration", "name", "partitionId" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "huntingConfiguration" : { "originalRef" : "HuntingConfiguration", "$ref" : "#/definitions/HuntingConfiguration" }, "activeForwardConfigurationId" : { "type" : "string", "format" : "uuid" } } }, "HuntingConfiguration" : { "type" : "object", "required" : [ "@type" ], "discriminator" : "@type", "properties" : { "@type" : { "type" : "string", "enum" : [ "LinearHuntingConfiguration", "SequentialHuntingConfiguration", "SimultaneousHuntingConfiguration" ] } } }, "LinearHuntingConfiguration" : { "allOf" : [ { "originalRef" : "HuntingConfiguration", "$ref" : "#/definitions/HuntingConfiguration" }, { "type" : "object", "required" : [ "ringTimeoutSeconds" ], "properties" : { "ringTimeoutSeconds" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "members" : { "type" : "array", "items" : { "originalRef" : "LinearMember", "$ref" : "#/definitions/LinearMember" }, "maxItems" : 2147483647, "minItems" : 1 } } } ] }, "LinearMember" : { "type" : "object", "required" : [ "businessLineId", "sequenceOrder" ], "properties" : { "businessLineId" : { "type" : "string", "format" : "uuid" }, "sequenceOrder" : { "type" : "integer", "format" : "int32", "minimum" : 0 } } }, "SequentialHuntingConfiguration" : { "allOf" : [ { "originalRef" : "HuntingConfiguration", "$ref" : "#/definitions/HuntingConfiguration" }, { "type" : "object", "properties" : { "members" : { "type" : "array", "items" : { "originalRef" : "SequentialMember", "$ref" : "#/definitions/SequentialMember" }, "maxItems" : 2147483647, "minItems" : 1 } } } ] }, "SequentialMember" : { "type" : "object", "required" : [ "businessLineId", "ringTimeoutSeconds", "sequenceOrder" ], "properties" : { "businessLineId" : { "type" : "string", "format" : "uuid" }, "ringTimeoutSeconds" : { "type" : "integer", "format" : "int32", "minimum" : 0, "maximum" : 2147483647 }, "sequenceOrder" : { "type" : "integer", "format" : "int32", "minimum" : 0, "maximum" : 2147483647 } } }, "SimultaneousHuntingConfiguration" : { "allOf" : [ { "originalRef" : "HuntingConfiguration", "$ref" : "#/definitions/HuntingConfiguration" }, { "type" : "object", "required" : [ "members", "ringTimeoutSeconds" ], "properties" : { "ringTimeoutSeconds" : { "type" : "integer", "format" : "int32", "minimum" : 0 }, "members" : { "type" : "array", "items" : { "type" : "string", "format" : "uuid" }, "maxItems" : 2147483647, "minItems" : 1 } } } ] }, "BusyFailoverAction" : { "allOf" : [ { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, { "type" : "object", "properties" : { } } ] }, "FailoverAction" : { "type" : "object", "required" : [ "@type", "failoverReason" ], "discriminator" : "@type", "properties" : { "failoverReason" : { "type" : "string", "enum" : [ "BUSY", "NO_ANSWER", "UNREGISTERED" ] }, "@type" : { "type" : "string", "enum" : [ "BusyFailoverAction", "ForwardFailoverAction", "VoicemailFailoverAction" ] } } }, "ForwardFailoverAction" : { "allOf" : [ { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, { "type" : "object", "required" : [ "forwardToPhoneNumber" ], "properties" : { "forwardToPhoneNumber" : { "type" : "string", "pattern" : "\\d+" } } } ] }, "VoicemailFailoverAction" : { "allOf" : [ { "originalRef" : "FailoverAction", "$ref" : "#/definitions/FailoverAction" }, { "type" : "object", "required" : [ "voicemailBoxId" ], "properties" : { "voicemailBoxId" : { "type" : "string" } } } ] }, "PartitionStarCodes" : { "type" : "object", "properties" : { "constraintType" : { "type" : "string" }, "constraintValue" : { "type" : "array", "items" : { "type" : "string" } } } }, "ForwardConfiguration" : { "type" : "object", "required" : [ "forwardConfigurationType", "forwardToPhoneNumber", "huntGroupId", "name", "starCode" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "starCode" : { "type" : "string", "pattern" : "\\*d+" }, "huntGroupId" : { "type" : "string", "format" : "uuid" }, "forwardConfigurationType" : { "type" : "string", "enum" : [ "VARIABLE", "FIXED" ] }, "forwardToPhoneNumber" : { "type" : "string", "pattern" : "\\d+" }, "name" : { "type" : "string" } } }, "CallGroupX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "DEVICE", "USER" ] }, "subType" : { "type" : "string", "enum" : [ "ANY_USER", "PAGING_DEVICE" ] }, "memberIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "PagingGroupX" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "STANDARD", "PRIORITY", "EMERGENCY" ] }, "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "extension" : { "type" : "string" }, "groupIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "PickupGroupX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "groupIds" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "NotificationEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "callTime" : { "type" : "integer", "format" : "int64" }, "timeZoneId" : { "type" : "string" }, "groupId" : { "type" : "string" }, "groupType" : { "type" : "string", "enum" : [ "ACCOUNT" ] }, "triggerType" : { "type" : "string", "enum" : [ "EMERGENCY_CALL", "EMERGENCY_TEST_CALL", "EMERGENCY_TEXT", "EMERGENCY_TEST_TEXT", "NOTIFICATION_TEST" ] }, "triggeringPhoneNumber" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "SENT", "FAILED", "PARTIAL" ] }, "emailNotificationRecipients" : { "type" : "array", "items" : { "originalRef" : "RecipientStatus", "$ref" : "#/definitions/RecipientStatus" } }, "smsNotificationRecipients" : { "type" : "array", "items" : { "originalRef" : "RecipientStatus", "$ref" : "#/definitions/RecipientStatus" } } } }, "RecipientStatus" : { "type" : "object", "properties" : { "recipient" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "SENT", "FAILED" ] } } }, "ComplianceConfiguration" : { "type" : "object", "properties" : { "installDate" : { "type" : "string", "format" : "date-time" }, "usingAlternativeSolution" : { "type" : "boolean" }, "emailRecipients" : { "type" : "array", "items" : { "type" : "string" } }, "smsRecipients" : { "type" : "array", "items" : { "type" : "string" } }, "inCompliance" : { "type" : "boolean" } } }, "NotificationGroup" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ACCOUNT" ] }, "name" : { "type" : "string" }, "compliance" : { "originalRef" : "ComplianceConfiguration", "$ref" : "#/definitions/ComplianceConfiguration" }, "timeZoneId" : { "type" : "string" } } }, "AccountUserX" : { "type" : "object", "properties" : { "partitionId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "userId" : { "type" : "string" }, "subDomain" : { "type" : "string" }, "username" : { "type" : "string" }, "password" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "mustChangePassword" : { "type" : "boolean" }, "languageTag" : { "type" : "string" }, "id" : { "type" : "string" } } }, "EndUserActivationV2X" : { "type" : "object", "properties" : { "device" : { "originalRef" : "DeviceX", "$ref" : "#/definitions/DeviceX" }, "user" : { "originalRef" : "EndUserV2X", "$ref" : "#/definitions/EndUserV2X" }, "telephoneNumberAccount" : { "originalRef" : "TelephoneNumberAccountV2X", "$ref" : "#/definitions/TelephoneNumberAccountV2X" }, "dynamicTelephoneNumberActivation" : { "originalRef" : "DynamicTelephoneNumberActivationX", "$ref" : "#/definitions/DynamicTelephoneNumberActivationX" }, "port" : { "originalRef" : "PortX", "$ref" : "#/definitions/PortX" }, "holdActivation" : { "type" : "boolean" } } }, "VoicemailMessageX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "createdDate" : { "type" : "string", "format" : "date-time", "description" : "date the message was left" }, "fromName" : { "type" : "string", "description" : "callerId name of caller that left message, if available" }, "fromNumber" : { "type" : "string", "description" : "callerId number of caller that left message, if available" }, "lengthInPages" : { "type" : "integer", "format" : "int32", "description" : "length of message in pages, if it is a FAX" }, "lengthInSeconds" : { "type" : "integer", "format" : "int32", "description" : "length of message in pages, if it is a VOICE message" }, "read" : { "type" : "boolean", "description" : "has the message been seen / opened / read" }, "sizeInBytes" : { "type" : "integer", "format" : "int64", "description" : "size of message in bytes" }, "messageType" : { "type" : "string", "description" : "type of message", "enum" : [ "FAX", "VOICE" ] }, "voicemailBoxId" : { "type" : "string", "description" : "voicemail box id" }, "accountId" : { "type" : "string", "description" : "Account of the voicemail box" }, "partitionId" : { "type" : "string", "description" : "Partition of the account" }, "toPhoneNumber" : { "type" : "string", "description" : "The to number associated with the voicemail message" }, "transcriptionStatus" : { "type" : "string", "description" : "The status of the transcription" }, "transcriptionInfo" : { "type" : "string", "description" : "Details (quality, etc...) about the transcription" }, "transcriptionText" : { "type" : "string", "description" : "The resulting text of the transcribed message" }, "storageId" : { "type" : "string", "format" : "uuid", "description" : "The storage id of audio file" }, "audioFileAndType" : { "type" : "string", "description" : "The type of audio file" } } }, "ReassignEndUserX" : { "type" : "object", "properties" : { "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "emailAddress" : { "type" : "string" }, "username" : { "type" : "string" }, "blockEmail" : { "type" : "boolean" } } }, "VirtualFaxLineX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" }, "name" : { "type" : "string" }, "emailAddresses" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "languageTag" : { "type" : "string" } } }, "VfaxOutbound" : { "type" : "object", "properties" : { "callerId" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "accountId" : { "type" : "string" }, "partitionId" : { "type" : "string" } } }, "VoicemailBoxX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string", "description" : "name of the box" }, "partitionId" : { "type" : "string", "description" : "partitionid of the account" }, "accountId" : { "type" : "string", "description" : "accountid of the voicemail box" }, "voicemailToEmailAddresses" : { "type" : "array", "description" : "email addresses to forward all voicemail messages to", "uniqueItems" : true, "items" : { "type" : "string" } }, "voicemailToEmailEnabled" : { "type" : "boolean", "description" : "enables voicemail to email" }, "voicemailKeepAfterEmail" : { "type" : "boolean", "description" : "keep or delete the voicemail after being emailed" }, "referencedBy" : { "type" : "array", "description" : "References that point at this voicemail box", "uniqueItems" : true, "items" : { "originalRef" : "VoicemailReferencedByX", "$ref" : "#/definitions/VoicemailReferencedByX" } }, "locale" : { "type" : "string", "description" : "Locale of the voicemail box" }, "totalVoicemails" : { "type" : "integer", "format" : "int32", "description" : "Total voicemails on the box" }, "totalUnreadVoicemails" : { "type" : "integer", "format" : "int32", "description" : "Total unread voicemails on the box" }, "type" : { "type" : "string", "description" : "Type of voicemail", "enum" : [ "Normal", "Sub", "Primary", "BUSINESS_LINE" ] }, "subIds" : { "type" : "array", "description" : "List of sub voicemail ids, this will be populated only if this voicemail box is primary", "items" : { "type" : "string" } }, "parentId" : { "type" : "string", "description" : "Parent id for this voicemail box. Applicable if this voicemail box is a sub" }, "dtmfOption" : { "type" : "string", "description" : "DTMF option for this voicemail box. If this voicemail box is a sub, options are 2 through 8 otherwise option must be 1" }, "pinLockedOut" : { "type" : "boolean", "description" : "Marks whether the pin on this sub voicemailbox has been locked out" }, "messageTranscriptionEnabled" : { "type" : "boolean", "description" : "Specifies whether voicemail messages will be transcribed to text after a voicemail message is left" }, "greetings" : { "type" : "object", "description" : "Map of voicemail box greetings", "additionalProperties" : { "originalRef" : "VoicemailMessageX", "$ref" : "#/definitions/VoicemailMessageX" } } } }, "VoicemailReferencedByX" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "id" : { "type" : "string" } } }, "PinChange" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "voicemailBoxId" : { "type" : "string" }, "referenceId" : { "type" : "string" }, "referenceType" : { "type" : "string" }, "pin" : { "type" : "string" } } }, "Calling Plan Product" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Not required for POST operation" }, "name" : { "type" : "string" }, "planMinutes" : { "type" : "integer", "format" : "int32" }, "unlimitedDisplay" : { "type" : "boolean" }, "allowOverage" : { "type" : "boolean" }, "preventForwarding" : { "type" : "boolean" }, "defaultPlan" : { "type" : "boolean" }, "callRateFor411" : { "type" : "number", "format" : "double" }, "allow411" : { "type" : "boolean" }, "rateTypeFor411" : { "type" : "string", "enum" : [ "PER_CALL", "PER_MINUTE" ] }, "callRateForOperator" : { "type" : "number", "format" : "double" }, "allowOperator" : { "type" : "boolean" }, "rateTypeForOperator" : { "type" : "string", "enum" : [ "PER_CALL", "PER_MINUTE" ] }, "partitionId" : { "type" : "string" }, "allowUnlimitedLocal" : { "type" : "boolean" }, "rateIntraPartitionAsFree" : { "type" : "boolean" } } }, "LanguageReferenceX" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "country" : { "type" : "string" }, "language" : { "type" : "string" } } }, "PermissionTypeDefaultsX" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "NONE", "Account", "AccountHistory", "AccountCallHistory", "AccountBulkStatuses", "IpWhitelist", "PhoneNumber", "PhoneNumberServiceActivation", "PhoneNumberInventory", "Product", "ProductCallingPlan", "ProductGroups", "ProductUsers", "Reports", "RoutePlan", "SipCredentials", "EU_DeviceSwapCreate", "EU_Account", "EU_AccountMedia", "EU_CallHistory", "EU_Device", "EU_DeviceSwap", "EU_DeviceLine", "EU_IVR", "EU_LineAppearance", "EU_LineHardware", "EU_LineHuntGroup", "EU_Voicemail", "EU_VoicemailMessage", "EU_VoicemailUnlock", "EU_Telephone", "EU_SipTrunk", "EU_User", "EU_UserResetPassword", "EU_History", "EU_BUSINESS_LINE", "EU_BUSINESS_LINE_PROVISIONING", "EU_BUSINESS_LINE_VOICEMAIL", "EU_BUSINESS_LINE_HUNT_GROUP", "EU_911_ADDRESS", "EU_TELEPHONE_DESTINATION", "EU_ENDUSER_REPURPOSE", "ALIANZA_MasterRoutePlan", "ALIANZA_TogglzAdmin", "ANY_END_USER", "ANY_MANAGEMENT_USER", "ANY_ALIANZA_USER" ] }, "maxAccessType" : { "type" : "string", "enum" : [ "NONE", "READ_MYUSER", "READ", "EDIT_MYUSER", "EDIT", "CREATE_MYUSER", "CREATE", "DELETE_MYUSER", "DELETE", "DENIED" ] } } }, "SystemDefaultMediaX" : { "type" : "object", "properties" : { "storageId" : { "type" : "string" }, "subType" : { "type" : "string" }, "title" : { "type" : "string" }, "url" : { "type" : "string" } } } } }